InputEventKey¶
Category: Built-In Types
Brief Description¶
Built-in input event type for keyboard events.
Member Functions¶
bool | is_action ( String action ) |
bool | is_action_pressed ( String action ) |
bool | is_action_released ( String action ) |
bool | is_echo ( ) |
bool | is_pressed ( ) |
void | set_as_action ( String action, bool pressed ) |
Member Variables¶
- int ID - Event identifier, positive integer increased at each new event.
- bool alt - State of the Alt modifier.
- bool control - State of the Ctrl modifier.
- int device - Device identifier.
- bool echo - Echo state of the key, i.e. whether it’s a repeat event or not.
- bool meta - State of the Meta modifier.
- bool pressed - Pressed state of the key.
- int scancode - Scancode of the key, one of the KEY_* constants in [@Global Scope].
- bool shift - State of the Shift modifier.
- int type - Type of event (one of the [InputEvent] constants).
- int unicode - Unicode identifier of the key (when relevant).
Numeric Constants¶
- NONE = 0 — Empty input event.
- KEY = 1 — Key event.
- MOUSE_MOTION = 2 — Mouse motion event.
- MOUSE_BUTTON = 3 — Mouse button event.
- JOYSTICK_MOTION = 4 — Joystick motion event.
- JOYSTICK_BUTTON = 5 — Joystick button event.
- SCREEN_TOUCH = 6 — Screen touch event.
- SCREEN_DRAG = 7 — Screen drag event.
- ACTION = 8 — Pre-defined action event (see InputMap).
Description¶
Input event type for keyboard events that extends the global InputEvent type.
Member Function Description¶
Return if this input event matches a pre-defined action.
Return whether the given action is being pressed.
Return whether the given action is released (i.e. not pressed).
- bool is_echo ( )
Return if this input event is an echo event.
- bool is_pressed ( )
Return if this input event is pressed.
Change the input event to an action event of the given name with the pressed status passed as argument.