Events

Index

Enumerations

• EventTypes

Classes

• ActionCompleteEvent
• ActionStartEvent
• ActivateEvent
• CollisionEndEvent
• CollisionPostSolveEvent
• CollisionPreSolveEvent
• CollisionStartEvent
• ContactEndEvent
• ContactStartEvent
• DeactivateEvent
• EnterTriggerEvent
• EnterViewPortEvent
• ExitTriggerEvent
• ExitViewPortEvent
• GameEvent
• GameStartEvent
• GameStopEvent
• GamepadAxisEvent
• GamepadButtonEvent
• GamepadConnectEvent
• GamepadDisconnectEvent
• HiddenEvent
• InitializeEvent
• KillEvent
• PostCollisionEvent
• PostDebugDrawEvent
• PostDrawEvent
• PostFrameEvent
• PostKillEvent
• PostTransformDrawEvent
• PostUpdateEvent
• PreCollisionEvent
• PreDebugDrawEvent
• PreDrawEvent
• PreFrameEvent
• PreKillEvent
• PreTransformDrawEvent
• PreUpdateEvent
• VisibleEvent

Type Aliases

• activate
• axis
• button
• cancel
• collisionend
• collisionstart
• connect
• deactivate
• disconnect
• down
• enter
• entertrigger
• enterviewport
• exittrigger
• exitviewport
• hidden
• hold
• initialize
• kill
• leave
• move
• pointercancel
• pointerdown
• pointerdragend
• pointerdragenter
• pointerdragleave
• pointerdragmove
• pointerdragstart
• pointerenter
• pointerleave
• pointermove
• pointerup
• pointerwheel
• postcollision
• postdebugdraw
• postdraw
• postframe
• postkill
• postupdate
• precollision
• predebugdraw
• predraw
• preframe
• prekill
• press
• preupdate
• release
• start
• stop
• subscribe
• unsubscribe
• up
• visible
• wheel

Enumerations

EventTypes

EventTypes:

ActionComplete

ActionComplete: actioncomplete

ActionStart

ActionStart: actionstart

Activate

Activate: activate

Axis

Axis: axis

Button

Button: button

Cancel

Cancel: cancel

CollisionEnd

CollisionEnd: collisionend

CollisionStart

CollisionStart: collisionstart

Connect

Connect: connect

Deactivate

Deactivate: deactivate

Disconnect

Disconnect: disconnect

Down

Down: down

Enter

Enter: enter

EnterTrigger

EnterTrigger: enter

EnterViewport

EnterViewport: enterviewport

ExitTrigger

ExitTrigger: exit

ExitViewport

ExitViewport: exitviewport

Hidden

Hidden: hidden

Hold

Hold: hold

Initialize

Initialize: initialize

Kill

Kill: kill

Leave

Leave: leave

Move

Move: move

PointerCancel

PointerCancel: pointercancel

PointerDown

PointerDown: pointerdown

PointerDragEnd

PointerDragEnd: pointerdragend

PointerDragEnter

PointerDragEnter: pointerdragenter

PointerDragLeave

PointerDragLeave: pointerdragleave

PointerDragMove

PointerDragMove: pointerdragmove

PointerDragStart

PointerDragStart: pointerdragstart

PointerEnter

PointerEnter: pointerenter

PointerLeave

PointerLeave: pointerleave

PointerMove

PointerMove: pointermove

PointerUp

PointerUp: pointerup

PointerWheel

PointerWheel: pointerwheel

PostCollision

PostCollision: postcollision

PostDebugDraw

PostDebugDraw: postdebugdraw

PostDraw

PostDraw: postdraw

PostFrame

PostFrame: postframe

PostKill

PostKill: postkill

PostUpdate

PostUpdate: postupdate

PreCollision

PreCollision: precollision

PreDebugDraw

PreDebugDraw: predebugdraw

PreDraw

PreDraw: predraw

PreFrame

PreFrame: preframe

PreKill

PreKill: prekill

PreUpdate

PreUpdate: preupdate

Press

Press: press

Release

Release: release

Start

Start: start

Stop

Stop: stop

Up

Up: up

Visible

Visible: visible

Wheel

Wheel: wheel

Classes

ActionCompleteEvent

ActionCompleteEvent:

Event thrown on an [[Actor]] when an action completes.

constructor

• new ActionCompleteEvent(action: Action, target: Entity<any>): ActionCompleteEvent

• Overrides GameEvent.constructor

  Parameters

  • action: Action

  • target: Entity<any>

  Returns ActionCompleteEvent

