Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
InputEvent
Hérite de : Resource < RefCounted < Object
Hérité par : InputEventAction, InputEventFromWindow, InputEventJoypadButton, InputEventJoypadMotion, InputEventMIDI, InputEventShortcut
Classe de base abstraite pour les événements d'entrée.
Description
Classe de base abstraite de tous les types d'événements d'entrée. Voir Node._input().
Tutoriels
Propriétés
|
Méthodes
accumulate(with_event: InputEvent) |
|
as_text() const |
|
get_action_strength(action: StringName, exact_match: bool = false) const |
|
is_action(action: StringName, exact_match: bool = false) const |
|
is_action_pressed(action: StringName, allow_echo: bool = false, exact_match: bool = false) const |
|
is_action_released(action: StringName, exact_match: bool = false) const |
|
is_action_type() const |
|
is_canceled() const |
|
is_echo() const |
|
is_match(event: InputEvent, exact_match: bool = true) const |
|
is_pressed() const |
|
is_released() const |
|
xformed_by(xform: Transform2D, local_ofs: Vector2 = Vector2(0, 0)) const |
Constantes
DEVICE_ID_EMULATION = -1 🔗
ID de périphérique utilisé pour une entrée de souris émulée à partir d'un écran tactile, ou pour une entrée tactile émulée à partir d'une souris. Cela peut être utilisé pour distinguer l'entrée de la souris émulée de l'entrée de la souris physique, ou de l'entrée tactile émulée de l'entrée tactile physique.
DEVICE_ID_KEYBOARD = 16 🔗
Device ID used for input from a keyboard. This can be used to distinguish keyboard input events from joypad input events.
DEVICE_ID_MOUSE = 32 🔗
Device ID used for input from a mouse. This can be used to distinguish mouse input events from joypad input events.
Descriptions des propriétés
L'identifiant du périphérique de l'événement.
Note : device peut être négatif pour des cas d'utilisation spéciaux qui ne se réfèrent pas aux appareils physiquement présents sur le système. Voir DEVICE_ID_EMULATION.
Descriptions des méthodes
bool accumulate(with_event: InputEvent) 🔗
Renvoie true si l'événement d'entrée donné et cet événement d'entrée peuvent être ajoutés ensemble (seulement pour les événements de type InputEventMouseMotion).
La position, la position globale et la vitesse de l'événement d'entrée donné seront copiées. La propriété relative résultante est une somme des deux événements. Les modificateurs des deux événements doivent être identiques.
Renvoie une représentation String de l'évènement.
float get_action_strength(action: StringName, exact_match: bool = false) const 🔗
Renvoie une valeur entre 0,0 et 1,0 selon l'état de l'action donnée. Utile pour obtenir la valeur des événements du type InputEventJoypadMotion.
Si exact_match vaut false, ignore les modificateurs d'entrée supplémentaires pour les évènements InputEventKey et InputEventMouseButton, et la direction pour les évènements InputEventJoypadMotion.
bool is_action(action: StringName, exact_match: bool = false) const 🔗
Renvoie true si cet événement d'entrée correspond à une action prédéfinie de n'importe quel type.
Si exact_match vaut false, ignore les modificateurs d'entrée supplémentaires pour les évènements InputEventKey et InputEventMouseButton, et la direction pour les évènements InputEventJoypadMotion.
bool is_action_pressed(action: StringName, allow_echo: bool = false, exact_match: bool = false) const 🔗
Renvoie true si l'action donnée correspond à cet événement et est appuyée (et n'est pas un événement d'écho pour les événements InputEventKey, sauf si allow_echo vaut true). Non pertinent pour les événements de type InputEventMouseMotion ou InputEventScreenDrag.
Si exact_match vaut false, cela ignore les modificateurs d'entrée supplémentaires pour les évènements InputEventKey et InputEventMouseButton, et la direction pour les évènements InputEventJoypadMotion.
Note : En raison d'un problème de clavier fantôme (keyboard ghosting), is_action_pressed() peut renvoyer false même si l'une des touches de l'action est appuyée. Voir Exemples d'entrée dans la documentation pour plus d'informations.
bool is_action_released(action: StringName, exact_match: bool = false) const 🔗
Renvoie true si l'action donnée correspond à cet événement et est relâchée (c-à-d non appuyée). Non pertinent pour les événements de type InputEventMouseMotion ou InputEventScreenDrag.
Si exact_match vaut false, cela ignore les modificateurs d'entrée supplémentaires pour les évènements InputEventKey et InputEventMouseButton, et la direction pour les évènements InputEventJoypadMotion.
Renvoie true si le type de cet événement d'entrée est un type qui peut être assigné à une action d'entrée : InputEventKey, InputEventMouseButton, InputEventJoypadButton, InputEventJoypadMotion, InputEventAction. Renvoie false pour tous les autres types d'événements d'entrée.
Renvoie true si cet évènement d'entrée a été annulé.
Renvoie true si cet évènement est un évènement d'écho (seulement pour les évènements du type InputEventKey). Un événement d'écho est un événement de touche répété envoyé lorsque l'utilisateur maintient la touche. Tout autre type d'évènement renvoie false.
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.
bool is_match(event: InputEvent, exact_match: bool = true) const 🔗
Renvoie true si l'événement event spécifié correspond à cet événement. Seulement valable pour les événements d'action, ce qui inclut les évènements de touche (InputEventKey), de bouton (InputEventMouseButton ou InputEventJoypadButton), d'axe InputEventJoypadMotion, et d'action (InputEventAction).
Si exact_match vaut false, la vérification ignore les modificateurs d'entrée supplémentaires pour les évènements InputEventKey et InputEventMouseButton, et la direction pour les évènements InputEventJoypadMotion.
Note : Cette méthode ne considère que la configuration de l'événement (tel que la touche du clavier ou l'axe de la manette), et non les informations d'état comme is_pressed(), is_released(), is_echo(), ou is_canceled().
Renvoie true si cet évènement d'entrée est appuyé. Non pertinent pour les événements de type InputEventMouseMotion ou InputEventScreenDrag.
Note : En raison d'un problème de clavier fantôme (keyboard ghosting), is_action_pressed() peut renvoyer false même si l'une des touches de l'action est appuyée. Voir Exemples d'entrée dans la documentation pour plus d'informations.
Renvoie true si cet évènement d'entrée est relâché. Non pertinent pour les événements de type InputEventMouseMotion ou InputEventScreenDrag.
InputEvent xformed_by(xform: Transform2D, local_ofs: Vector2 = Vector2(0, 0)) const 🔗
Renvoie une copie de l'événement d'entrée donné qui a été décalé de local_ofs et transformé par xform. Pertinent pour les évènements de type InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture et InputEventPanGesture.