InputEvent
Hereda: Resource < RefCounted < Object
Heredado por: InputEventAction, InputEventFromWindow, InputEventJoypadButton, InputEventJoypadMotion, InputEventMIDI, InputEventShortcut
Abstract base class for input events.
Descripción
Abstract base class of all types of input events. See Node._input().
Tutoriales
Propiedades
|
Métodos
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 dispositivo utilizado para la entrada de ratón emulada desde una pantalla táctil, o para la entrada táctil emulada desde un ratón. Esto se puede utilizar para distinguir la entrada de ratón emulada de la entrada de ratón física, o la entrada táctil emulada de la entrada táctil física.
Descripciones de Propiedades
El ID del dispositivo del evento.
Nota: device puede ser negativo para casos de uso especiales que no se refieren a dispositivos presentes físicamente en el sistema. Véase DEVICE_ID_EMULATION.
Descripciones de Métodos
bool accumulate(with_event: InputEvent) 🔗
Devuelve true si el evento de entrada dado y este evento de entrada se pueden sumar (sólo para eventos del tipo InputEventMouseMotion).
Se copiarán la posición, la posición global y la velocidad del evento de entrada dado. El relativo resultante es una suma de ambos eventos. Los modificadores de ambos eventos tienen que ser idénticos.
Devuelve una representación String del evento.
float get_action_strength(action: StringName, exact_match: bool = false) const 🔗
Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type InputEventJoypadMotion.
If exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
bool is_action(action: StringName, exact_match: bool = false) const 🔗
Returns true if this input event matches a pre-defined action of any type.
If exact_match is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.
bool is_action_pressed(action: StringName, allow_echo: bool = false, exact_match: bool = false) const 🔗
Devuelve true si la acción dada coincide con este evento y está siendo presionada (y no es un evento de eco para los eventos InputEventKey, a menos que allow_echo sea true). No es relevante para los eventos de tipo InputEventMouseMotion o InputEventScreenDrag.
Si exact_match es false, ignora los modificadores de entrada adicionales para los eventos InputEventKey e InputEventMouseButton, y la dirección para los eventos InputEventJoypadMotion.
Nota: Debido al efecto fantasma del teclado, is_action_pressed() puede devolver false incluso si una de las teclas de la acción está presionada. Consulta los ejemplos de entrada en la documentación para obtener más información.
bool is_action_released(action: StringName, exact_match: bool = false) const 🔗
Devuelve true si la acción dada coincide con este evento y ha sido liberada (es decir, no presionada). No es relevante para los eventos de tipo InputEventMouseMotion o InputEventScreenDrag.
Si exact_match es false, ignora los modificadores de entrada adicionales para los eventos InputEventKey e InputEventMouseButton, y la dirección para los eventos InputEventJoypadMotion.
Returns true if this input event's type is one that can be assigned to an input action: InputEventKey, InputEventMouseButton, InputEventJoypadButton, InputEventJoypadMotion, InputEventAction. Returns false for all other input event types.
Devuelve true si este evento de entrada ha sido cancelado.
Devuelve true si este evento de entrada es un evento de eco (solo para eventos de tipo InputEventKey). Un evento de eco es un evento de tecla repetido que se envía cuando el usuario mantiene pulsada la tecla. Cualquier otro tipo de evento devuelve false.
Nota: La velocidad a la que se envían los eventos de eco suele ser de unos 20 eventos por segundo (después de mantener pulsada la tecla durante aproximadamente medio segundo). Sin embargo, el retardo/velocidad de repetición de las teclas puede ser modificado por el usuario o desactivado por completo en la configuración del sistema operativo. Para asegurar que su proyecto funciona correctamente en todas las configuraciones, no asumas que el usuario tiene una configuración específica de repetición de teclas en el comportamiento de tu proyecto.
bool is_match(event: InputEvent, exact_match: bool = true) const 🔗
Devuelve true si el event especificado coincide con este evento. Solo es válido para eventos de acción, que incluyen tecla (InputEventKey), botón (InputEventMouseButton o InputEventJoypadButton), eje InputEventJoypadMotion y eventos de acción (InputEventAction).
Si exact_match es false, la comprobación ignora los modificadores de entrada adicionales para los eventos InputEventKey y InputEventMouseButton, y la dirección para los eventos InputEventJoypadMotion.
Nota: Este método solo considera la configuración del evento (como la tecla del teclado o el eje del joypad), no la información de estado como is_pressed(), is_released(), is_echo() o is_canceled().
Devuelve true si este evento de entrada está presionado. No es relevante para eventos de tipo InputEventMouseMotion o InputEventScreenDrag.
Nota: Debido al efecto fantasma del teclado, is_pressed() puede devolver false incluso si una de las teclas de la acción está presionada. Véase Ejemplos de entrada en la documentación para obtener más información.
Devuelve true si este evento de entrada ha sido liberado. No es relevante para eventos de tipo InputEventMouseMotion o InputEventScreenDrag.
InputEvent xformed_by(xform: Transform2D, local_ofs: Vector2 = Vector2(0, 0)) const 🔗
Devuelve una copia del evento de entrada dado que ha sido desplazado por local_ofs y transformado por xform. Relevante para eventos de tipo InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture y InputEventPanGesture.