2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 12:40:43 +00:00
<class name= "InputMap" inherits= "Object" category= "Core" version= "3.1" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-10-15 22:07:13 +00:00
Singleton that manages [InputEventAction].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-11-18 00:29:32 +00:00
Manages all [InputEventAction] which can be created/modified from the project settings menu [code]Project > Project Settings > Input Map[/code] or in code with [method add_action] and [method action_add_event]. See [method Node._input].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2018-11-05 07:46:27 +00:00
<link > https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#inputmap</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<demos >
</demos>
<methods >
<method name= "action_add_event" >
<return type= "void" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<argument index= "1" name= "event" type= "InputEvent" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Adds an [InputEvent] to an action. This [InputEvent] will trigger the action.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "action_erase_event" >
<return type= "void" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<argument index= "1" name= "event" type= "InputEvent" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Removes an [InputEvent] from an action.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "action_erase_events" >
<return type= "void" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<description >
2018-08-19 04:29:12 +00:00
Removes all events from an action.
2018-05-12 07:38:00 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "action_has_event" >
<return type= "bool" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<argument index= "1" name= "event" type= "InputEvent" >
</argument>
<description >
2018-08-19 04:29:12 +00:00
Returns [code]true[/code] if the action has the given [InputEvent] associated with it.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "action_set_deadzone" >
<return type= "void" >
</return>
2018-08-20 22:35:30 +00:00
<argument index= "0" name= "action" type= "String" >
2018-05-12 07:38:00 +00:00
</argument>
2018-08-20 22:35:30 +00:00
<argument index= "1" name= "deadzone" type= "float" >
2018-05-12 07:38:00 +00:00
</argument>
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "add_action" >
<return type= "void" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
2018-05-12 07:38:00 +00:00
<argument index= "1" name= "deadzone" type= "float" default= "0.5" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2018-08-19 04:29:12 +00:00
Adds an empty action to the [code]InputMap[/code] with a configurable [code]deadzone[/code].
2018-05-12 07:38:00 +00:00
An [InputEvent] can then be added to this action with [method action_add_event].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "erase_action" >
<return type= "void" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Removes an action from the [code]InputMap[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "event_is_action" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "event" type= "InputEvent" >
</argument>
<argument index= "1" name= "action" type= "String" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Returns [true] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_action_list" >
<return type= "Array" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Returns an array of [InputEvent]s associated with a given action.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_actions" >
<return type= "Array" >
</return>
<description >
2017-10-15 22:07:13 +00:00
Returns an array of all actions in the [code]InputMap[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "has_action" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<description >
2017-10-15 22:07:13 +00:00
Returns [code]true[/code] if the [code]InputMap[/code] has a registered action with the given name.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "load_from_globals" >
<return type= "void" >
</return>
<description >
2017-10-15 22:07:13 +00:00
Clears all [InputEventAction] in the [code]InputMap[/code] and load it anew from [ProjectSettings].
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>