diff options
Diffstat (limited to 'doc/classes/InputMap.xml')
| -rw-r--r-- | doc/classes/InputMap.xml | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index bf72ba05e7..99b77dab36 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputMap" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Singleton that manages actions. + Singleton that manages [InputEventAction]. </brief_description> <description> + 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]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap </tutorials> <demos> </demos> @@ -18,7 +20,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Add an [InputEvent] to an action. This [InputEvent] will trigger the action. + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> @@ -29,7 +31,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Remove an [InputEvent] from an action. + Removes an [InputEvent] from an action. </description> </method> <method name="action_has_event"> @@ -40,7 +42,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Whether an action has an [InputEvent] associated with it. + Returns [true] if an action has an [InputEvent] associated with it. </description> </method> <method name="add_action"> @@ -49,7 +51,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. + Adds an (empty) action to the [code]InputMap[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> <method name="erase_action"> @@ -58,7 +60,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Remove an action from the [InputMap]. + Removes an action from the [code]InputMap[/code]. </description> </method> <method name="event_is_action" qualifiers="const"> @@ -69,7 +71,7 @@ <argument index="1" name="action" type="String"> </argument> <description> - Return whether 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. + 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. </description> </method> <method name="get_action_list"> @@ -78,14 +80,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return an array of InputEvents associated with a given action. + Returns an array of [InputEvent]s associated with a given action. </description> </method> <method name="get_actions"> <return type="Array"> </return> <description> - Return an array of all actions in the [InputMap]. + Returns an array of all actions in the [code]InputMap[/code]. </description> </method> <method name="has_action" qualifiers="const"> @@ -94,14 +96,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Whether this InputMap has a registered action with the given name. + Returns [code]true[/code] if the [code]InputMap[/code] has a registered action with the given name. </description> </method> <method name="load_from_globals"> <return type="void"> </return> <description> - Clear the [InputMap] and load it anew from [ProjectSettings]. + Clears all [InputEventAction] in the [code]InputMap[/code] and load it anew from [ProjectSettings]. </description> </method> </methods> |