mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
160 lines
7.0 KiB
ReStructuredText
160 lines
7.0 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/InputEventKey.xml.
|
|
|
|
.. _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:`physical_scancode<class_InputEventKey_property_physical_scancode>` | ``0`` |
|
|
+-------------------------+--------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventKey_property_pressed>` | ``false`` |
|
|
+-------------------------+--------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`scancode<class_InputEventKey_property_scancode>` | ``0`` |
|
|
+-------------------------+--------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`unicode<class_InputEventKey_property_unicode>` | ``0`` |
|
|
+-------------------------+--------------------------------------------------------------------------+-----------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_physical_scancode_with_modifiers<class_InputEventKey_method_get_physical_scancode_with_modifiers>` **(** **)** |const| |
|
|
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_scancode_with_modifiers<class_InputEventKey_method_get_scancode_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_physical_scancode:
|
|
|
|
- :ref:`int<class_int>` **physical_scancode**
|
|
|
|
+-----------+------------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+------------------------------+
|
|
| *Setter* | set_physical_scancode(value) |
|
|
+-----------+------------------------------+
|
|
| *Getter* | get_physical_scancode() |
|
|
+-----------+------------------------------+
|
|
|
|
Key physical scancode, 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_scancode_string(event.physical_scancode)`` 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_scancode:
|
|
|
|
- :ref:`int<class_int>` **scancode**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_scancode(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_scancode() |
|
|
+-----------+---------------------+
|
|
|
|
The key scancode, 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_scancode_string(event.scancode)`` where ``event`` is the ``InputEventKey``.
|
|
|
|
----
|
|
|
|
.. _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_physical_scancode_with_modifiers:
|
|
|
|
- :ref:`int<class_int>` **get_physical_scancode_with_modifiers** **(** **)** |const|
|
|
|
|
Returns the physical scancode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
|
|
|
|
To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_scancode_string(event.get_physical_scancode_with_modifiers())`` where ``event`` is the ``InputEventKey``.
|
|
|
|
----
|
|
|
|
.. _class_InputEventKey_method_get_scancode_with_modifiers:
|
|
|
|
- :ref:`int<class_int>` **get_scancode_with_modifiers** **(** **)** |const|
|
|
|
|
Returns the scancode combined with modifier keys such as :kbd:`Shift` or :kbd:`Alt`. See also :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`.
|
|
|
|
To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_scancode_string(event.get_scancode_with_modifiers())`` where ``event`` is the ``InputEventKey``.
|
|
|
|
.. |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.)`
|