Interface KeyEvent

Raw keyboard event received by Keyboard.OnRawEvent.

interface KeyEvent {
    type: "down" | "up";
    virtual_key: number;
    scan_code: number;
    flags: number;
    modifier_flags: number;
    device_id: string | null;
}

Properties

type: "down" | "up"

"down" when the key is pressed, "up" when released.

virtual_key: number

Windows virtual-key code (for example 0x41 for A).

scan_code: number

Windows hardware scan code.

flags: number

Windows keyboard-event flags; 0x80 indicates key-up. Prefer type for the normalized phase.

modifier_flags: number

PowerKeys modifier-state bitfield captured with this event.

device_id: string | null

Device path identifying the physical keyboard that generated the event, or null if unavailable.