Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.1
Branches Tags
godot-docs
/
classes
/
class_inputmap.rst

class_inputmap.rst 8.6 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the InputMap.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_InputMap:
    8. 

  8. 

  9. InputMap
    10. 

  10. ========
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Singleton that manages :ref:`InputEventAction<class_InputEventAction>`.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                      | :ref:`action_add_event<class_InputMap_method_action_add_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**     |
    26. 

  26. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                      | :ref:`action_erase_event<class_InputMap_method_action_erase_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
    28. 

  28. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | void                      | :ref:`action_erase_events<class_InputMap_method_action_erase_events>` **(** :ref:`String<class_String>` action **)**                                          |
    30. 

  30. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`bool<class_bool>`   | :ref:`action_has_event<class_InputMap_method_action_has_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**     |
    32. 

  32. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | void                      | :ref:`action_set_deadzone<class_InputMap_method_action_set_deadzone>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)**      |
    34. 

  34. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | void                      | :ref:`add_action<class_InputMap_method_add_action>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)**                    |
    36. 

  36. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | void                      | :ref:`erase_action<class_InputMap_method_erase_action>` **(** :ref:`String<class_String>` action **)**                                                        |
    38. 

  38. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :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 |
    40. 

  40. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_method_get_action_list>` **(** :ref:`String<class_String>` action **)**                                                  |
    42. 

  42. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_method_get_actions>` **(** **)**                                                                                             |
    44. 

  44. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`bool<class_bool>`   | :ref:`has_action<class_InputMap_method_has_action>` **(** :ref:`String<class_String>` action **)** const                                                      |
    46. 

  46. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                      | :ref:`load_from_globals<class_InputMap_method_load_from_globals>` **(** **)**                                                                                 |
    48. 

  48. +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. 

  50. Description
    51. 

  51. -----------
    52. 

  52. 

  53. 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_method_add_action>` and :ref:`action_add_event<class_InputMap_method_action_add_event>`. See :ref:`Node._input<class_Node_method__input>`.
    54. 

  54. 

  55. Tutorials
    56. 

  56. ---------
    57. 

  57. 

  58. - `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent`
    59. 

  59. 

  60. Method Descriptions
    61. 

  61. -------------------
    62. 

  62. 

  63. .. _class_InputMap_method_action_add_event:
    64. 

  64. 

  65. - void **action_add_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
    66. 

  66. 

  67. Adds an :ref:`InputEvent<class_InputEvent>` to an action. This :ref:`InputEvent<class_InputEvent>` will trigger the action.
    68. 

  68. 

  69. ----
    70. 

  70. 

  71. .. _class_InputMap_method_action_erase_event:
    72. 

  72. 

  73. - void **action_erase_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
    74. 

  74. 

  75. Removes an :ref:`InputEvent<class_InputEvent>` from an action.
    76. 

  76. 

  77. ----
    78. 

  78. 

  79. .. _class_InputMap_method_action_erase_events:
    80. 

  80. 

  81. - void **action_erase_events** **(** :ref:`String<class_String>` action **)**
    82. 

  82. 

  83. Removes all events from an action.
    84. 

  84. 

  85. ----
    86. 

  86. 

  87. .. _class_InputMap_method_action_has_event:
    88. 

  88. 

  89. - :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)**
    90. 

  90. 

  91. Returns ``true`` if the action has the given :ref:`InputEvent<class_InputEvent>` associated with it.
    92. 

  92. 

  93. ----
    94. 

  94. 

  95. .. _class_InputMap_method_action_set_deadzone:
    96. 

  96. 

  97. - void **action_set_deadzone** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)**
    98. 

  98. 

  99. ----
    100. 

  100. 

  101. .. _class_InputMap_method_add_action:
    102. 

  102. 

  103. - void **add_action** **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)**
    104. 

  104. 

  105. Adds an empty action to the ``InputMap`` with a configurable ``deadzone``.
    106. 

  106. 

  107. An :ref:`InputEvent<class_InputEvent>` can then be added to this action with :ref:`action_add_event<class_InputMap_method_action_add_event>`.
    108. 

  108. 

  109. ----
    110. 

  110. 

  111. .. _class_InputMap_method_erase_action:
    112. 

  112. 

  113. - void **erase_action** **(** :ref:`String<class_String>` action **)**
    114. 

  114. 

  115. Removes an action from the ``InputMap``.
    116. 

  116. 

  117. ----
    118. 

  118. 

  119. .. _class_InputMap_method_event_is_action:
    120. 

  120. 

  121. - :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** const
    122. 

  122. 

  123. 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.
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_InputMap_method_get_action_list:
    128. 

  128. 

  129. - :ref:`Array<class_Array>` **get_action_list** **(** :ref:`String<class_String>` action **)**
    130. 

  130. 

  131. Returns an array of :ref:`InputEvent<class_InputEvent>`\ s associated with a given action.
    132. 

  132. 

  133. ----
    134. 

  134. 

  135. .. _class_InputMap_method_get_actions:
    136. 

  136. 

  137. - :ref:`Array<class_Array>` **get_actions** **(** **)**
    138. 

  138. 

  139. Returns an array of all actions in the ``InputMap``.
    140. 

  140. 

  141. ----
    142. 

  142. 

  143. .. _class_InputMap_method_has_action:
    144. 

  144. 

  145. - :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_String>` action **)** const
    146. 

  146. 

  147. Returns ``true`` if the ``InputMap`` has a registered action with the given name.
    148. 

  148. 

  149. ----
    150. 

  150. 

  151. .. _class_InputMap_method_load_from_globals:
    152. 

  152. 

  153. - void **load_from_globals** **(** **)**
    154. 

  154. 

  155. Clears all :ref:`InputEventAction<class_InputEventAction>` in the ``InputMap`` and load it anew from :ref:`ProjectSettings<class_ProjectSettings>`.
    156. 

  156.