Skip to main content

excalibur

Index

Classes

Enumerations

Functions

Interfaces

Namespaces

References

Type Aliases

Variables

References

ActionCompleteEvent

Re-exports ActionCompleteEvent

ActionStartEvent

Re-exports ActionStartEvent

ActivateEvent

Re-exports ActivateEvent

AddEvent

Re-exports AddEvent

Appender

Re-exports Appender

CollisionEndEvent

Re-exports CollisionEndEvent

CollisionPostSolveEvent

Re-exports CollisionPostSolveEvent

CollisionPreSolveEvent

Re-exports CollisionPreSolveEvent

CollisionStartEvent

Re-exports CollisionStartEvent

ConsoleAppender

Re-exports ConsoleAppender

ContactEndEvent

Re-exports ContactEndEvent

ContactStartEvent

Re-exports ContactStartEvent

DeactivateEvent

Re-exports DeactivateEvent

EasingFunction

Re-exports EasingFunction

EasingFunctions

Re-exports EasingFunctions

EnterTriggerEvent

Re-exports EnterTriggerEvent

EnterViewPortEvent

Re-exports EnterViewPortEvent

EventTypes

Re-exports EventTypes

ExitTriggerEvent

Re-exports ExitTriggerEvent

ExitViewPortEvent

Re-exports ExitViewPortEvent

GameEvent

Re-exports GameEvent

GameStartEvent

Re-exports GameStartEvent

GameStopEvent

Re-exports GameStopEvent

GamepadAxisEvent

Re-exports GamepadAxisEvent

GamepadButtonEvent

Re-exports GamepadButtonEvent

GamepadConnectEvent

Re-exports GamepadConnectEvent

GamepadDisconnectEvent

Re-exports GamepadDisconnectEvent

HiddenEvent

Re-exports HiddenEvent

InitializeEvent

Re-exports InitializeEvent

KillEvent

Re-exports KillEvent

LogLevel

Re-exports LogLevel

Logger

Re-exports Logger

MaybeObserver

Re-exports MaybeObserver

Message

Re-exports Message

Observable

Re-exports Observable

Observer

Re-exports Observer

PostCollisionEvent

Re-exports PostCollisionEvent

PostDebugDrawEvent

Re-exports PostDebugDrawEvent

PostDrawEvent

Re-exports PostDrawEvent

PostFrameEvent

Re-exports PostFrameEvent

PostKillEvent

Re-exports PostKillEvent

PostTransformDrawEvent

Re-exports PostTransformDrawEvent

PostUpdateEvent

Re-exports PostUpdateEvent

PreCollisionEvent

Re-exports PreCollisionEvent

PreDebugDrawEvent

Re-exports PreDebugDrawEvent

PreDrawEvent

Re-exports PreDrawEvent

PreFrameEvent

Re-exports PreFrameEvent

PreKillEvent

Re-exports PreKillEvent

PreTransformDrawEvent

Re-exports PreTransformDrawEvent

PreUpdateEvent

Re-exports PreUpdateEvent

RemoveEvent

Re-exports RemoveEvent

ScreenAppender

Re-exports ScreenAppender

ScreenAppenderOptions

Re-exports ScreenAppenderOptions

VisibleEvent

Re-exports VisibleEvent

activate

Re-exports activate

add

Re-exports add

axis

Re-exports axis

button

Re-exports button

cancel

Re-exports cancel

collisionend

Re-exports collisionend

collisionstart

Re-exports collisionstart

connect

Re-exports connect

deactivate

Re-exports deactivate

disconnect

Re-exports disconnect

down

Re-exports down

enter

Re-exports enter

entertrigger

Re-exports entertrigger

enterviewport

Re-exports enterviewport

exittrigger

Re-exports exittrigger

exitviewport

Re-exports exitviewport

hidden

Re-exports hidden

hold

Re-exports hold

initialize

Re-exports initialize

kill

Re-exports kill

leave

Re-exports leave

move

Re-exports move

pointercancel

Re-exports pointercancel

pointerdown

Re-exports pointerdown

pointerdragend

Re-exports pointerdragend

pointerdragenter

Re-exports pointerdragenter

pointerdragleave

Re-exports pointerdragleave

pointerdragmove

Re-exports pointerdragmove

pointerdragstart

Re-exports pointerdragstart

