class_inputeventaction.rst 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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_InputEventAction:
  4. InputEventAction
  5. ================
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. Member Functions
  10. ----------------
  11. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  12. | :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventAction_is_action>` **(** :ref:`String<class_string>` action **)** |
  13. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventAction_is_action_pressed>` **(** :ref:`String<class_string>` is_action_pressed **)** |
  15. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventAction_is_action_released>` **(** :ref:`String<class_string>` is_action_released **)** |
  17. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventAction_is_echo>` **(** **)** |
  19. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventAction_is_pressed>` **(** **)** |
  21. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_as_action<class_InputEventAction_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
  23. +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
  24. Member Variables
  25. ----------------
  26. - :ref:`int<class_int>` **type**
  27. - :ref:`int<class_int>` **device**
  28. - :ref:`int<class_int>` **ID**
  29. Numeric Constants
  30. -----------------
  31. - **NONE** = **0**
  32. - **KEY** = **1**
  33. - **MOUSE_MOTION** = **2**
  34. - **MOUSE_BUTTON** = **3**
  35. - **JOYSTICK_MOTION** = **4**
  36. - **JOYSTICK_BUTTON** = **5**
  37. - **SCREEN_TOUCH** = **6**
  38. - **SCREEN_DRAG** = **7**
  39. - **ACTION** = **8**
  40. Member Function Description
  41. ---------------------------
  42. .. _class_InputEventAction_is_action:
  43. - :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
  44. .. _class_InputEventAction_is_action_pressed:
  45. - :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` is_action_pressed **)**
  46. .. _class_InputEventAction_is_action_released:
  47. - :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` is_action_released **)**
  48. .. _class_InputEventAction_is_echo:
  49. - :ref:`bool<class_bool>` **is_echo** **(** **)**
  50. .. _class_InputEventAction_is_pressed:
  51. - :ref:`bool<class_bool>` **is_pressed** **(** **)**
  52. .. _class_InputEventAction_set_as_action:
  53. - void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**