StageEvent

The StageEvent class extends the standard Javascript Event class.

Important

StageEvents (including all derived Event types) are cancelable when dispatched by certain triggers however if the Stage Instance emitting the Event is in a Web Worker, no events emitted from that Instance will be cancelable.

Properties

.

display

: DisplayController

display

A DisplayController object representing the Display and the Stage that dispatched the event.

.

stageName

: string

stageName

The name of the Stage that dispatched the Event.

.

stageKey

: string

stageKey

The Key of the Stage that dispatched the Event.

.

instanceKey

: string

instanceKey

The Instance Key of the Stage that dispatched the Event.

.

offscreen

: boolean

offscreen

A boolean representing whether the Stage is using offscreenCanvas (i.e., running in a Web Worker).

NOTE

Events dispatched from inside Web Workers are not cancellable.

Triggers

• beforestart cancelable
• starting
• start
• stopping
• stop