godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Fix links case and sync headers with editor

Browse Source 
Output from godotengine/godot#22002.
This commit is contained in:
Rémi Verschelde
2018-09-13 01:56:41 +02:00
parent 942b6d3ac1
commit f9caa4be29
579 changed files with 16363 additions and 16329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
classes/class_inputmap.rst
View File

@@ -7,40 +7,39 @@
InputMap
========
**Inherits:** :ref:`Object<class_object>`
**Inherits:** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Singleton that manages :ref:`InputEventAction<class_inputeventaction>`.
Singleton that manages :ref:`InputEventAction<class_InputEventAction>`.
Member Functions
----------------
Methods
-------
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_action_erase_events>` **(** :ref:`String<class_string>` action **)** |
| void | :ref:`action_erase_events<class_InputMap_action_erase_events>` **(** :ref:`String<class_String>` action **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_set_deadzone<class_InputMap_action_set_deadzone>` **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone **)** |
| void | :ref:`action_set_deadzone<class_InputMap_action_set_deadzone>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_String>` action **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
| :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_String>` action **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
| :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_String>` action **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -48,79 +47,79 @@ Member Functions
Description
-----------
Manages all :ref:`InputEventAction<class_inputeventaction>` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action<class_InputMap_add_action>` and :ref:`action_add_event<class_InputMap_action_add_event>`. See :ref:`Node._input<class_Node__input>`.
Manages all :ref:`InputEventAction<class_InputEventAction>` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action<class_InputMap_add_action>` and :ref:`action_add_event<class_InputMap_action_add_event>`. See :ref:`Node._input<class_Node__input>`.
Tutorials
---------
- `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent`
Member Function Description
---------------------------
Method Descriptions
-------------------
.. _class_InputMap_action_add_event:
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` 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.
Adds an :ref:`InputEvent<class_InputEvent>` to an action. This :ref:`InputEvent<class_InputEvent>` will trigger the action.
.. _class_InputMap_action_erase_event:
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
- void **action_erase_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Removes an :ref:`InputEvent<class_inputevent>` from an action.
Removes an :ref:`InputEvent<class_InputEvent>` from an action.
.. _class_InputMap_action_erase_events:
- void **action_erase_events** **(** :ref:`String<class_string>` action **)**
- void **action_erase_events** **(** :ref:`String<class_String>` action **)**
Removes all events from an action.
.. _class_InputMap_action_has_event:
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` 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.
Returns ``true`` if the action has the given :ref:`InputEvent<class_InputEvent>` associated with it.
.. _class_InputMap_action_set_deadzone:
- void **action_set_deadzone** **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone **)**
- void **action_set_deadzone** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)**
.. _class_InputMap_add_action:
- void **add_action** **(** :ref:`String<class_string>` action, :ref:`float<class_float>` deadzone=0.5 **)**
- void **add_action** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)**
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>`.
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:
- void **erase_action** **(** :ref:`String<class_string>` action **)**
- void **erase_action** **(** :ref:`String<class_String>` action **)**
Removes an action from the ``InputMap``.
.. _class_InputMap_event_is_action:
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
- :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.
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:
- :ref:`Array<class_array>` **get_action_list** **(** :ref:`String<class_string>` action **)**
- :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.
Returns an array of :ref:`InputEvent<class_InputEvent>`\ s associated with a given action.
.. _class_InputMap_get_actions:
- :ref:`Array<class_array>` **get_actions** **(** **)**
- :ref:`Array<class_Array>` **get_actions** **(** **)**
Returns an array of all actions in the ``InputMap``.
.. _class_InputMap_has_action:
- :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_string>` action **)** const
- :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.
@@ -128,6 +127,6 @@ Returns ``true`` if the ``InputMap`` has a registered action with the given name
- void **load_from_globals** **(** **)**
Clears all :ref:`InputEventAction<class_inputeventaction>` in the ``InputMap`` and load it anew from :ref:`ProjectSettings<class_projectsettings>`.
Clears all :ref:`InputEventAction<class_InputEventAction>` in the ``InputMap`` and load it anew from :ref:`ProjectSettings<class_ProjectSettings>`.