Skip to content

Latest commit

 

History

History
125 lines (76 loc) · 4.86 KB

class_shortcut.rst

File metadata and controls

125 lines (76 loc) · 4.86 KB
github_url:hide

Shortcut

Inherits: :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`

A shortcut for binding input.

.. rst-class:: classref-introduction-group

Description

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

Properties

:ref:`Array<class_Array>` :ref:`events<class_Shortcut_property_events>` []
.. rst-class:: classref-reftable-group

Methods

:ref:`String<class_String>` :ref:`get_as_text<class_Shortcut_method_get_as_text>` ( ) |const|
:ref:`bool<class_bool>` :ref:`has_valid_event<class_Shortcut_method_has_valid_event>` ( ) |const|
:ref:`bool<class_bool>` :ref:`matches_event<class_Shortcut_method_matches_event>` ( :ref:`InputEvent<class_InputEvent>` event ) |const|
.. rst-class:: classref-section-separator


.. rst-class:: classref-descriptions-group

Property Descriptions

.. rst-class:: classref-property

:ref:`Array<class_Array>` events = []

.. rst-class:: classref-property-setget

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

Method Descriptions

.. rst-class:: classref-method

:ref:`String<class_String>` get_as_text ( ) |const|

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|

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 ( :ref:`InputEvent<class_InputEvent>` event ) |const|

Returns whether any :ref:`InputEvent<class_InputEvent>` in :ref:`events<class_Shortcut_property_events>` equals event.