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 master branch (4.0 changes)

Browse Source
This commit is contained in:
Rémi Verschelde
2020-03-13 17:17:50 +01:00
parent 966fd002ed
commit 03d40ff29e
360 changed files with 17483 additions and 16479 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
classes/class_inputmap.rst
View File

@@ -26,38 +26,38 @@ Tutorials
Methods
-------
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_method_action_add_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_method_action_erase_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_method_action_erase_events>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_method_action_has_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_set_deadzone<class_InputMap_method_action_set_deadzone>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_method_add_action>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_method_erase_action>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_method_event_is_action>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_method_get_action_list>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_method_get_actions>` **(** **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_method_has_action>` **(** :ref:`String<class_String>` action **)** const |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_method_load_from_globals>` **(** **)** |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_method_action_add_event>` **(** :ref:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_method_action_erase_event>` **(** :ref:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_method_action_erase_events>` **(** :ref:`StringName<class_StringName>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_method_action_has_event>` **(** :ref:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_set_deadzone<class_InputMap_method_action_set_deadzone>` **(** :ref:`StringName<class_StringName>` action, :ref:`float<class_float>` deadzone **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_method_add_action>` **(** :ref:`StringName<class_StringName>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_method_erase_action>` **(** :ref:`StringName<class_StringName>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_method_event_is_action>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`StringName<class_StringName>` action **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_method_get_action_list>` **(** :ref:`StringName<class_StringName>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_method_get_actions>` **(** **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_method_has_action>` **(** :ref:`StringName<class_StringName>` action **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_method_load_from_globals>` **(** **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_InputMap_method_action_add_event:
- void **action_add_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
- void **action_add_event** **(** :ref:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Adds an :ref:`InputEvent<class_InputEvent>` to an action. This :ref:`InputEvent<class_InputEvent>` will trigger the action.
@@ -65,7 +65,7 @@ Adds an :ref:`InputEvent<class_InputEvent>` to an action. This :ref:`InputEvent<
.. _class_InputMap_method_action_erase_event:
- void **action_erase_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
- void **action_erase_event** **(** :ref:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Removes an :ref:`InputEvent<class_InputEvent>` from an action.
@@ -73,7 +73,7 @@ Removes an :ref:`InputEvent<class_InputEvent>` from an action.
.. _class_InputMap_method_action_erase_events:
- void **action_erase_events** **(** :ref:`String<class_String>` action **)**
- void **action_erase_events** **(** :ref:`StringName<class_StringName>` action **)**
Removes all events from an action.
@@ -81,7 +81,7 @@ Removes all events from an action.
.. _class_InputMap_method_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:`StringName<class_StringName>` action, :ref:`InputEvent<class_InputEvent>` event **)**
Returns ``true`` if the action has the given :ref:`InputEvent<class_InputEvent>` associated with it.
@@ -89,7 +89,7 @@ Returns ``true`` if the action has the given :ref:`InputEvent<class_InputEvent>`
.. _class_InputMap_method_action_set_deadzone:
- void **action_set_deadzone** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)**
- void **action_set_deadzone** **(** :ref:`StringName<class_StringName>` action, :ref:`float<class_float>` deadzone **)**
Sets a deadzone value for the action.
@@ -97,7 +97,7 @@ Sets a deadzone value for the action.
.. _class_InputMap_method_add_action:
- void **add_action** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)**
- void **add_action** **(** :ref:`StringName<class_StringName>` action, :ref:`float<class_float>` deadzone=0.5 **)**
Adds an empty action to the ``InputMap`` with a configurable ``deadzone``.
@@ -107,7 +107,7 @@ An :ref:`InputEvent<class_InputEvent>` can then be added to this action with :re
.. _class_InputMap_method_erase_action:
- void **erase_action** **(** :ref:`String<class_String>` action **)**
- void **erase_action** **(** :ref:`StringName<class_StringName>` action **)**
Removes an action from the ``InputMap``.
@@ -115,7 +115,7 @@ Removes an action from the ``InputMap``.
.. _class_InputMap_method_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:`StringName<class_StringName>` 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_method_action_has_event>` if you don't want this behavior.
@@ -123,7 +123,7 @@ Returns ``true`` if the given event is part of an existing action. This method i
.. _class_InputMap_method_get_action_list:
- :ref:`Array<class_Array>` **get_action_list** **(** :ref:`String<class_String>` action **)**
- :ref:`Array<class_Array>` **get_action_list** **(** :ref:`StringName<class_StringName>` action **)**
Returns an array of :ref:`InputEvent<class_InputEvent>`\ s associated with a given action.
@@ -139,7 +139,7 @@ Returns an array of all actions in the ``InputMap``.
.. _class_InputMap_method_has_action:
- :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_String>` action **)** const
- :ref:`bool<class_bool>` **has_action** **(** :ref:`StringName<class_StringName>` action **)** const
Returns ``true`` if the ``InputMap`` has a registered action with the given name.