Excalibur.js v0.25.1 API Documentation

Index

References

Namespaces

Classes

Interfaces

Variables

Functions

References

canonicalizeAngle

Re-exports canonicalizeAngle

clamp

Re-exports clamp

randomInRange

Re-exports randomInRange

randomIntInRange

Re-exports randomIntInRange

range

Re-exports range

toDegrees

Re-exports toDegrees

toRadians

Re-exports toRadians

Type aliases

AnimationEvents

AnimationEvents: { ended: Animation; frame: Frame; loop: Animation }

Type declaration

ended: Animation
frame: Frame
loop: Animation

CanvasPosition

CanvasPosition: string | AbsolutePosition

ComponentCtor

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

Type parameters

T: Component = Component

Type declaration

- new (...args: any[]): T
- Component Contructor Types
  
  Parameters
  - Rest ...args: any[]
  Returns T

ComponentStringType

ComponentStringType<T>: T extends Component<infer R> ? R : string

Plucks the string type out of a component type

Type parameters

ComponentType

ComponentType<ComponentToParse>: ComponentToParse extends Component<infer TypeName> ? TypeName : never

Type parameters

ComponentToParse

Constructor

Constructor<T>: {}

Type parameters

Type declaration

DestinationSize

DestinationSize: { height: number; width: number }

Type declaration

height: number
width: number

ExResponseType

HTMLImageSource

HTMLImageSource: HTMLImageElement | HTMLCanvasElement

Id

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

Type parameters

T: string

Type declaration

type: T
value: number

MaybeObserver

MaybeObserver<T>: Partial<Util.Observer<T>>

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

Type parameters

SourceView

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

Type declaration

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

SystemTypes

SystemTypes<ComponentTypes>: ComponentTypes extends Component<infer TypeName> ? TypeName : never

Type parameters

ComponentTypes

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"

unsubscribe

unsubscribe: "unsubscribe"

up

up: "up"

visible

visible: "visible"

wheel

wheel: "wheel"

Variables

ClosestLineJumpTable

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

Type declaration

