InputEventKey

Hérite de : InputEventWithModifiers < InputEventFromWindow < InputEvent < Resource < RefCounted < Object

Représente une touche sur un clavier appuyée ou relâchée.

Description

Un événement d'entrée pour des touches sur un clavier. Supporte les appuis de touche, les relâchement de touche et les événements d'echo. Il peut également être reçu dans Node._unhandled_key_input().

Note : Les événements reçus du clavier ont généralement toutes leurs propriétés définies. Les associations d'événements ne devraient avoir qu'une seule propriété définie entre keycode, physical_keycode ou unicode.

Lorsque des événements sont comparés, les propriétés sont contrôlées selon la priorité suivante - keycode, physical_keycode et unicode. Des événements avec la première valeur correspondante seront considérés comme égaux.

Tutoriels

Propriétés

bool

echo

false

Key

key_label

0

Key

keycode

0

KeyLocation

location

0

Key

physical_keycode

0

bool

pressed

false

int

unicode

0

Méthodes

String

as_text_key_label() const

String

as_text_keycode() const

String

as_text_location() const

String

as_text_physical_keycode() const

Key

get_key_label_with_modifiers() const

Key

get_keycode_with_modifiers() const

Key

get_physical_keycode_with_modifiers() const

Descriptions des propriétés

bool echo = false 🔗

  • void set_echo(value: bool)

  • bool is_echo()

Si true, la touche était déjà appuyée avant cet événement. Un événement d'écho est un événement de touche répété envoyé lorsque l'utilisateur maintient la touche.

Note : Le taux auquel les évènement d'écho sont envoyés est généralement d'environ 20 événements par seconde (après avoir maintenu la touche pendant environ une demi-seconde). Cependant, le délai/vitesse de répétition de la touche peut être changé par l'utilisateur ou désactivé entièrement dans les paramètres du système d'exploitation. Pour vous assurer que votre projet fonctionne correctement sur toutes les configurations, ne supposez pas dans le comportement de votre projet que l'utilisateur a une configuration de répétition de touche spécifique.

Key key_label = 0 🔗

  • void set_key_label(value: Key)

  • Key get_key_label()

Représente le libellé traduit imprimé sur la touche dans la disposition de clavier actuel, qui correspond à l'une des constantes Key ou à tout caractère Unicode valide.

Pour les dispositions de clavier avec un seul libellé sur la touche, cela est équivalent à keycode.

Pour obtenir une représentation lisible de l'InputEventKey, utilisez OS.get_keycode_string(event.key_label) où event est l'InputEventKey.

+-----+ +-----+
| Q   | | Q   | - "Q" - keycode
|   Й | |  ض  | - "Й" et "ض" - key_label
+-----+ +-----+

Key keycode = 0 🔗

  • void set_keycode(value: Key)

  • Key get_keycode()

Libellé Latin imprimé sur la touche dans la disposition de clavier actuel, qui correspond à l'une des constantes Key.

Pour obtenir une représentation lisible de l'InputEventKey, utilisez OS.get_keycode_string(event.keycode) où event est l'InputEventKey.

+-----+ +-----+
| Q   | | Q   | - "Q" - keycode
|   Й | |  ض  | - "Й" et "ض" - key_label
+-----+ +-----+

KeyLocation location = 0 🔗

Représente l'emplacement d'une touche qui a à la fois une version gauche et droite, comme Maj ou Alt.

Key physical_keycode = 0 🔗

  • void set_physical_keycode(value: Key)

  • Key get_physical_keycode()

Représente l'emplacement physique d'une touche sur un clavier QWERTY US à 101/102 touches, ce qui correspond à l'une des constantes Key.

Pour obtenir une représentation lisible de l'InputEventKey, utilisez OS.get_keycode_string() en combinaison avec DisplayServer.keyboard_get_keycode_from_physical() :

func _input(event):
    if event is InputEventKey:
        var keycode = DisplayServer.keyboard_get_keycode_from_physical(event.physical_keycode)
        print(OS.get_keycode_string(keycode))

bool pressed = false 🔗

  • void set_pressed(value: bool)

  • bool is_pressed()

Si true, l’état de la clé est pressé. Si false, l’état de la clé est libéré.

int unicode = 0 🔗

  • void set_unicode(value: int)

  • int get_unicode()

The key Unicode character code (when relevant), shifted by modifier keys. Unicode character codes for composite characters and complex scripts may not be available unless IME input mode is active. See Window.set_ime_active() for more information.

Descriptions des méthodes

String as_text_key_label() const 🔗

Renvoie une représentation en String du key_label de l'évènement et de ses modificateurs.

String as_text_keycode() const 🔗

Renvoie une représentation en String du keycode de l'évènement et de ses modificateurs.

String as_text_location() const 🔗

Renvoie une représentation en String de la location de l'évènement. Cela sera une chaîne vide si l'évènement n'est pas spécifique à un emplacement.

String as_text_physical_keycode() const 🔗

Renvoie une représentation en String du physical_keycode de l'évènement et de ses modificateurs.

Key get_key_label_with_modifiers() const 🔗

Renvoie le libellé traduit de la touche combinée avec des touches modificatrices telles que Maj ou Alt. Voir aussi InputEventWithModifiers.

Pour obtenir une représentation lisible de l'InputEventKey avec des modificateurs, utilisez OS.get_keycode_string(event.get_key_label_with_modifiers()) où event est l'InputEventKey.

Key get_keycode_with_modifiers() const 🔗

Renvoie le code de touche Latin combiné avec des touches modificatrices telles que Maj ou Alt. Voir aussi InputEventWithModifiers.

Pour obtenir une représentation lisible de l'InputEventKey avec des modificateurs, utilisez OS.get_keycode_string(event.get_keycode_with_modifiers()) où event est l'InputEventKey.

Key get_physical_keycode_with_modifiers() const 🔗

Renvoie le code de touche physique combiné avec des touches modificatrices telles que Maj ou Alt. Voir aussi InputEventWithModifiers.

Pour obtenir une représentation lisible de l'InputEventKey avec des modificateurs, utilisez OS.get_keycode_string(event.get_physical_keycode_with_modifiers()) où event est l'InputEventKey.