publicaction

action: Action

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

ActionStartEvent

ActionStartEvent:

Event thrown on an [[Actor]] when an action starts.

constructor

• new ActionStartEvent(action: Action, target: Entity<any>): ActionStartEvent

• Overrides GameEvent.constructor

  Parameters

  • action: Action

  • target: Entity<any>

  Returns ActionStartEvent

publicaction

action: Action

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

ActivateEvent

ActivateEvent<TData>:

Event thrown on a [[Scene]] on activation

---

Type parameters

• TData = undefined

constructor

• new ActivateEvent<TData>(context: SceneActivationContext<TData>, target: Scene<unknown>): ActivateEvent<TData>

• Overrides GameEvent.constructor

  Type parameters

  • TData = undefined

  Parameters

  • context: SceneActivationContext<TData>

    The context for the scene activation

  • target: Scene<unknown>

  Returns ActivateEvent<TData>

publiccontext

context: SceneActivationContext<TData>

The context for the scene activation

publicother

other: Scene<unknown>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Scene<unknown>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

CollisionEndEvent

CollisionEndEvent<T>:

Event thrown when the [[Actor|actor]] is no longer colliding with another

---

Type parameters

• T: BodyComponent | Collider | Entity = Actor

constructor

• new CollisionEndEvent<T>(actor: T, other: T, side: Side, lastContact: CollisionContact): CollisionEndEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: Entity<any> | BodyComponent | Collider = Actor

  Parameters

  • actor: T

  • other: T

  • side: Side

  • lastContact: CollisionContact

  Returns CollisionEndEvent<T>

publiclastContact

lastContact: CollisionContact

publicother

other: T

Inherited from GameEvent.other

Other target object for this event

publicside

side: Side

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicactor

• get actor(): T
• set actor(actor: T): void

• Returns T

• Parameters

  • actor: T

  Returns void

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

CollisionPostSolveEvent

CollisionPostSolveEvent<T>:

Type parameters

• T

constructor

• new CollisionPostSolveEvent<T>(target: T, other: T, side: Side, intersection: Vector, contact: CollisionContact): CollisionPostSolveEvent<T>

• Type parameters

  • T

  Parameters

  • target: T

  • other: T

  • side: Side

  • intersection: Vector

  • contact: CollisionContact

  Returns CollisionPostSolveEvent<T>

publiccontact

contact: CollisionContact

publicintersection

intersection: Vector

publicother

other: T

publicside

side: Side

publictarget

target: T

CollisionPreSolveEvent

CollisionPreSolveEvent<T>:

Type parameters

• T

constructor

• new CollisionPreSolveEvent<T>(target: T, other: T, side: Side, intersection: Vector, contact: CollisionContact): CollisionPreSolveEvent<T>

• Type parameters

  • T

  Parameters

  • target: T

  • other: T

  • side: Side

  • intersection: Vector

  • contact: CollisionContact

  Returns CollisionPreSolveEvent<T>

publiccontact

contact: CollisionContact

publicintersection

intersection: Vector

publicother

other: T

publicside

side: Side

publictarget

target: T

CollisionStartEvent

CollisionStartEvent<T>:

Event thrown the first time an [[Actor|actor]] collides with another, after an actor is in contact normal collision events are fired.

---

Type parameters

• T: BodyComponent | Collider | Entity = Actor

constructor

• new CollisionStartEvent<T>(actor: T, other: T, side: Side, contact: CollisionContact): CollisionStartEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: Entity<any> | BodyComponent | Collider = Actor

  Parameters

  • actor: T

  • other: T

  • side: Side

  • contact: CollisionContact

  Returns CollisionStartEvent<T>

publiccontact

contact: CollisionContact

publicother

other: T

Inherited from GameEvent.other

publicside

side: Side

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicactor

• get actor(): T
• set actor(actor: T): void

• Returns T

• Parameters

  • actor: T

  Returns void

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

ContactEndEvent

ContactEndEvent<T>:

Type parameters

• T

constructor

• new ContactEndEvent<T>(target: T, other: T, side: Side, lastContact: CollisionContact): ContactEndEvent<T>

• Type parameters

  • T

  Parameters

  • target: T

  • other: T

  • side: Side

  • lastContact: CollisionContact

  Returns ContactEndEvent<T>

publiclastContact

lastContact: CollisionContact

publicother

other: T

publicside

side: Side

publictarget

target: T

ContactStartEvent

ContactStartEvent<T>:

