Struct InputEventKey

Input event type for keyboard events.

struct InputEventKey ;

Stores key presses on the keyboard. Supports key presses, key releases and echo events.

Properties

NameTypeDescription
echo[get, set] boolIf true, the key was already pressed before this event. It means the user is holding the key down.
pressed[get, set] boolIf true, the key's state is pressed. If false, the key's state is released.
scancode[get, set] longThe key scancode, which corresponds to one of the keylist constants. To get a human-readable representation of the InputEventKey, use OS.get_scancode_string(event.scancode) where event is the InputEventKey.
unicode[get, set] longThe 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 OS.setImeActive for more information.

Methods

NameDescription
getScancode
getScancodeWithModifiers Returns the scancode combined with modifier keys such as Shift or Alt. See also 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.
getUnicode
setEcho
setPressed
setScancode
setUnicode