CircleCircleClosestLine:function
- CircleCircleClosestLine(circleA: CircleCollider, circleB: CircleCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:189
  Parameters
  - circleA: CircleCollider
  - circleB: CircleCollider
  Returns Line
CircleEdgeClosestLine:function
- CircleEdgeClosestLine(circle: CircleCollider, edge: EdgeCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:206
  Parameters
  - circle: CircleCollider
  - edge: EdgeCollider
  Returns Line
EdgeEdgeClosestLine:function
- EdgeEdgeClosestLine(edgeA: EdgeCollider, edgeB: EdgeCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:235
  Parameters
  - edgeA: EdgeCollider
  - edgeB: EdgeCollider
  Returns Line
PolygonCircleClosestLine:function
- PolygonCircleClosestLine(polygon: PolygonCollider, circle: CircleCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:155
  Parameters
  - polygon: PolygonCollider
  - circle: CircleCollider
  Returns Line
PolygonEdgeClosestLine:function
- PolygonEdgeClosestLine(polygon: PolygonCollider, edge: EdgeCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:130
  Parameters
  - polygon: PolygonCollider
  - edge: EdgeCollider
  Returns Line
PolygonPolygonClosestLine:function
- PolygonPolygonClosestLine(polygonA: PolygonCollider, polygonB: PolygonCollider): Line
- - Defined in Collision/Colliders/ClosestLineJumpTable.ts:104
  Parameters
  - polygonA: PolygonCollider
  - polygonB: PolygonCollider
  Returns Line

CollisionJumpTable

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

Type declaration

CollideCircleCircle:function
- CollideCircleCircle(circleA: CircleCollider, circleB: CircleCollider): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:12
  Parameters
  - circleA: CircleCollider
  - circleB: CircleCollider
  Returns CollisionContact[]
CollideCircleEdge:function
- CollideCircleEdge(circle: CircleCollider, edge: EdgeCollider): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:71
  Parameters
  - circle: CircleCollider
  - edge: EdgeCollider
  Returns CollisionContact[]
CollideCirclePolygon:function
- CollideCirclePolygon(circle: CircleCollider, polygon: PolygonCollider): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:43
  Parameters
  - circle: CircleCollider
  - polygon: PolygonCollider
  Returns CollisionContact[]
CollideEdgeEdge:function
- CollideEdgeEdge(): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:185
  Returns CollisionContact[]
CollidePolygonEdge:function
- CollidePolygonEdge(polygon: PolygonCollider, edge: EdgeCollider): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:190
  Parameters
  - polygon: PolygonCollider
  - edge: EdgeCollider
  Returns CollisionContact[]
CollidePolygonPolygon:function
- CollidePolygonPolygon(polyA: PolygonCollider, polyB: PolygonCollider): CollisionContact[]
- - Defined in Collision/Colliders/CollisionJumpTable.ts:216
  Parameters
  - polyA: PolygonCollider
  - polyB: PolygonCollider
  Returns CollisionContact[]
FindContactSeparation:function
- FindContactSeparation(contact: CollisionContact, localPoint: Vector): number
- - Defined in Collision/Colliders/CollisionJumpTable.ts:280
  Parameters
  - contact: CollisionContact
  - localPoint: Vector
  Returns number

EX_VERSION

EX_VERSION: string = process.env.__EX_VERSION

The current Excalibur version string

description: process.env.__EX_VERSION gets replaced by Webpack on build

maxMessages

maxMessages: 5 = 5

Functions

ClosestLine

ClosestLine(p0: Vector, u: Vector, q0: Vector, v: Vector): Line

- Defined in Collision/Colliders/ClosestLineJumpTable.ts:17
Finds the closes line between 2 line segments, were the magnitude of u, v are the lengths of each segment L1 = P(s) = p0 + s * u, where s is time and p0 is the start of the line L2 = Q(t) = q0 + t * v, where t is time and q0 is the start of the line

Parameters
- p0: Vector
  
  Point where L1 begins
- u: Vector
  
  Direction and length of L1
- q0: Vector
  
  Point were L2 begins
- v: Vector
  
  Direction and length of L2
Returns Line

Configurable

Configurable<T>(base: T): T

- Defined in Configurable.ts:9
Configurable helper extends base type and makes all properties available as option bag arguments

internal
Type parameters
- T: Constructor<{}>
Parameters
- base: T
Returns T

createId

createId<T>(type: T, value: number): Id<T>

- Defined in Id.ts:9
Type parameters
- T: string
Parameters
- type: T
- value: number
Returns Id<T>

hasGraphicsTick

hasGraphicsTick(graphic: Graphic): graphic is Graphic & HasTick

- Defined in Graphics/GraphicsComponent.ts:13
Type guard for checking if a Graphic HasTick (used for graphics that change over time like animations)

Parameters
- graphic: Graphic
Returns graphic is Graphic & HasTick

hasOnInitialize

hasOnInitialize(a: any): a is OnInitialize

- Defined in Interfaces/LifecycleEvents.ts:26
Parameters
- a: any
Returns a is OnInitialize

hasOnPostUpdate

hasOnPostUpdate(a: any): a is OnPostUpdate

- Defined in Interfaces/LifecycleEvents.ts:72
Parameters
- a: any
Returns a is OnPostUpdate

hasOnPreUpdate

hasOnPreUpdate(a: any): a is OnPreUpdate

- Defined in Interfaces/LifecycleEvents.ts:49
Parameters
- a: any
Returns a is OnPreUpdate

hasPostDraw

hasPostDraw(a: any): a is OnPostDraw

- Defined in Interfaces/LifecycleEvents.ts:193
Parameters
- a: any
Returns a is OnPostDraw

hasPreDraw

hasPreDraw(a: any): a is OnPreDraw

- Defined in Interfaces/LifecycleEvents.ts:186
Parameters
- a: any
Returns a is OnPreDraw

has_initialize

has_initialize(a: any): a is _initialize

- Defined in Interfaces/LifecycleEvents.ts:15
Type guard checking for internal initialize method

internal
Parameters
- a: any
Returns a is _initialize

has_postupdate

has_postupdate(a: any): a is _postupdate

- Defined in Interfaces/LifecycleEvents.ts:61
Parameters
- a: any
Returns a is _postupdate

has_preupdate

has_preupdate(a: any): a is _preupdate

- Defined in Interfaces/LifecycleEvents.ts:38
Parameters
- a: any
Returns a is _preupdate

isAddedComponent

isAddedComponent(x: Util.Message<EntityComponent>): x is AddedComponent

- Defined in EntityComponentSystem/Entity.ts:30
Type guard to know if message is f an Added Component

Parameters
- x: Util.Message<EntityComponent>
Returns x is AddedComponent

isAddedSystemEntity

isAddedSystemEntity(x: Util.Message<Entity>): x is AddedEntity

- Defined in EntityComponentSystem/System.ts:110
Type guard to check for AddedEntity messages

Parameters
- x: Util.Message<Entity>
Returns x is AddedEntity

isRemoveSystemEntity

isRemoveSystemEntity(x: Util.Message<Entity>): x is RemovedEntity

- Defined in EntityComponentSystem/System.ts:125
type guard to check for the RemovedEntity message

Parameters
- x: Util.Message<Entity>
Returns x is RemovedEntity

isRemovedComponent

isRemovedComponent(x: Util.Message<EntityComponent>): x is RemovedComponent

- Defined in EntityComponentSystem/Entity.ts:45
Type guard to know if message is for a Removed Component

Parameters
- x: Util.Message<EntityComponent>
Returns x is RemovedComponent

obsolete

obsolete(options?: ObsoleteOptions): any

- Defined in Util/Decorators.ts:43
Obsolete decorator for marking Excalibur methods obsolete, you can optionally specify a custom message and/or alternate replacement method do the deprecated one. Inspired by https://github.com/jayphelps/core-decorators.js

Parameters
- Optional options: ObsoleteOptions
Returns any

Const resetObsoleteCounter

resetObsoleteCounter(): void

- Defined in Util/Decorators.ts:19
Returns void

vec

vec(x: number, y: number): Vector

- Defined in Math/vector.ts:372
Shorthand for creating new Vectors - returns a new Vector instance with the provided X and Y components.

Parameters
- x: number
  
  X component of the Vector
- y: number
  
  Y component of the Vector
Returns Vector

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

canonicalizeAngle

clamp

randomInRange

randomIntInRange

range

toDegrees

toRadians

Type aliases

AnimationEvents

Type declaration

ended: Animation

frame: Frame

loop: Animation

CanvasPosition

ComponentCtor

Type parameters

T: Component = Component

Type declaration

Parameters

Rest ...args: any[]

Returns T

ComponentStringType

Type parameters

T

ComponentType

Type parameters

ComponentToParse

Constructor

Type parameters

T

Type declaration

DestinationSize

Type declaration

height: number

width: number

ExResponseType

HTMLImageSource

Id

Type parameters

T: string

Type declaration

type: T

value: number

MaybeObserver

Type parameters

T

SourceView

Type declaration

height: number

width: number

x: number

y: number

SystemTypes

Type parameters

ComponentTypes

activate

axis

button

cancel

collisionend

collisionstart

connect

deactivate

disconnect

down

enter

entertrigger

enterviewport

exittrigger

exitviewport