Type parameters

• T

constructor

• new ContactStartEvent<T>(target: T, other: T, side: Side, contact: CollisionContact): ContactStartEvent<T>

• Type parameters

  • T

  Parameters

  • target: T

  • other: T

  • side: Side

  • contact: CollisionContact

  Returns ContactStartEvent<T>

publiccontact

contact: CollisionContact

publicother

other: T

publicside

side: Side

publictarget

target: T

DeactivateEvent

DeactivateEvent:

Event thrown on a [[Scene]] on deactivation

constructor

• new DeactivateEvent(context: SceneActivationContext<never>, target: Scene<unknown>): DeactivateEvent

• Overrides GameEvent.constructor

  Parameters

  • context: SceneActivationContext<never>

    The context for the scene deactivation

  • target: Scene<unknown>

  Returns DeactivateEvent

publiccontext

context: SceneActivationContext<never>

The context for the scene deactivation

publicother

other: Scene<unknown>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Scene<unknown>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

EnterTriggerEvent

EnterTriggerEvent:

Base event type in Excalibur that all other event types derive from. Not all event types are thrown on all Excalibur game objects, some events are unique to a type, others are not.

constructor

• new EnterTriggerEvent(target: Trigger, actor: Actor): EnterTriggerEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Trigger

  • actor: Actor

  Returns EnterTriggerEvent

publicactor

actor: Actor

publicother

other: Actor

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Trigger

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

EnterViewPortEvent

EnterViewPortEvent:

Event thrown on an [[Actor]] when any part of the graphics bounds are on screen.

constructor

• new EnterViewPortEvent(target: Entity<any>): EnterViewPortEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Entity<any>

  Returns EnterViewPortEvent

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

ExitTriggerEvent

ExitTriggerEvent:

Base event type in Excalibur that all other event types derive from. Not all event types are thrown on all Excalibur game objects, some events are unique to a type, others are not.

constructor

• new ExitTriggerEvent(target: Trigger, actor: Actor): ExitTriggerEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Trigger

  • actor: Actor

  Returns ExitTriggerEvent

publicactor

actor: Actor

publicother

other: Actor

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Trigger

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

ExitViewPortEvent

ExitViewPortEvent:

Event thrown on an [[Actor]] when the graphics bounds completely leaves the screen.

constructor

• new ExitViewPortEvent(target: Entity<any>): ExitViewPortEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Entity<any>

  Returns ExitViewPortEvent

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GameEvent

GameEvent<T, U>:

Base event type in Excalibur that all other event types derive from. Not all event types are thrown on all Excalibur game objects, some events are unique to a type, others are not.

---

Type parameters

• T
• U = T

constructor

• new GameEvent<T, U>(): GameEvent<T, U>

• Type parameters

  • T
  • U = T

  Returns GameEvent<T, U>

publicother

other: U

Other target object for this event

publictarget

target: T

Target object for this event.

publicbubbles

• 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

• Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Prevents event from bubbling

  ---

  Returns void

GameStartEvent

GameStartEvent:

The 'start' event is emitted on engine when has started and is ready for interaction.

constructor

• new GameStartEvent(target: Engine<any>): GameStartEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Engine<any>

  Returns GameStartEvent

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GameStopEvent

GameStopEvent:

The 'stop' event is emitted on engine when has been stopped and will no longer take input, update or draw.

constructor

• new GameStopEvent(target: Engine<any>): GameStopEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Engine<any>

  Returns GameStopEvent

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GamepadAxisEvent

GamepadAxisEvent:

Gamepad axis event. See [[Gamepads]] for information on responding to controller input. [[Gamepad]] instances receive this event;

constructor

• new GamepadAxisEvent(axis: Axes, value: number, target: Gamepad): GamepadAxisEvent

• Overrides GameEvent.constructor

  Parameters

  • axis: Axes

    The Gamepad axis

  • value: number

    A numeric value between -1 and 1

  • target: Gamepad

  Returns GamepadAxisEvent

publicaxis

axis: Axes

The Gamepad axis

publicother

other: Gamepad

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Gamepad

Inherited from GameEvent.target

Target object for this event.

publicvalue

value: number

A numeric value between -1 and 1

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GamepadButtonEvent

GamepadButtonEvent:

Gamepad button event. See [[Gamepads]] for information on responding to controller input. [[Gamepad]] instances receive this event;

constructor

• new GamepadButtonEvent(button: Buttons, value: number, target: Gamepad): GamepadButtonEvent

