Class reference
InputEventKey
Inherits InputEventWithModifiers
Represents a key on a keyboard being pressed or released.
Description
An input event for keys on a keyboard. Supports key presses, key releases and echo events. It can also be received in Node._unhandled_key_input(). Note: Events received from the keyboard usually have all properties set. Event mappings should have only one of the keycode, physical_keycode or unicode set. When events are compared, properties are checked in the following priority - keycode, physical_keycode and unicode. Events with the first matching value will be considered equal.
Properties
bool echo = false
bool echo = falseIf true, the key was already pressed before this event. An echo event is a repeated key event sent when the user is holding down the key. Note: The rate at which echo events are sent is typically around 20 events per second (after holding down the key for roughly half a second). However, the key repeat delay/speed can be changed by the user or disabled entirely in the operating system settings. To ensure your project works correctly on all configurations, do not assume the user has a specific key repeat configuration in your project's behavior.
int key_label = 0
int key_label = 0Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the Key constants or any valid Unicode character. For keyboard layouts with a single label on the key, it is equivalent to keycode. To get a human-readable representation of the InputEventKey, use OS.get_keycode_string(event.key_label) where event is the InputEventKey.
+-----+ +-----+
| Q | | Q | - "Q" - keycode
| Й | | ض | - "Й" and "ض" - key_label
+-----+ +-----+
int keycode = 0
int keycode = 0Latin label printed on the key in the current keyboard layout, which corresponds to one of the Key constants. To get a human-readable representation of the InputEventKey, use OS.get_keycode_string(event.keycode) where event is the InputEventKey.
+-----+ +-----+
| Q | | Q | - "Q" - keycode
| Й | | ض | - "Й" and "ض" - key_label
+-----+ +-----+
int location = 0
int location = 0Represents the location of a key which has both left and right versions, such as Shift or Alt.
int physical_keycode = 0
int physical_keycode = 0Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the Key constants. To get a human-readable representation of the InputEventKey, use OS.get_keycode_string() in combination with 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))
public override void _Input(InputEvent @event)
{
if (@event is InputEventKey inputEventKey)
{
var keycode = DisplayServer.KeyboardGetKeycodeFromPhysical(inputEventKey.PhysicalKeycode);
GD.Print(OS.GetKeycodeString(keycode));
}
}
bool pressed = false
bool pressed = falseIf true, the key's state is pressed. If false, the key's state is released.
int unicode = 0
int unicode = 0The 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.
Methods
String as_text_key_label() const
String as_text_key_label() constReturns a String representation of the event's key_label and modifiers.
String as_text_keycode() const
String as_text_keycode() constReturns a String representation of the event's keycode and modifiers.
String as_text_location() const
String as_text_location() constReturns a String representation of the event's location. This will be a blank string if the event is not specific to a location.
String as_text_physical_keycode() const
String as_text_physical_keycode() constReturns a String representation of the event's physical_keycode and modifiers.
int get_key_label_with_modifiers() const
int get_key_label_with_modifiers() constReturns the localized key label 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_keycode_string(event.get_key_label_with_modifiers()) where event is the InputEventKey.
int get_keycode_with_modifiers() const
int get_keycode_with_modifiers() constReturns the Latin keycode 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_keycode_string(event.get_keycode_with_modifiers()) where event is the InputEventKey.
int get_physical_keycode_with_modifiers() const
int get_physical_keycode_with_modifiers() constReturns the physical keycode 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_keycode_string(event.get_physical_keycode_with_modifiers()) where event is the InputEventKey.