Options
All
  • Public
  • Public/Protected
  • All
Menu

Event thrown on a game object for a key event

Hierarchy

Index

Constructors

  • new KeyEvent(key: Keys, value?: string, originalEvent?: KeyboardEvent): KeyEvent
  • Parameters

    • key: Keys

      The key responsible for throwing the event

    • Optional value: string

      The key's typed value the browser detected

    • Optional originalEvent: KeyboardEvent

      The original keyboard event that Excalibur handled

    Returns KeyEvent

Properties

key: Keys
originalEvent?: KeyboardEvent
other: any

Other target object for this event

target: any

Target object for this event.

value?: string

Accessors

  • get bubbles(): boolean
  • set bubbles(value: boolean): void
  • If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

    Returns boolean

  • If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

    Parameters

    • value: boolean

    Returns void

Methods

  • stopPropagation(): void