The KeyboardEvent is passed into all event callbacks from the Keyboard. It corresponds to a key press or release.

Constructors

Properties

Constructors

  • Create a new KeyboardEvent.

    Parameters

    • keyboard: Keyboard

      The keyboard object which is firing the event.

    • event: KeyboardEvent

      The original browser event that was fired.

    Returns KeyboardEvent

    Example

    const onKeyDown = function (e) {
    if (e.key === pc.KEY_SPACE) {
    // space key pressed
    }
    e.event.preventDefault(); // Use original browser event to prevent browser action.
    };
    app.keyboard.on("keydown", onKeyDown, this);

Properties

element: Element = null

The element that fired the keyboard event.

event: KeyboardEvent = null

The original browser event which was fired.

key: number = null

The keyCode of the key that has changed. See the KEY_* constants.