• Overrides GameEvent.constructor

  Parameters

  • button: Buttons

    The Gamepad button

  • value: number

    A numeric value between 0 and 1

  • target: Gamepad

  Returns GamepadButtonEvent

publicbutton

button: Buttons

The Gamepad button

publicother

other: Gamepad

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Gamepad

Inherited from GameEvent.target

Target object for this event.

publicvalue

value: number

A numeric value between 0 and 1

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GamepadConnectEvent

GamepadConnectEvent:

Event received when a gamepad is connected to Excalibur. [[Gamepads]] receives this event.

constructor

• new GamepadConnectEvent(index: number, gamepad: Gamepad): GamepadConnectEvent

• Overrides GameEvent.constructor

  Parameters

  • index: number

  • gamepad: Gamepad

  Returns GamepadConnectEvent

publicgamepad

gamepad: Gamepad

publicindex

index: number

publicother

other: Gamepad

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Gamepad

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

GamepadDisconnectEvent

GamepadDisconnectEvent:

Event received when a gamepad is disconnected from Excalibur. [[Gamepads]] receives this event.

constructor

• new GamepadDisconnectEvent(index: number, gamepad: Gamepad): GamepadDisconnectEvent

• Overrides GameEvent.constructor

  Parameters

  • index: number

  • gamepad: Gamepad

  Returns GamepadDisconnectEvent

publicgamepad

gamepad: Gamepad

publicindex

index: number

publicother

other: Gamepad

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Gamepad

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

HiddenEvent

HiddenEvent:

Event received by the [[Engine]] when the browser window is hidden from all screens.

constructor

• new HiddenEvent(target: Engine<any>): HiddenEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Engine<any>

  Returns HiddenEvent

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

InitializeEvent

InitializeEvent<T>:

Event thrown on an [[Actor]], [[Scene]], and [[Engine]] only once before the first update call

---

Type parameters

• T: OnInitialize = Entity

constructor

• new InitializeEvent<T>(engine: Engine<any>, target: T): InitializeEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: OnInitialize = Entity<any>

  Parameters

  • engine: Engine<any>

    The reference to the current engine

  • target: T

  Returns InitializeEvent<T>

publicengine

engine: Engine<any>

The reference to the current engine

publicother

other: T

Inherited from GameEvent.other

Other target object for this event

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

KillEvent

KillEvent:

The 'kill' event is emitted on actors when it is killed. The target is the actor that was killed.

constructor

• new KillEvent(target: Entity<any>): KillEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Entity<any>

  Returns KillEvent

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostCollisionEvent

PostCollisionEvent<T>:

Event thrown on an [[Actor|actor]] when a collision has been resolved (body reacted) this frame

---

Type parameters

• T: Collider | Entity = Actor

constructor

• new PostCollisionEvent<T>(actor: T, other: T, side: Side, intersection: Vector, contact: CollisionContact): PostCollisionEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: Entity<any> | Collider = Actor

  Parameters

  • actor: T

    The actor the event was thrown on

  • other: T

    The actor that did collide with the current actor

  • side: Side

    The side that did collide with the current actor

  • intersection: Vector

    Intersection vector

  • contact: CollisionContact

  Returns PostCollisionEvent<T>

publiccontact

contact: CollisionContact

publicintersection

intersection: Vector

Intersection vector

publicother

other: T

Inherited from GameEvent.other

The actor that did collide with the current actor

publicside

side: Side

The side that did collide with the current actor

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicactor

• get actor(): T
• set actor(actor: T): void

• Returns T

• Parameters

  • actor: T

  Returns void

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostDebugDrawEvent

PostDebugDrawEvent:

The 'postdebugdraw' event is emitted on actors, scenes, and engine after debug drawing starts.

constructor

• new PostDebugDrawEvent(ctx: ExcaliburGraphicsContext, target: Actor | Entity<any> | Engine<any> | Scene<unknown>): PostDebugDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • target: Actor | Entity<any> | Engine<any> | Scene<unknown>

  Returns PostDebugDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicother

other: Actor | Entity<any> | Engine<any> | Scene<unknown>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Actor | Entity<any> | Engine<any> | Scene<unknown>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostDrawEvent

PostDrawEvent:

The 'postdraw' event is emitted on actors, scenes, and engine after drawing finishes. Actors' postdraw happens inside their graphics transform so that all drawing takes place with the actor as the origin.

constructor