pointerenter

Re-exports pointerenter

pointerleave

Re-exports pointerleave

pointermove

Re-exports pointermove

pointerup

Re-exports pointerup

pointerwheel

Re-exports pointerwheel

postcollision

Re-exports postcollision

postdebugdraw

Re-exports postdebugdraw

postdraw

Re-exports postdraw

postframe

Re-exports postframe

postkill

Re-exports postkill

postupdate

Re-exports postupdate

precollision

Re-exports precollision

predebugdraw

Re-exports predebugdraw

predraw

Re-exports predraw

preframe

Re-exports preframe

prekill

Re-exports prekill

press

Re-exports press

preupdate

Re-exports preupdate

release

Re-exports release

remove

Re-exports remove

start

Re-exports start

stop

Re-exports stop

subscribe

Re-exports subscribe

unsubscribe

Re-exports unsubscribe

up

Re-exports up

visible

Re-exports visible

wheel

Re-exports wheel

Type Aliases

ActorArgs

ActorArgs: ColliderArgs & { acc?: Vector; anchor?: Vector; angularVelocity?: number; collisionGroup?: CollisionGroup; collisionType?: CollisionType; color?: Color; coordPlane?: CoordPlane; name?: string; offset?: Vector; opacity?: number; pos?: Vector; rotation?: number; scale?: Vector; silenceWarnings?: boolean; vel?: Vector; visible?: boolean; x?: number; y?: number; z?: number }

Actor constructor options

ActorEvents

ActorEvents: EntityEvents & { actioncomplete: ActionCompleteEvent; actionstart: ActionStartEvent; collisionend: CollisionEndEvent; collisionstart: CollisionStartEvent; enterviewport: EnterViewPortEvent; exitviewport: ExitViewPortEvent; kill: KillEvent; pointercancel: PointerEvent; pointerdown: PointerEvent; pointerdragend: PointerEvent; pointerdragenter: PointerEvent; pointerdragleave: PointerEvent; pointerdragmove: PointerEvent; pointerdragstart: PointerEvent; pointerenter: PointerEvent; pointerleave: PointerEvent; pointermove: PointerEvent; pointerup: PointerEvent; pointerwheel: WheelEvent; postcollision: PostCollisionEvent; postdebugdraw: PostDebugDrawEvent; postdraw: PostDrawEvent; postkill: PostKillEvent; posttransformdraw: PostDrawEvent; precollision: PreCollisionEvent; predebugdraw: PreDebugDrawEvent; predraw: PreDrawEvent; prekill: PreKillEvent; pretransformdraw: PreDrawEvent }

AnimationEvents

AnimationEvents: { end: Animation; frame: FrameEvent; loop: Animation }

Type declaration

CameraEvents

CameraEvents: { initialize: InitializeEvent<Camera>; postupdate: PostUpdateEvent<Camera>; preupdate: PreUpdateEvent<Camera> }

Type declaration

ComponentCtor

ComponentCtor<TComponent>: new (...args: any[]) => TComponent

Component Constructor Types

Type parameters

Type declaration

    • new (...args: any[]): TComponent

    • Parameters

      • rest...args: any[]

      Returns TComponent

ComponentInstance

ComponentInstance<T>: T extends ComponentCtor<infer R> ? R : never

Type parameters

  • T

CoroutineGenerator

CoroutineGenerator: () => Generator<any | number | Promise<any> | undefined, void, number>

Type declaration

    • (): Generator<any | number | Promise<any> | undefined, void, number>

    • Returns Generator<any | number | Promise<any> | undefined, void, number>

DestinationSize

DestinationSize: { height: number; width: number }

Type declaration

  • height: number
  • width: number

DirectorEvents

DirectorEvents: { navigation: DirectorNavigationEvent; navigationend: DirectorNavigationEvent; navigationstart: DirectorNavigationEvent }

Type declaration

EngineEvents

EngineEvents: DirectorEvents & { fallbackgraphicscontext: ExcaliburGraphicsContext2DCanvas; hidden: HiddenEvent; initialize: InitializeEvent<Engine>; postdraw: PostDrawEvent; postframe: PostFrameEvent; postupdate: PostUpdateEvent<Engine>; predraw: PreDrawEvent; preframe: PreFrameEvent; preupdate: PreUpdateEvent<Engine>; start: GameStartEvent; stop: GameStopEvent; visible: VisibleEvent }

