Files
godot-docs/classes/class_inputeventkey.rst
Rémi Verschelde fa00c829f0 Add inheritance path
Also fix parsing of [method (Class.)name]
2016-02-08 18:31:35 +01:00

86 lines
3.8 KiB
ReStructuredText

.. _class_InputEventKey:
InputEventKey
=============
**Category:** Built-In Types
Brief Description
-----------------
Member Functions
----------------
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventKey_is_action>` **(** :ref:`String<class_string>` action **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventKey_is_action_pressed>` **(** :ref:`String<class_string>` is_action_pressed **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventKey_is_action_released>` **(** :ref:`String<class_string>` is_action_released **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventKey_is_echo>` **(** **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventKey_is_pressed>` **(** **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_action<class_InputEventKey_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`bool<class_bool>` **shift**
- :ref:`bool<class_bool>` **alt**
- :ref:`bool<class_bool>` **control**
- :ref:`bool<class_bool>` **meta**
- :ref:`bool<class_bool>` **pressed**
- :ref:`bool<class_bool>` **echo**
- :ref:`int<class_int>` **scancode**
- :ref:`int<class_int>` **unicode**
Numeric Constants
-----------------
- **NONE** = **0**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------
.. _class_InputEventKey_is_action:
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
.. _class_InputEventKey_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` is_action_pressed **)**
.. _class_InputEventKey_is_action_released:
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` is_action_released **)**
.. _class_InputEventKey_is_echo:
- :ref:`bool<class_bool>` **is_echo** **(** **)**
.. _class_InputEventKey_is_pressed:
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
.. _class_InputEventKey_set_as_action:
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**