• new PostDrawEvent(ctx: ExcaliburGraphicsContext, delta: number, target: Entity<any> | Engine<any> | Scene<unknown> | TileMap): PostDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • delta: number

  • target: Entity<any> | Engine<any> | Scene<unknown> | TileMap

  Returns PostDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicdelta

delta: number

publicother

other: Entity<any> | Engine<any> | Scene<unknown> | TileMap

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any> | Engine<any> | Scene<unknown> | TileMap

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostFrameEvent

PostFrameEvent:

The 'postframe' event is emitted on the engine, after a frame ends.

constructor

• new PostFrameEvent(engine: Engine<any>, stats: FrameStats): PostFrameEvent

• Overrides GameEvent.constructor

  Parameters

  • engine: Engine<any>

  • stats: FrameStats

  Returns PostFrameEvent

publicengine

engine: Engine<any>

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publicstats

stats: FrameStats

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostKillEvent

PostKillEvent:

The 'postkill' event is emitted directly after the actor is killed.

constructor

• new PostKillEvent(target: Actor): PostKillEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Actor

  Returns PostKillEvent

publicother

other: Actor

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Actor

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostTransformDrawEvent

PostTransformDrawEvent:

The 'posttransformdraw' event is emitted on actors/entities after all graphics have been draw and transforms reset. Useful if you need to completely custom the draw after everything is done.

constructor

• new PostTransformDrawEvent(ctx: ExcaliburGraphicsContext, delta: number, target: Entity<any>): PostTransformDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • delta: number

  • target: Entity<any>

  Returns PostTransformDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicdelta

delta: number

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PostUpdateEvent

PostUpdateEvent<T>:

The 'postupdate' event is emitted on actors, scenes, camera, and engine after the update ends.

---

Type parameters

• T: OnPostUpdate = Entity

constructor

• new PostUpdateEvent<T>(engine: Engine<any>, delta: number, target: T): PostUpdateEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: OnPostUpdate = Entity<any>

  Parameters

  • engine: Engine<any>

  • delta: number

  • target: T

  Returns PostUpdateEvent<T>

publicdelta

delta: number

publicengine

engine: Engine<any>

publicother

other: T

Inherited from GameEvent.other

Other target object for this event

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreCollisionEvent

PreCollisionEvent<T>:

Event thrown on an [[Actor|actor]] when a collision will occur this frame if it resolves

---

Type parameters

• T: BodyComponent | Collider | Entity = Actor

constructor

• new PreCollisionEvent<T>(actor: T, other: T, side: Side, intersection: Vector, contact: CollisionContact): PreCollisionEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: Entity<any> | BodyComponent | Collider = Actor

  Parameters

  • actor: T

    The actor the event was thrown on

  • other: T

    The actor that will collided with the current actor

  • side: Side

    The side that will be collided with the current actor

  • intersection: Vector

    Intersection vector

  • contact: CollisionContact

  Returns PreCollisionEvent<T>

publiccontact

contact: CollisionContact

publicintersection

intersection: Vector

Intersection vector

publicother

other: T

Inherited from GameEvent.other

The actor that will collided with the current actor

publicside

side: Side

The side that will be collided with the current actor

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreDebugDrawEvent

PreDebugDrawEvent:

The 'predebugdraw' event is emitted on actors, scenes, and engine before debug drawing starts.

constructor

• new PreDebugDrawEvent(ctx: ExcaliburGraphicsContext, target: Actor | Entity<any> | Engine<any> | Scene<unknown>): PreDebugDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • target: Actor | Entity<any> | Engine<any> | Scene<unknown>

  Returns PreDebugDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicother

other: Actor | Entity<any> | Engine<any> | Scene<unknown>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Actor | Entity<any> | Engine<any> | Scene<unknown>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreDrawEvent

PreDrawEvent:

The 'predraw' event is emitted on actors, scenes, and engine before drawing starts. Actors' predraw happens inside their graphics transform so that all drawing takes place with the actor as the origin.

constructor

• new PreDrawEvent(ctx: ExcaliburGraphicsContext, delta: number, target: Entity<any> | Engine<any> | Scene<unknown> | TileMap): PreDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • delta: number

  • target: Entity<any> | Engine<any> | Scene<unknown> | TileMap

  Returns PreDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicdelta

delta: number

publicother

other: Entity<any> | Engine<any> | Scene<unknown> | TileMap

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any> | Engine<any> | Scene<unknown> | TileMap

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreFrameEvent

PreFrameEvent:

The 'preframe' event is emitted on the engine, before the frame begins.

constructor

