KeyEvent

Event thrown on a game object for a key event

Hierarchy

• GameEvent<any>
  • KeyEvent

Index

Constructors

• constructor

Properties

• key
• originalEvent
• other
• target
• value

Accessors

• bubbles

Methods

• stopPropagation

Constructors

constructor

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

• Overrides GameEvent.constructor

  Parameters

  • key: Keys

    The key responsible for throwing the event

  • optionalvalue: string

    The key's typed value the browser detected

  • optionaloriginalEvent: KeyboardEvent

    The original keyboard event that Excalibur handled

  Returns KeyEvent

Properties

publickey

key: Keys

The key responsible for throwing the event

publicoptionaloriginalEvent

originalEvent?: KeyboardEvent

The original keyboard event that Excalibur handled

publicother

other: any = null

Inherited from GameEvent.other

Other target object for this event

publictarget

target: any

Inherited from GameEvent.target

Target object for this event.

publicoptionalvalue

value?: string

The key's typed value the browser detected

Accessors

publicbubbles

• get bubbles(): boolean
• set bubbles(value: boolean): void

• Inherited from Events.GameEvent.bubbles

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

  ---

  Returns boolean

• Inherited from Events.GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

Methods

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void