godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2018-09-21 09:49:38 +02:00
parent df6316f918
commit ce0bb7b277
494 changed files with 7138 additions and 7027 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
classes/class_inputmap.rst
View File

@@ -54,38 +54,39 @@ Tutorials
---------
- `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent`
Method Descriptions
-------------------
.. _class_InputMap_action_add_event:
.. _class_InputMap_action_add_event:
- void **action_add_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Adds an :ref:`InputEvent<class_InputEvent>` to an action. This :ref:`InputEvent<class_InputEvent>` will trigger the action.
.. _class_InputMap_action_erase_event:
.. _class_InputMap_action_erase_event:
- void **action_erase_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Removes an :ref:`InputEvent<class_InputEvent>` from an action.
.. _class_InputMap_action_erase_events:
.. _class_InputMap_action_erase_events:
- void **action_erase_events** **(** :ref:`String<class_String>` action **)**
Removes all events from an action.
.. _class_InputMap_action_has_event:
.. _class_InputMap_action_has_event:
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Returns ``true`` if the action has the given :ref:`InputEvent<class_InputEvent>` associated with it.
.. _class_InputMap_action_set_deadzone:
.. _class_InputMap_action_set_deadzone:
- void **action_set_deadzone** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)**
.. _class_InputMap_add_action:
.. _class_InputMap_add_action:
- void **add_action** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)**
@@ -93,37 +94,37 @@ Adds an empty action to the ``InputMap`` with a configurable ``deadzone``.
An :ref:`InputEvent<class_InputEvent>` can then be added to this action with :ref:`action_add_event<class_InputMap_action_add_event>`.
.. _class_InputMap_erase_action:
.. _class_InputMap_erase_action:
- void **erase_action** **(** :ref:`String<class_String>` action **)**
Removes an action from the ``InputMap``.
.. _class_InputMap_event_is_action:
.. _class_InputMap_event_is_action:
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** const
Returns true if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_InputEvent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
.. _class_InputMap_get_action_list:
.. _class_InputMap_get_action_list:
- :ref:`Array<class_Array>` **get_action_list** **(** :ref:`String<class_String>` action **)**
Returns an array of :ref:`InputEvent<class_InputEvent>`\ s associated with a given action.
.. _class_InputMap_get_actions:
.. _class_InputMap_get_actions:
- :ref:`Array<class_Array>` **get_actions** **(** **)**
Returns an array of all actions in the ``InputMap``.
.. _class_InputMap_has_action:
.. _class_InputMap_has_action:
- :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_String>` action **)** const
Returns ``true`` if the ``InputMap`` has a registered action with the given name.
.. _class_InputMap_load_from_globals:
.. _class_InputMap_load_from_globals:
- void **load_from_globals** **(** **)**