EntityEvents

EntityEvents: { add: AddEvent; initialize: InitializeEvent; kill: KillEvent; postupdate: PostUpdateEvent; preupdate: PreUpdateEvent; remove: RemoveEvent }

Built in events supported by all entities

Type declaration

EventKey

EventKey<T>: string & keyof T

Type parameters

EventMap

EventMap: Record<string, any>

ExResponseType

ExResponseType: | arraybuffer | blob | document | json | text

G_UUID

G_UUID: string & { __brand: unique symbol }

A unique identifier for a graph node or edge.

HTMLImageSource

HTMLImageSource: HTMLImageElement | HTMLCanvasElement

Handler

Handler<EventType>: (event: EventType) => void

Type parameters

  • EventType

Type declaration

    • (event: EventType): void

    • Parameters

      • event: EventType

      Returns void

Id

Id<T>: { type: T; value: number }

Type parameters

  • T: string

Type declaration

  • type: T
  • value: number

IsometricTilePointerEvents

IsometricTilePointerEvents: { pointercancel: PointerEvent; pointerdown: PointerEvent; pointerenter: PointerEvent; pointerleave: PointerEvent; pointermove: PointerEvent; pointerup: PointerEvent }

Type declaration

LoaderConstructor

LoaderConstructor: new (...args: any[]) => DefaultLoader

Type declaration

LoaderEvents

LoaderEvents: { afterload: void; beforeload: void; loadresourceend: Loadable<any>; loadresourcestart: Loadable<any>; useraction: void }

Type declaration

  • afterload: void
  • beforeload: void
  • loadresourceend: Loadable<any>
  • loadresourcestart: Loadable<any>
  • useraction: void

MaybeKnownComponent

MaybeKnownComponent<Component, TKnownComponents>: Component extends TKnownComponents ? Component : Component | undefined

Type parameters

  • Component
  • TKnownComponents

NativeMouseEvent

NativeMouseEvent: globalThis.MouseEvent

NativePointerEvent

NativePointerEvent: globalThis.PointerEvent

NativeTouchEvent

NativeTouchEvent: globalThis.TouchEvent

NativeWheelEvent

NativeWheelEvent: globalThis.WheelEvent

NineSliceConfig

NineSliceConfig: GraphicOptions & { destinationConfig: { drawCenter: boolean; horizontalStretch: NineSliceStretch; verticalStretch: NineSliceStretch }; height: number; source: ImageSource; sourceConfig: { bottomMargin: number; height: number; leftMargin: number; rightMargin: number; topMargin: number; width: number }; width: number }

PossibleStates

PossibleStates<TMachine>: TMachine extends StateMachineDescription ? Extract<keyof TMachine[states], string> : never

Type parameters

  • TMachine

ResourceEvents

ResourceEvents: { complete: any; error: ProgressEvent<XMLHttpRequestEventTarget>; load: ProgressEvent<XMLHttpRequestEventTarget>; loadstart: ProgressEvent<XMLHttpRequestEventTarget>; progress: ProgressEvent<XMLHttpRequestEventTarget> }

Type declaration

  • complete: any
  • error: ProgressEvent<XMLHttpRequestEventTarget>
  • load: ProgressEvent<XMLHttpRequestEventTarget>
  • loadstart: ProgressEvent<XMLHttpRequestEventTarget>
  • progress: ProgressEvent<XMLHttpRequestEventTarget>

SceneConstructor

SceneConstructor: new (...args: any[]) => Scene

Type declaration

    • new (...args: any[]): Scene

    • Parameters

      • rest...args: any[]

      Returns Scene

SceneEvents

SceneEvents: { activate: ActivateEvent; deactivate: DeactivateEvent; initialize: InitializeEvent<Scene>; postdebugdraw: PostDebugDrawEvent; postdraw: PostDrawEvent; postupdate: PostUpdateEvent; predebugdraw: PreDebugDrawEvent; predraw: PreDrawEvent; preload: PreLoadEvent; preupdate: PreUpdateEvent; transitionend: Transition; transitionstart: Transition }

Type declaration

SceneMap

SceneMap<TKnownScenes>: Record<TKnownScenes, Scene | SceneConstructor | SceneWithOptions>

