class_inputmap.rst 6.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_InputMap:
  4. InputMap
  5. ========
  6. **Inherits:** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Singleton that manages actions.
  11. Member Functions
  12. ----------------
  13. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
  15. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_action_id<class_InputMap_get_action_id>` **(** :ref:`String<class_string>` action **)** const |
  17. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_string>` | :ref:`get_action_from_id<class_InputMap_get_action_from_id>` **(** :ref:`int<class_int>` id **)** const |
  19. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
  21. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
  23. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
  25. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
  27. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
  29. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
  31. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
  33. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
  35. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. Description
  37. -----------
  38. Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified.
  39. Member Function Description
  40. ---------------------------
  41. .. _class_InputMap_has_action:
  42. - :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_string>` action **)** const
  43. .. _class_InputMap_get_action_id:
  44. - :ref:`int<class_int>` **get_action_id** **(** :ref:`String<class_string>` action **)** const
  45. .. _class_InputMap_get_action_from_id:
  46. - :ref:`String<class_string>` **get_action_from_id** **(** :ref:`int<class_int>` id **)** const
  47. .. _class_InputMap_add_action:
  48. - void **add_action** **(** :ref:`String<class_string>` action **)**
  49. .. _class_InputMap_erase_action:
  50. - void **erase_action** **(** :ref:`String<class_string>` action **)**
  51. .. _class_InputMap_action_add_event:
  52. - void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
  53. .. _class_InputMap_action_has_event:
  54. - :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
  55. .. _class_InputMap_action_erase_event:
  56. - void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
  57. .. _class_InputMap_get_action_list:
  58. - :ref:`Array<class_array>` **get_action_list** **(** :ref:`String<class_string>` action **)**
  59. .. _class_InputMap_event_is_action:
  60. - :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
  61. .. _class_InputMap_load_from_globals:
  62. - void **load_from_globals** **(** **)**