mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
68 lines
2.5 KiB
ReStructuredText
68 lines
2.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.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:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A shortcut for binding input.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_as_text<class_ShortCut_get_as_text>` **(** **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_shortcut<class_ShortCut_is_shortcut>` **(** :ref:`InputEvent<class_InputEvent>` event **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_valid<class_ShortCut_is_valid>` **(** **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
A shortcut for binding input.
|
|
|
|
Shortcuts are commonly used for interacting with a :ref:`Control<class_Control>` element from a :ref:`InputEvent<class_InputEvent>`.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ShortCut_shortcut:
|
|
|
|
- :ref:`InputEvent<class_InputEvent>` **shortcut** - The Shortcut's :ref:`InputEvent<class_InputEvent>`.
|
|
|
|
Generally the :ref:`InputEvent<class_InputEvent>` is a keyboard key, though it can be any :ref:`InputEvent<class_InputEvent>`.
|
|
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ShortCut_get_as_text:
|
|
|
|
- :ref:`String<class_String>` **get_as_text** **(** **)** const
|
|
|
|
Returns the Shortcut's :ref:`InputEvent<class_InputEvent>` as a :ref:`String<class_String>`.
|
|
|
|
.. _class_ShortCut_is_shortcut:
|
|
|
|
- :ref:`bool<class_bool>` **is_shortcut** **(** :ref:`InputEvent<class_InputEvent>` event **)** const
|
|
|
|
Returns ``true`` if the Shortcut's :ref:`InputEvent<class_InputEvent>` equals ``event``.
|
|
|
|
.. _class_ShortCut_is_valid:
|
|
|
|
- :ref:`bool<class_bool>` **is_valid** **(** **)** const
|
|
|
|
If ``true`` this Shortcut is valid.
|
|
|
|
|