Files
godot-docs/classes/class_inputeventwithmodifiers.rst
2019-01-07 10:14:12 +01:00

109 lines
3.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the InputEventWithModifiers.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_InputEventWithModifiers:
InputEventWithModifiers
=======================
**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`InputEventGesture<class_InputEventGesture>`, :ref:`InputEventKey<class_InputEventKey>`, :ref:`InputEventMouse<class_InputEventMouse>`
**Category:** Core
Brief Description
-----------------
Base class for keys events with modifiers.
Properties
----------
+-------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`alt<class_InputEventWithModifiers_property_alt>` |
+-------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`command<class_InputEventWithModifiers_property_command>` |
+-------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`control<class_InputEventWithModifiers_property_control>` |
+-------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`meta<class_InputEventWithModifiers_property_meta>` |
+-------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shift<class_InputEventWithModifiers_property_shift>` |
+-------------------------+----------------------------------------------------------------+
Description
-----------
Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input<class_Node_method__input>`.
Tutorials
---------
- :doc:`../tutorials/inputs/inputevent`
Property Descriptions
---------------------
.. _class_InputEventWithModifiers_property_alt:
- :ref:`bool<class_bool>` **alt**
+----------+----------------+
| *Setter* | set_alt(value) |
+----------+----------------+
| *Getter* | get_alt() |
+----------+----------------+
State of the Alt modifier.
.. _class_InputEventWithModifiers_property_command:
- :ref:`bool<class_bool>` **command**
+----------+--------------------+
| *Setter* | set_command(value) |
+----------+--------------------+
| *Getter* | get_command() |
+----------+--------------------+
State of the Command modifier.
.. _class_InputEventWithModifiers_property_control:
- :ref:`bool<class_bool>` **control**
+----------+--------------------+
| *Setter* | set_control(value) |
+----------+--------------------+
| *Getter* | get_control() |
+----------+--------------------+
State of the Ctrl modifier.
.. _class_InputEventWithModifiers_property_meta:
- :ref:`bool<class_bool>` **meta**
+----------+--------------------+
| *Setter* | set_metakey(value) |
+----------+--------------------+
| *Getter* | get_metakey() |
+----------+--------------------+
State of the Meta modifier.
.. _class_InputEventWithModifiers_property_shift:
- :ref:`bool<class_bool>` **shift**
+----------+------------------+
| *Setter* | set_shift(value) |
+----------+------------------+
| *Getter* | get_shift() |
+----------+------------------+
State of the Shift modifier.