| github_url: | hide |
|---|
Inherits: :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`
A shortcut for binding input.
.. rst-class:: classref-introduction-group
Shortcuts are commonly used for interacting with a :ref:`Control<class_Control>` element from an :ref:`InputEvent<class_InputEvent>` (also known as hotkeys).
One shortcut can contain multiple :ref:`InputEvent<class_InputEvent>`'s, allowing the possibility of triggering one action with multiple different inputs.
.. rst-class:: classref-reftable-group
| :ref:`Array<class_Array>` | :ref:`events<class_Shortcut_property_events>` | [] |
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
:ref:`Array<class_Array>` events = [] :ref:`🔗<class_Shortcut_property_events>`
.. rst-class:: classref-property-setget
- |void| set_events(value: :ref:`Array<class_Array>`)
- :ref:`Array<class_Array>` get_events()
The shortcut's :ref:`InputEvent<class_InputEvent>` array.
Generally the :ref:`InputEvent<class_InputEvent>` used is an :ref:`InputEventKey<class_InputEventKey>`, though it can be any :ref:`InputEvent<class_InputEvent>`, including an :ref:`InputEventAction<class_InputEventAction>`.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
:ref:`String<class_String>` get_as_text() |const| :ref:`🔗<class_Shortcut_method_get_as_text>`
Returns the shortcut's first valid :ref:`InputEvent<class_InputEvent>` as a :ref:`String<class_String>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` has_valid_event() |const| :ref:`🔗<class_Shortcut_method_has_valid_event>`
Returns whether :ref:`events<class_Shortcut_property_events>` contains an :ref:`InputEvent<class_InputEvent>` which is valid.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` matches_event(event: :ref:`InputEvent<class_InputEvent>`) |const| :ref:`🔗<class_Shortcut_method_matches_event>`
Returns whether any :ref:`InputEvent<class_InputEvent>` in :ref:`events<class_Shortcut_property_events>` equals event. This uses :ref:`InputEvent.is_match<class_InputEvent_method_is_match>` to compare events.