mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
128 lines
4.3 KiB
ReStructuredText
128 lines
4.3 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/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.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains keys events information with modifiers support like :kbd:`Shift` or :kbd:`Alt`. See :ref:`Node._input<class_Node_method__input>`.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/inputs/inputevent`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+----------------------------------------------------------------+-----------+
|
|
| :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`` |
|
|
+-------------------------+----------------------------------------------------------------+-----------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventWithModifiers_property_alt:
|
|
|
|
- :ref:`bool<class_bool>` **alt**
|
|
|
|
+-----------+----------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+----------------+
|
|
| *Setter* | set_alt(value) |
|
|
+-----------+----------------+
|
|
| *Getter* | get_alt() |
|
|
+-----------+----------------+
|
|
|
|
State of the :kbd:`Alt` modifier.
|
|
|
|
----
|
|
|
|
.. _class_InputEventWithModifiers_property_command:
|
|
|
|
- :ref:`bool<class_bool>` **command**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_command(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_command() |
|
|
+-----------+--------------------+
|
|
|
|
State of the :kbd:`Command` modifier.
|
|
|
|
----
|
|
|
|
.. _class_InputEventWithModifiers_property_control:
|
|
|
|
- :ref:`bool<class_bool>` **control**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_control(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_control() |
|
|
+-----------+--------------------+
|
|
|
|
State of the :kbd:`Ctrl` modifier.
|
|
|
|
----
|
|
|
|
.. _class_InputEventWithModifiers_property_meta:
|
|
|
|
- :ref:`bool<class_bool>` **meta**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_metakey(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_metakey() |
|
|
+-----------+--------------------+
|
|
|
|
State of the :kbd:`Meta` modifier.
|
|
|
|
----
|
|
|
|
.. _class_InputEventWithModifiers_property_shift:
|
|
|
|
- :ref:`bool<class_bool>` **shift**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_shift(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | 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.)`
|