• new PreFrameEvent(engine: Engine<any>, prevStats: FrameStats): PreFrameEvent

• Overrides GameEvent.constructor

  Parameters

  • engine: Engine<any>

  • prevStats: FrameStats

  Returns PreFrameEvent

publicengine

engine: Engine<any>

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publicprevStats

prevStats: FrameStats

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreKillEvent

PreKillEvent:

The 'prekill' event is emitted directly before an actor is killed.

constructor

• new PreKillEvent(target: Actor): PreKillEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Actor

  Returns PreKillEvent

publicother

other: Actor

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Actor

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreTransformDrawEvent

PreTransformDrawEvent:

The 'pretransformdraw' event is emitted on actors/entities before any graphics transforms have taken place. Useful if you need to completely customize the draw or modify the transform before drawing in the draw step (for example needing latest camera positions)

constructor

• new PreTransformDrawEvent(ctx: ExcaliburGraphicsContext, delta: number, target: Entity<any>): PreTransformDrawEvent

• Overrides GameEvent.constructor

  Parameters

  • ctx: ExcaliburGraphicsContext

  • delta: number

  • target: Entity<any>

  Returns PreTransformDrawEvent

publicctx

ctx: ExcaliburGraphicsContext

publicdelta

delta: number

publicother

other: Entity<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Entity<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

PreUpdateEvent

PreUpdateEvent<T>:

The 'preupdate' event is emitted on actors, scenes, camera, and engine before the update starts.

---

Type parameters

• T: OnPreUpdate = Entity

constructor

• new PreUpdateEvent<T>(engine: Engine<any>, delta: number, target: T): PreUpdateEvent<T>

• Overrides GameEvent.constructor

  Type parameters

  • T: OnPreUpdate = Entity<any>

  Parameters

  • engine: Engine<any>

  • delta: number

  • target: T

  Returns PreUpdateEvent<T>

publicdelta

delta: number

publicengine

engine: Engine<any>

publicother

other: T

Inherited from GameEvent.other

Other target object for this event

publictarget

target: T

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

VisibleEvent

VisibleEvent:

Event received by the [[Engine]] when the browser window is visible on a screen.

constructor

• new VisibleEvent(target: Engine<any>): VisibleEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Engine<any>

  Returns VisibleEvent

publicother

other: Engine<any>

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Engine<any>

Inherited from GameEvent.target

Target object for this event.

publicbubbles

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

• Inherited from 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 GameEvent.bubbles

  Parameters

  • value: boolean

  Returns void

publicstopPropagation

• stopPropagation(): void

• Inherited from GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void

Type Aliases

activate

activate: activate

axis

axis: axis

button

button: button

cancel

cancel: cancel

collisionend

collisionend: collisionend

collisionstart

collisionstart: collisionstart

connect

connect: connect

deactivate

deactivate: deactivate

disconnect

disconnect: disconnect

down

down: down

enter

enter: enter

entertrigger

entertrigger: enter

enterviewport

enterviewport: enterviewport

exittrigger

exittrigger: exit

exitviewport

exitviewport: exitviewport

hidden

hidden: hidden

hold

hold: hold

initialize

initialize: initialize

kill

kill: kill

leave

leave: leave

move

move: move

pointercancel

pointercancel: pointercancel

pointerdown

pointerdown: pointerdown

pointerdragend

pointerdragend: pointerdragend

pointerdragenter

pointerdragenter: pointerdragenter

pointerdragleave

pointerdragleave: pointerdragleave

pointerdragmove

pointerdragmove: pointerdragmove

pointerdragstart

pointerdragstart: pointerdragstart

pointerenter

pointerenter: pointerenter

pointerleave

pointerleave: pointerleave

pointermove

pointermove: pointermove

pointerup

pointerup: pointerup

pointerwheel

pointerwheel: pointerwheel

postcollision

postcollision: postcollision

postdebugdraw

postdebugdraw: postdebugdraw

postdraw

postdraw: postdraw

postframe

postframe: postframe

postkill

postkill: postkill

postupdate

postupdate: postupdate

precollision

precollision: precollision

predebugdraw

predebugdraw: predebugdraw

predraw

predraw: predraw

preframe

preframe: preframe

prekill

prekill: prekill

press

press: press

preupdate

preupdate: preupdate

release

release: release

start

start: start

stop

stop: stop

subscribe

subscribe: subscribe

unsubscribe

unsubscribe: unsubscribe

up

up: up

visible

visible: visible

wheel

wheel: wheel