Type parameters

  • TKnownScenes: string = any

ScheduledCallbackTiming

ScheduledCallbackTiming: preframe | postframe | preupdate | postupdate | predraw | postdraw

ScreenEvents

ScreenEvents: { fullscreen: FullScreenChangeEvent; pixelratio: PixelRatioChangeEvent; resize: ScreenResizeEvent }

Built in events supported by all entities

Type declaration

  • fullscreen: FullScreenChangeEvent

    Fires when the browser fullscreen api is successfully engaged or disengaged

  • pixelratio: PixelRatioChangeEvent

    Fires when the pixel ratio changes, useful to know if you've moved to a hidpi screen or back

  • resize: ScreenResizeEvent

    Fires when the screen resizes, useful if you have logic that needs to be aware of resolution/viewport constraints

SoundEvents

SoundEvents: { pause: NativeSoundEvent; playbackend: NativeSoundEvent; playbackstart: NativeSoundEvent; processed: NativeSoundProcessedEvent; resume: NativeSoundEvent; stop: NativeSoundEvent; volumechange: NativeSoundEvent }

Type declaration

SourceView

SourceView: { height: number; width: number; x: number; y: number }

Type declaration

  • height: number
  • width: number
  • x: number
  • y: number

TileMapEvents

TileMapEvents: EntityEvents & TilePointerEvents & { postdraw: PostDrawEvent; postupdate: PostUpdateEvent<TileMap>; predraw: PreDrawEvent; preupdate: PreUpdateEvent<TileMap> }

TilePointerEvents

TilePointerEvents: { pointercancel: PointerEvent; pointerdown: PointerEvent; pointerenter: PointerEvent; pointerleave: PointerEvent; pointermove: PointerEvent; pointerup: PointerEvent }

Type declaration

TriggerEvents

TriggerEvents: ActorEvents & { enter: EnterTriggerEvent; exit: ExitTriggerEvent }

UniformDictionary

UniformDictionary: Record<string, number | boolean | Vector | Color | AffineMatrix | Float32Array | [uniformData: Float32Array, bindingPoint: number]>

UniformTypeNames

UniformTypeNames: uniform1f | uniform1i | uniform1ui | uniform2f | uniform2i | uniform2ui | uniform3f | uniform3i | uniform3ui | uniform4f | uniform4i | uniform4ui | uniform1fv | uniform1iv | uniform1uiv | uniform2fv | uniform2iv | uniform2uiv | uniform3fv | uniform3iv | uniform3uiv | uniform4fv | uniform4iv | uniform4uiv | uniformMatrix2fv | uniformMatrix2x3fv | uniformMatrix2x4fv | uniformMatrix3fv | uniformMatrix3x2fv | uniformMatrix3x4fv | uniformMatrix4fv | uniformMatrix4x2fv | uniformMatrix4x3fv

Vertex

Vertex<T>: Node<T>

Alias for a node in a graph, representing a vertex in a geometric context.

Type parameters

  • T

    The type of data stored in this vertex.

ViewportUnit

ViewportUnit: pixel | percent

WithRoot

WithRoot<TScenes>: TScenes | root

Type parameters

  • TScenes

Variables

ActorEvents

ActorEvents: { ActionComplete: actioncomplete; ActionStart: actionstart; CollisionEnd: collisionend; CollisionStart: collisionstart; EnterViewPort: enterviewport; ExitViewPort: exitviewport; Kill: kill; PointerCancel: pointercancel; PointerDown: pointerdown; PointerDrag: pointerdragstart; PointerDragEnd: pointerdragend; PointerDragEnter: pointerdragenter; PointerDragLeave: pointerdragleave; PointerDragMove: pointerdragmove; PointerEnter: pointerenter; PointerLeave: pointerleave; PointerMove: pointermove; PointerUp: pointerup; PostCollision: postcollision; PostDebugDraw: postdebugdraw; PostDraw: postdraw; PostKill: postkill; PostTransformDraw: posttransformdraw; PreCollision: precollision; PreDebugDraw: predebugdraw; PreDraw: predraw; PreKill: prekill; PreTransformDraw: pretransformdraw; Wheel: pointerwheel }

