godot-docs/classes/class_inputeventwithmodifiers.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventWithModifiers.xml.

.. _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>`

Base class for keys events with modifiers.

.. rst-class:: classref-introduction-group

Description
-----------

Contains keys events information with modifiers support like :kbd:`Shift` or :kbd:`Alt`. See :ref:`Node._input<class_Node_method__input>`.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`../tutorials/inputs/inputevent`

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------+----------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`alt<class_InputEventWithModifiers_property_alt>`         | ``false`` |
   +-------------------------+----------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`command<class_InputEventWithModifiers_property_command>` | ``false`` |
   +-------------------------+----------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`control<class_InputEventWithModifiers_property_control>` | ``false`` |
   +-------------------------+----------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`meta<class_InputEventWithModifiers_property_meta>`       | ``false`` |
   +-------------------------+----------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`shift<class_InputEventWithModifiers_property_shift>`     | ``false`` |
   +-------------------------+----------------------------------------------------------------+-----------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_InputEventWithModifiers_property_alt:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **alt** = ``false``

.. rst-class:: classref-property-setget

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

State of the :kbd:`Alt` modifier.

.. rst-class:: classref-item-separator

----

.. _class_InputEventWithModifiers_property_command:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **command** = ``false``

.. rst-class:: classref-property-setget

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

State of the :kbd:`Command` modifier.

.. rst-class:: classref-item-separator

----

.. _class_InputEventWithModifiers_property_control:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **control** = ``false``

.. rst-class:: classref-property-setget

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

State of the :kbd:`Ctrl` modifier.

.. rst-class:: classref-item-separator

----

.. _class_InputEventWithModifiers_property_meta:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **meta** = ``false``

.. rst-class:: classref-property-setget

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

State of the :kbd:`Meta` modifier.

.. rst-class:: classref-item-separator

----

.. _class_InputEventWithModifiers_property_shift:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **shift** = ``false``

.. rst-class:: classref-property-setget

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

State of the :kbd:`Shift` modifier.

.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`