diff options
Diffstat (limited to 'doc/classes/InputMap.xml')
| -rw-r--r-- | doc/classes/InputMap.xml | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index eb708432b4..1d7d54f681 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -12,37 +12,37 @@ <methods> <method name="action_add_event"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Removes an [InputEvent] from an action. </description> </method> <method name="action_erase_events"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Removes all events from an action. </description> </method> <method name="action_get_deadzone"> <return type="float" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Returns a deadzone value for the action. </description> </method> <method name="action_get_events"> - <return type="Array" /> - <argument index="0" name="action" type="StringName" /> + <return type="InputEvent[]" /> + <param index="0" name="action" type="StringName" /> <description> Returns an array of [InputEvent]s associated with a given action. [b]Note:[/b] When used in the editor (e.g. a tool script or [EditorPlugin]), this method will return events for the editor action. If you want to access your project's input binds from the editor, read the [code]input/*[/code] settings from [ProjectSettings]. @@ -50,55 +50,55 @@ </method> <method name="action_has_event"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="event" type="InputEvent" /> <description> Returns [code]true[/code] if the action has the given [InputEvent] associated with it. </description> </method> <method name="action_set_deadzone"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="deadzone" type="float" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="deadzone" type="float" /> <description> Sets a deadzone value for the action. </description> </method> <method name="add_action"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> - <argument index="1" name="deadzone" type="float" default="0.5" /> + <param index="0" name="action" type="StringName" /> + <param index="1" name="deadzone" type="float" default="0.5" /> <description> - Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code]. + Adds an empty action to the [InputMap] with a configurable [param deadzone]. An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> <method name="erase_action"> <return type="void" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Removes an action from the [InputMap]. </description> </method> <method name="event_is_action" qualifiers="const"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> - <argument index="1" name="action" type="StringName" /> - <argument index="2" name="exact_match" type="bool" default="false" /> + <param index="0" name="event" type="InputEvent" /> + <param index="1" name="action" type="StringName" /> + <param index="2" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] 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. - If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="get_actions"> - <return type="Array" /> + <return type="StringName[]" /> <description> Returns an array of all actions in the [InputMap]. </description> </method> <method name="has_action" qualifiers="const"> <return type="bool" /> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Returns [code]true[/code] if the [InputMap] has a registered action with the given name. </description> |