mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
156 lines
6.5 KiB
ReStructuredText
156 lines
6.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventKey.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventKey:
|
|
|
|
InputEventKey
|
|
=============
|
|
|
|
**Inherits:** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Input event type for keyboard events.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Stores key presses on the keyboard. Supports key presses, key releases and :ref:`echo<class_InputEventKey_property_echo>` events.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/inputs/inputevent`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`echo<class_InputEventKey_property_echo>` | ``false`` |
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`keycode<class_InputEventKey_property_keycode>` | ``0`` |
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`physical_keycode<class_InputEventKey_property_physical_keycode>` | ``0`` |
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventKey_property_pressed>` | ``false`` |
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`unicode<class_InputEventKey_property_unicode>` | ``0`` |
|
|
+-------------------------+------------------------------------------------------------------------+-----------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-----------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_keycode_with_modifiers<class_InputEventKey_method_get_keycode_with_modifiers>` **(** **)** const |
|
|
+-----------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_physical_keycode_with_modifiers<class_InputEventKey_method_get_physical_keycode_with_modifiers>` **(** **)** const |
|
|
+-----------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventKey_property_echo:
|
|
|
|
- :ref:`bool<class_bool>` **echo**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_echo(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | is_echo() |
|
|
+-----------+-----------------+
|
|
|
|
If ``true``, the key was already pressed before this event. It means the user is holding the key down.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_property_keycode:
|
|
|
|
- :ref:`int<class_int>` **keycode**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_keycode(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_keycode() |
|
|
+-----------+--------------------+
|
|
|
|
The key keycode, which corresponds to one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants. Represent key in the current keyboard layout.
|
|
|
|
To get a human-readable representation of the ``InputEventKey``, use ``OS.get_keycode_string(event.keycode)`` where ``event`` is the ``InputEventKey``.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_property_physical_keycode:
|
|
|
|
- :ref:`int<class_int>` **physical_keycode**
|
|
|
|
+-----------+-----------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-----------------------------+
|
|
| *Setter* | set_physical_keycode(value) |
|
|
+-----------+-----------------------------+
|
|
| *Getter* | get_physical_keycode() |
|
|
+-----------+-----------------------------+
|
|
|
|
Key physical keycode, which corresponds to one of the :ref:`KeyList<enum_@GlobalScope_KeyList>` constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard.
|
|
|
|
To get a human-readable representation of the ``InputEventKey``, use ``OS.get_keycode_string(event.keycode)`` where ``event`` is the ``InputEventKey``.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_property_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **pressed**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_pressed(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | is_pressed() |
|
|
+-----------+--------------------+
|
|
|
|
If ``true``, the key's state is pressed. If ``false``, the key's state is released.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_property_unicode:
|
|
|
|
- :ref:`int<class_int>` **unicode**
|
|
|
|
+-----------+--------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+--------------------+
|
|
| *Setter* | set_unicode(value) |
|
|
+-----------+--------------------+
|
|
| *Getter* | get_unicode() |
|
|
+-----------+--------------------+
|
|
|
|
The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See :ref:`OS.set_ime_active<class_OS_method_set_ime_active>` for more information.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_InputEventKey_method_get_keycode_with_modifiers:
|
|
|
|
- :ref:`int<class_int>` **get_keycode_with_modifiers** **(** **)** const
|
|
|
|
Returns the keycode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
|
|
|
|
To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_keycode_string(event.get_keycode_with_modifiers())`` where ``event`` is the ``InputEventKey``.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_method_get_physical_keycode_with_modifiers:
|
|
|
|
- :ref:`int<class_int>` **get_physical_keycode_with_modifiers** **(** **)** const
|
|
|
|
Returns the physical keycode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
|
|
|
|
To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_keycode_string(event.get_physical_keycode_with_modifiers())`` where ``event`` is the ``InputEventKey``.
|
|
|