class_inputeventshortcut.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventShortcut.xml.
  6. .. _class_InputEventShortcut:
  7. InputEventShortcut
  8. ==================
  9. **Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Represents a triggered keyboard :ref:`Shortcut<class_Shortcut>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. InputEventShortcut is a special event that can be received in :ref:`Node._unhandled_key_input<class_Node_private_method__unhandled_key_input>`. It is typically sent by the editor's Command Palette to trigger actions, but can also be sent manually using :ref:`Viewport.push_input<class_Viewport_method_push_input>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------------+-------------------------------------------------------------+
  21. | :ref:`Shortcut<class_Shortcut>` | :ref:`shortcut<class_InputEventShortcut_property_shortcut>` |
  22. +---------------------------------+-------------------------------------------------------------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Property Descriptions
  27. ---------------------
  28. .. _class_InputEventShortcut_property_shortcut:
  29. .. rst-class:: classref-property
  30. :ref:`Shortcut<class_Shortcut>` **shortcut**
  31. .. rst-class:: classref-property-setget
  32. - void **set_shortcut** **(** :ref:`Shortcut<class_Shortcut>` value **)**
  33. - :ref:`Shortcut<class_Shortcut>` **get_shortcut** **(** **)**
  34. The :ref:`Shortcut<class_Shortcut>` represented by this event. Its :ref:`Shortcut.matches_event<class_Shortcut_method_matches_event>` method will always return ``true`` for this event.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  41. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`