class_inputeventwithmodifiers.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InputEventWithModifiers.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InputEventWithModifiers:
  5. InputEventWithModifiers
  6. =======================
  7. **Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Inherited By:** :ref:`InputEventGesture<class_InputEventGesture>`, :ref:`InputEventKey<class_InputEventKey>`, :ref:`InputEventMouse<class_InputEventMouse>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for keys events with modifiers.
  13. Properties
  14. ----------
  15. +-------------------------+-------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`alt<class_InputEventWithModifiers_alt>` |
  17. +-------------------------+-------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`command<class_InputEventWithModifiers_command>` |
  19. +-------------------------+-------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`control<class_InputEventWithModifiers_control>` |
  21. +-------------------------+-------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`meta<class_InputEventWithModifiers_meta>` |
  23. +-------------------------+-------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`shift<class_InputEventWithModifiers_shift>` |
  25. +-------------------------+-------------------------------------------------------+
  26. Description
  27. -----------
  28. Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input<class_Node__input>`.
  29. Tutorials
  30. ---------
  31. - :doc:`../tutorials/inputs/inputevent`
  32. Property Descriptions
  33. ---------------------
  34. .. _class_InputEventWithModifiers_alt:
  35. - :ref:`bool<class_bool>` **alt**
  36. +----------+----------------+
  37. | *Setter* | set_alt(value) |
  38. +----------+----------------+
  39. | *Getter* | get_alt() |
  40. +----------+----------------+
  41. State of the Alt modifier.
  42. .. _class_InputEventWithModifiers_command:
  43. - :ref:`bool<class_bool>` **command**
  44. +----------+--------------------+
  45. | *Setter* | set_command(value) |
  46. +----------+--------------------+
  47. | *Getter* | get_command() |
  48. +----------+--------------------+
  49. State of the Command modifier.
  50. .. _class_InputEventWithModifiers_control:
  51. - :ref:`bool<class_bool>` **control**
  52. +----------+--------------------+
  53. | *Setter* | set_control(value) |
  54. +----------+--------------------+
  55. | *Getter* | get_control() |
  56. +----------+--------------------+
  57. State of the Ctrl modifier.
  58. .. _class_InputEventWithModifiers_meta:
  59. - :ref:`bool<class_bool>` **meta**
  60. +----------+--------------------+
  61. | *Setter* | set_metakey(value) |
  62. +----------+--------------------+
  63. | *Getter* | get_metakey() |
  64. +----------+--------------------+
  65. State of the Meta modifier.
  66. .. _class_InputEventWithModifiers_shift:
  67. - :ref:`bool<class_bool>` **shift**
  68. +----------+------------------+
  69. | *Setter* | set_shift(value) |
  70. +----------+------------------+
  71. | *Getter* | get_shift() |
  72. +----------+------------------+
  73. State of the Shift modifier.