Type declaration

  • readonlyActionComplete: actioncomplete
  • readonlyActionStart: actionstart
  • readonlyCollisionEnd: collisionend
  • readonlyCollisionStart: collisionstart
  • readonlyEnterViewPort: enterviewport
  • readonlyExitViewPort: exitviewport
  • readonlyKill: kill
  • readonlyPointerCancel: pointercancel
  • readonlyPointerDown: pointerdown
  • readonlyPointerDrag: pointerdragstart
  • readonlyPointerDragEnd: pointerdragend
  • readonlyPointerDragEnter: pointerdragenter
  • readonlyPointerDragLeave: pointerdragleave
  • readonlyPointerDragMove: pointerdragmove
  • readonlyPointerEnter: pointerenter
  • readonlyPointerLeave: pointerleave
  • readonlyPointerMove: pointermove
  • readonlyPointerUp: pointerup
  • readonlyPostCollision: postcollision
  • readonlyPostDebugDraw: postdebugdraw
  • readonlyPostDraw: postdraw
  • readonlyPostKill: postkill
  • readonlyPostTransformDraw: posttransformdraw
  • readonlyPreCollision: precollision
  • readonlyPreDebugDraw: predebugdraw
  • readonlyPreDraw: predraw
  • readonlyPreKill: prekill
  • readonlyPreTransformDraw: pretransformdraw
  • readonlyWheel: pointerwheel

AnimationEvents

AnimationEvents: { End: string; Frame: string; Loop: string }

Type declaration

  • End: string
  • Frame: string
  • Loop: string

CameraEvents

CameraEvents: { Initialize: string; PostUpdate: string; PreUpdate: string }

Type declaration

  • Initialize: string
  • PostUpdate: string
  • PreUpdate: string

constClosestLineJumpTable

ClosestLineJumpTable: { CircleCircleClosestLine: any; CircleEdgeClosestLine: any; EdgeEdgeClosestLine: any; PolygonCircleClosestLine: any; PolygonEdgeClosestLine: any; PolygonPolygonClosestLine: any } = ...

Type declaration

constCollisionJumpTable

CollisionJumpTable: { CollideCircleCircle: any; CollideCircleEdge: any; CollideCirclePolygon: any; CollideEdgeEdge: any; CollidePolygonEdge: any; CollidePolygonPolygon: any; FindContactSeparation: any } = ...

Type declaration

constDefaultAntialiasOptions

DefaultAntialiasOptions: Required<AntialiasOptions> = ...

constDefaultGarbageCollectionOptions

DefaultGarbageCollectionOptions: GarbageCollectionOptions = ...

constDefaultPixelArtOptions

DefaultPixelArtOptions: Required<AntialiasOptions> = ...

DirectorEvents

DirectorEvents: { Navigation: navigation; NavigationEnd: navigationend; NavigationStart: navigationstart }

Type declaration

  • readonlyNavigation: navigation
  • readonlyNavigationEnd: navigationend
  • readonlyNavigationStart: navigationstart

constEX_VERSION

EX_VERSION: string = process.env.__EX_VERSION

The current Excalibur version string

@description

process.env.__EX_VERSION gets replaced by Webpack on build

EngineEvents

EngineEvents: { FallbackGraphicsContext: fallbackgraphicscontext; Hidden: hidden; Initialize: initialize; Navigation: navigation; NavigationEnd: navigationend; NavigationStart: navigationstart; PostDraw: postdraw; PostFrame: postframe; PostUpdate: postupdate; PreDraw: predraw; PreFrame: preframe; PreUpdate: preupdate; Start: start; Stop: stop; Visible: visible }

Type declaration

  • readonlyFallbackGraphicsContext: fallbackgraphicscontext
  • readonlyHidden: hidden
  • readonlyInitialize: initialize
  • readonlyNavigation: navigation
  • readonlyNavigationEnd: navigationend
  • readonlyNavigationStart: navigationstart
  • readonlyPostDraw: postdraw
  • readonlyPostFrame: postframe
  • readonlyPostUpdate: postupdate
  • readonlyPreDraw: predraw
  • readonlyPreFrame: preframe
  • readonlyPreUpdate: preupdate
  • readonlyStart: start
  • readonlyStop: stop
  • readonlyVisible: visible

EntityEvents

EntityEvents: { Add: add; Initialize: initialize; Kill: kill; PostUpdate: postupdate; PreUpdate: preupdate; Remove: remove }

