| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the Shortcut.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_Shortcut:
- Shortcut
- ========
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A shortcut for binding input.
- 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.
- Properties
- ----------
- +---------------------------+-----------------------------------------------+--------+
- | :ref:`Array<class_Array>` | :ref:`events<class_Shortcut_property_events>` | ``[]`` |
- +---------------------------+-----------------------------------------------+--------+
- 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| |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_Shortcut_property_events:
- - :ref:`Array<class_Array>` **events**
- +-----------+-------------------+
- | *Default* | ``[]`` |
- +-----------+-------------------+
- | *Setter* | set_events(value) |
- +-----------+-------------------+
- | *Getter* | 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>`.
- Method Descriptions
- -------------------
- .. _class_Shortcut_method_get_as_text:
- - :ref:`String<class_String>` **get_as_text** **(** **)** |const|
- Returns the shortcut's first valid :ref:`InputEvent<class_InputEvent>` as a :ref:`String<class_String>`.
- ----
- .. _class_Shortcut_method_has_valid_event:
- - :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.
- ----
- .. _class_Shortcut_method_matches_event:
- - :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``.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
