Engine API Reference - v2.6.1
    Preparing search index...

    Class KeyboardEvent

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

    Index

    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

      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: null | Element = null

    The element that fired the keyboard event.

    event: null | KeyboardEvent = null

    The original browser event which was fired.

    key: null | number = null

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