godot-docs/classes/class_inputeventwithmodifiers.rst

.. 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:`InputEventKey<class_inputeventkey>`, :ref:`InputEventMouse<class_inputeventmouse>`

**Category:** Core

Brief Description
-----------------

Base class for input events with modifiers.

Member Functions
----------------

+--------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`get_alt<class_InputEventWithModifiers_get_alt>`  **(** **)** const                                   |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`get_command<class_InputEventWithModifiers_get_command>`  **(** **)** const                           |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`get_control<class_InputEventWithModifiers_get_control>`  **(** **)** const                           |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`get_metakey<class_InputEventWithModifiers_get_metakey>`  **(** **)** const                           |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`get_shift<class_InputEventWithModifiers_get_shift>`  **(** **)** const                               |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`set_alt<class_InputEventWithModifiers_set_alt>`  **(** :ref:`bool<class_bool>` enable  **)**         |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`set_command<class_InputEventWithModifiers_set_command>`  **(** :ref:`bool<class_bool>` enable  **)** |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`set_control<class_InputEventWithModifiers_set_control>`  **(** :ref:`bool<class_bool>` enable  **)** |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`set_metakey<class_InputEventWithModifiers_set_metakey>`  **(** :ref:`bool<class_bool>` enable  **)** |
+--------------------------+------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`set_shift<class_InputEventWithModifiers_set_shift>`  **(** :ref:`bool<class_bool>` enable  **)**     |
+--------------------------+------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
- :ref:`bool<class_bool>` **command** - State of the Command modifier.
- :ref:`bool<class_bool>` **control** - State of the Ctrl modifier.
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.

Member Function Description
---------------------------

.. _class_InputEventWithModifiers_get_alt:

- :ref:`bool<class_bool>`  **get_alt**  **(** **)** const

.. _class_InputEventWithModifiers_get_command:

- :ref:`bool<class_bool>`  **get_command**  **(** **)** const

.. _class_InputEventWithModifiers_get_control:

- :ref:`bool<class_bool>`  **get_control**  **(** **)** const

.. _class_InputEventWithModifiers_get_metakey:

- :ref:`bool<class_bool>`  **get_metakey**  **(** **)** const

.. _class_InputEventWithModifiers_get_shift:

- :ref:`bool<class_bool>`  **get_shift**  **(** **)** const

.. _class_InputEventWithModifiers_set_alt:

- void  **set_alt**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_InputEventWithModifiers_set_command:

- void  **set_command**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_InputEventWithModifiers_set_control:

- void  **set_control**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_InputEventWithModifiers_set_metakey:

- void  **set_metakey**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_InputEventWithModifiers_set_shift:

- void  **set_shift**  **(** :ref:`bool<class_bool>` enable  **)**