Type declaration

  • readonlyAdd: add
  • readonlyInitialize: initialize
  • readonlyKill: kill
  • readonlyPostUpdate: postupdate
  • readonlyPreUpdate: preupdate
  • readonlyRemove: remove

constHorizontalFirst

HorizontalFirst: ContactBias = ...

Horizontal First contact solve bias Used by the ArcadeSolver to sort contacts

constImageSourceAttributeConstants

ImageSourceAttributeConstants: { Filtering: filtering; WrappingX: wrapping-x; WrappingY: wrapping-y } = ...

Type declaration

  • readonlyFiltering: filtering
  • readonlyWrappingX: wrapping-x
  • readonlyWrappingY: wrapping-y

LoaderEvents

LoaderEvents: { AfterLoad: string; BeforeLoad: string; LoadResourceEnd: string; LoadResourceStart: string; UserAction: string }

Type declaration

  • AfterLoad: string
  • BeforeLoad: string
  • LoadResourceEnd: string
  • LoadResourceStart: string
  • UserAction: string

constNone

None: ContactBias = ...

None value, ArcadeSolver sorts contacts using distance by default

ResourceEvents

ResourceEvents: { Complete: string; Error: string; Load: string; LoadStart: string; Progress: string }

Type declaration

  • Complete: string
  • Error: string
  • Load: string
  • LoadStart: string
  • Progress: string

SceneEvents

SceneEvents: { Activate: activate; Deactivate: deactivate; Initialize: initialize; PostDebugDraw: postdebugdraw; PostDraw: postdraw; PostUpdate: postupdate; PreDebugDraw: predebugdraw; PreDraw: predraw; PreLoad: preload; PreUpdate: preupdate; TransitionEnd: transitionend; TransitionStart: transitionstart }

Type declaration

  • readonlyActivate: activate
  • readonlyDeactivate: deactivate
  • readonlyInitialize: initialize
  • readonlyPostDebugDraw: postdebugdraw
  • readonlyPostDraw: postdraw
  • readonlyPostUpdate: postupdate
  • readonlyPreDebugDraw: predebugdraw
  • readonlyPreDraw: predraw
  • readonlyPreLoad: preload
  • readonlyPreUpdate: preupdate
  • readonlyTransitionEnd: transitionend
  • readonlyTransitionStart: transitionstart

ScreenEvents

ScreenEvents: { FullScreenChange: fullscreen; PixelRatioChange: pixelratio; ScreenResize: resize }

Type declaration

  • readonlyFullScreenChange: fullscreen
  • readonlyPixelRatioChange: pixelratio
  • readonlyScreenResize: resize

SoundEvents

SoundEvents: { Pause: string; PlaybackEnd: string; PlaybackStart: string; Processed: string; Resume: string; Stop: string; VolumeChange: string }

Type declaration

  • Pause: string
  • PlaybackEnd: string
  • PlaybackStart: string
  • Processed: string
  • Resume: string
  • Stop: string
  • VolumeChange: string

constSystemPriority

SystemPriority: { Average: 0; Higher: -5; Highest: number; Lower: 5; Lowest: number } = ...

Higher priorities run earlier than others in the system update

Type declaration

  • readonlyAverage: 0
  • readonlyHigher: -5
  • readonlyHighest: number
  • readonlyLower: 5
  • readonlyLowest: number

TileMapEvents

TileMapEvents: { PointerCancel: string; PointerDown: string; PointerMove: string; PointerUp: string; PostDraw: string; PostUpdate: string; PreDraw: string; PreUpdate: string }

Type declaration

  • PointerCancel: string
  • PointerDown: string
  • PointerMove: string
  • PointerUp: string
  • PostDraw: string
  • PostUpdate: string
  • PreDraw: string
  • PreUpdate: string

TriggerEvents

TriggerEvents: { EnterTrigger: string; ExitTrigger: string }

Type declaration

  • EnterTrigger: string
  • ExitTrigger: string

constTwoPI

TwoPI: number = ...

Two PI constant

constVerticalFirst

VerticalFirst: ContactBias = ...

Vertical First contact solve bias Used by the ArcadeSolver to sort contacts

constmaxMessages

maxMessages: 5 = 5

constpixelSnapEpsilon

pixelSnapEpsilon: 0.0001 = 0.0001
Page Options