Skip to main content

excalibur

Index

Classes

Enumerations

Functions

Interfaces

Namespaces

Type Aliases

Variables

Type Aliases

activate

activate: activate

ActorArgs

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

Actor constructor options

add

add: add

AnyString

AnyString: {} & string

axis

axis: axis

BodyConfig

BodyConfig: DeepRequired<Pick<PhysicsConfig, bodies>[bodies]>

button

button: button

cancel

cancel: cancel

ColliderCreationData

ColliderCreationData: BoxColliderData | CircleColliderData | PolygonColliderData | EdgeColliderData | CompositeColliderData | CapsuleColliderData

ColliderType

ColliderType: box | polygon | circle | edge | capsule | composite

collisionend

collisionend: collisionend

collisionstart

collisionstart: collisionstart

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

CompositeStrategy

CompositeStrategy: separate | together

connect

connect: connect

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>

deactivate

deactivate: deactivate

DestinationSize

DestinationSize:

height

height: number

width

width: number

disconnect

disconnect: disconnect

DistributeEntity

DistributeEntity<T>: T extends infer U ? Entity<U> : never

Turns Entity<A | B> into Entity<A> | Entity<B>

Type parameters

  • T

down

down: down

Easing

Easing: (currentTime: number, ...args: number[]) => number

Type declaration

    • (currentTime: number, ...args: number[]): number

    • Parameters

      • currentTime: number

        time value between 0 and 1

      • rest...args: number[]

      Returns number

      scale of the final value between 0 and 1

enter

enter: enter

entertrigger

entertrigger: enter

enterviewport

enterviewport: enterviewport

EventKey

EventKey<T>: string & keyof T

Type parameters

EventMap

EventMap: Record<string, any>

exittrigger

exittrigger: exit

exitviewport

exitviewport: exitviewport

ExResponseType

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

G_UUID

G_UUID: string & { __brand: unique symbol }

A unique identifier for a graph node or edge.

Handler

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

Type parameters

  • EventType

Type declaration

    • (event: EventType): void

    • Parameters

      • event: EventType

      Returns void

hidden

hidden: hidden

hold

hold: hold

HTMLImageSource

HTMLImageSource: HTMLImageElement | HTMLCanvasElement

Id

Id<T>:

Type parameters

  • T: string

type

type: T

value

value: number

initialize

initialize: initialize

kill

kill: kill

leave

leave: leave

LoaderConstructor

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

Type declaration

MaybeKnownComponent

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

Type parameters

  • Component
  • TKnownComponents

MaybeObserver

MaybeObserver<T>: Partial<Observer<T>>

Defines an interface for something that might be an observer if a notify() is present

Type parameters

  • T

move

move: move

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 }

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

PossibleChannels

PossibleChannels<TSoundManagerOptions>: TSoundManagerOptions extends SoundManagerOptions<infer Channels> ? Channels : never

Type parameters

  • TSoundManagerOptions

PossibleSounds

PossibleSounds<TSoundMangerOptions>: TSoundMangerOptions extends SoundManagerOptions ? Extract<keyof TSoundMangerOptions[sounds], string> : never

Type parameters

  • TSoundMangerOptions

PossibleStates

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

Type parameters

  • TMachine

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

QueryEntity

QueryEntity<TAllComponentCtors, TAnyComponentCtors>: [TAnyComponentCtors] extends [never] ? Entity<ComponentInstance<TAllComponentCtors>> : Entity<ComponentInstance<TAllComponentCtors>> | DistributeEntity<ComponentInstance<TAnyComponentCtors>>

Type parameters

release

release: release

remove

remove: remove

SceneConstructor

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

Type declaration

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

    • Parameters

      • rest...args: any[]

      Returns Scene

SceneMap

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

Type parameters

  • TKnownScenes: string = any

ScheduledCallbackTiming

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

ScheduleId

ScheduleId: number

Unique identifier for a scheduled callback

SourceView

SourceView:

height

height: number

width

width: number

x

x: number

y

y: number

start

start: start

stop

stop: stop

subscribe

subscribe: subscribe

UniformDictionary

UniformDictionary: Record<string, number | boolean | Vector | Color | AffineMatrix | Matrix | 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

unsubscribe

unsubscribe: unsubscribe

up

up: up

ViewportUnit

ViewportUnit: pixel | percent

visible

visible: visible

wheel

wheel: wheel

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

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

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

GamepadEvents

GamepadEvents: { GamepadAxis: string; GamepadButton: string; GamepadButtonDown: string; GamepadButtonUp: string; GamepadConnect: string; GamepadDisconnect: string }

Type declaration

  • GamepadAxis: string
  • GamepadButton: string
  • GamepadButtonDown: string
  • GamepadButtonUp: string
  • GamepadConnect: string
  • GamepadDisconnect: string

constgetDefaultPhysicsConfig

getDefaultPhysicsConfig: () => DeepRequired<PhysicsConfig> = ...

Type declaration

constHorizontalFirst

HorizontalFirst: ContactBias = ...

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

constImageSourceAttributeConstants

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

Type declaration

  • readonlyFiltering: filtering
  • readonlyForceUpload: forceUpload
  • 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

constmaxMessages

maxMessages: 5 = 5

constNone

None: ContactBias = ...

None value, ArcadeSolver sorts contacts using distance by default

constPauseComponentTag

PauseComponentTag: ex.paused = ...

constpixelSnapEpsilon

pixelSnapEpsilon: 0.0001 = 0.0001

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; Pause: pause; PostDebugDraw: postdebugdraw; PostDraw: postdraw; PostUpdate: postupdate; PreDebugDraw: predebugdraw; PreDraw: predraw; PreLoad: preload; PreUpdate: preupdate; Resume: resume; TransitionEnd: transitionend; TransitionStart: transitionstart }

Type declaration

  • readonlyActivate: activate
  • readonlyDeactivate: deactivate
  • readonlyInitialize: initialize
  • readonlyPause: pause
  • readonlyPostDebugDraw: postdebugdraw
  • readonlyPostDraw: postdraw
  • readonlyPostUpdate: postupdate
  • readonlyPreDebugDraw: predebugdraw
  • readonlyPreDraw: predraw
  • readonlyPreLoad: preload
  • readonlyPreUpdate: preupdate
  • readonlyResume: resume
  • 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

TimerEvents

TimerEvents: { Action: action; Cancel: cancel; Complete: complete; Pause: pause; Resume: resume; Start: start; Stop: stop }

Type declaration

  • readonlyAction: action
  • readonlyCancel: cancel
  • readonlyComplete: complete
  • readonlyPause: pause
  • readonlyResume: resume
  • readonlyStart: start
  • readonlyStop: stop

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

Page Options