Class Camera

Cameras

Camera is the base class for all Excalibur cameras. Cameras are used to move around your game and set focus. They are used to determine what is "off screen" and can be used to scale the game.

Hierarchy

Class
- Camera

Implements

Index

Constructors

constructor

new Camera(): Camera
Returns Camera
Inherited from Class.constructor
- Defined in Class.ts:14

Properties

`Protected` _follow

_follow: Actor

`Protected` _isShaking

_isShaking: boolean = false

`Protected` _isZooming

_isZooming: boolean = false

acc

acc: Vector = Vector.Zero

Get or set the camera's acceleration

az

az: number = 0

Get or set zoom acceleration

dz

dz: number = 0

Get or set rate of change in zoom, defaults to 0

eventDispatcher

eventDispatcher: EventDispatcher<any>

Direct access to the game object event dispatcher.

inverse

inverse: AffineMatrix = ...

rotation

rotation: number = 0

Current rotation of the camera

strategy

strategy: StrategyContainer = ...

transform

transform: AffineMatrix = ...

vel

vel: Vector = Vector.Zero

Get or set the camera's velocity

Accessors

angularVelocity

get angularVelocity(): number
Get or set the camera's angular velocity

Returns number
- Defined in Camera.ts:286
set angularVelocity(value: number): void
Parameters
- value: number
Returns void
- Defined in Camera.ts:290

ax

get ax(): number
Get or set the camera's x acceleration

Returns number
- Defined in Camera.ts:405
set ax(value: number): void
Parameters
- value: number
Returns void
- Defined in Camera.ts:409

ay

get ay(): number
Get or set the camera's y acceleration

Returns number
- Defined in Camera.ts:416
set ay(value: number): void
Parameters
- value: number
Returns void
- Defined in Camera.ts:420

dx

get dx(): number
Get or set the camera's x velocity

Returns number
- Defined in Camera.ts:383
set dx(value: number): void
Parameters
- value: number
Returns void
- Defined in Camera.ts:387

dy

get dy(): number
Get or set the camera's y velocity

Returns number
- Defined in Camera.ts:394
set dy(value: number): void
Parameters
- value: number
Returns void
- Defined in Camera.ts:398

isInitialized

get isInitialized(): boolean
Returns boolean
- Defined in Camera.ts:586

pos

get pos(): Vector
Returns Vector
- Defined in Camera.ts:299
set pos(vec: Vector): void
Parameters
- vec: Vector
Returns void
- Defined in Camera.ts:302

viewport

get viewport(): BoundingBox
Gets the bounding box of the viewport of this camera in world coordinates

Returns BoundingBox
- Defined in Camera.ts:512

x

get x(): number
Get the camera's x position

Returns number
- Defined in Camera.ts:351
set x(value: number): void
Set the camera's x position (cannot be set when following an Actor or when moving)
Parameters
- value: number
Returns void
- Defined in Camera.ts:358

y

get y(): number
Get the camera's y position

Returns number
- Defined in Camera.ts:367
set y(value: number): void
Set the camera's y position (cannot be set when following an Actor or when moving)
Parameters
- value: number
Returns void
- Defined in Camera.ts:374

zoom

get zoom(): number
Returns number
- Defined in Camera.ts:256
set zoom(val: number): void
Parameters
- val: number
Returns void
- Defined in Camera.ts:260

Methods

_initialize

_initialize(_engine: Engine): void
Parameters
- _engine: Engine
Returns void
- Defined in Camera.ts:590

_postupdate

_postupdate(engine: Engine, delta: number): void
Internal
It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPostUpdate lifecycle event
Parameters
- engine: Engine
- delta: number
Returns void
- Defined in Camera.ts:569

_preupdate

_preupdate(engine: Engine, delta: number): void
Internal
It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPreUpdate lifecycle event
Parameters
- engine: Engine
- delta: number
Returns void
- Defined in Camera.ts:549

addStrategy

addStrategy<T>(cameraStrategy: CameraStrategy<T>): void
Adds a new camera strategy to this camera
Type Parameters
- T
Parameters
- cameraStrategy: CameraStrategy<T>
  
  Instance of an CameraStrategy
Returns void
- Defined in Camera.ts:524

clearAllStrategies

clearAllStrategies(): void
Clears all camera strategies from the camera

Returns void
- Defined in Camera.ts:539

draw

draw(ctx: ExcaliburGraphicsContext): void
Applies the relevant transformations to the game canvas to "move" or apply effects to the Camera
Parameters
- ctx: ExcaliburGraphicsContext
  
  Canvas context to apply transformations
Returns void
- Defined in Camera.ts:760

emit

emit(eventName: string, eventObject: any): void
Emits a new event
Parameters
- eventName: string
  
  Name of the event to emit
- eventObject: any
  
  Data associated with this event
Returns void
Inherited from Class.emit
- Defined in Class.ts:45

getFocus

getFocus(): Vector
Returns the focal point of the camera, a new point giving the x and y position of the camera

Returns Vector
- Defined in Camera.ts:427

move

move(pos: Vector, duration: number, easingFn??: Util.EasingFunction): Promise<Vector>
This moves the camera focal point to the specified position using specified easing function. Cannot move when following an Actor.

Returns
A Promise that resolves when movement is finished, including if it's interrupted. The Promise value is the Vector of the target position. It will be rejected if a move cannot be made.
Parameters
- pos: Vector
  
  The target position to move to
- duration: number
  
  The duration in milliseconds the move should last
- Optional easingFn: Util.EasingFunction = EasingFunctions.EaseInOutCubic
  
  An optional easing function (ex.EasingFunctions.EaseInOutCubic by default)
Returns Promise<Vector>
- Defined in Camera.ts:440

off

off(eventName: "initialize", handler?: ((event: Events.InitializeEvent<Entity>) => void)): void
Alias for removeEventListener. If only the eventName is specified it will remove all handlers registered for that specific event. If the eventName and the handler instance are specified only that handler will be removed.
Parameters
- eventName: "initialize"
  
  Name of the event to listen for
- Optional handler: ((event: Events.InitializeEvent<Entity>) => void)
  
  Event handler for the thrown event
  - - (event: Events.InitializeEvent<Entity>): void
    - Parameters
      
      event: Events.InitializeEvent<Entity>
      
      Returns void
Returns void
Implementation of CanInitialize.off

Overrides Class.off
- Defined in Camera.ts:649
off(eventName: "preupdate", handler?: ((event: Events.PreUpdateEvent<Entity>) => void)): void
Parameters
- eventName: "preupdate"
- Optional handler: ((event: Events.PreUpdateEvent<Entity>) => void)
  - - (event: Events.PreUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PreUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.off

Overrides Class.off
- Defined in Camera.ts:650
off(eventName: "postupdate", handler?: ((event: Events.PostUpdateEvent<Entity>) => void)): void
Parameters
- eventName: "postupdate"
- Optional handler: ((event: Events.PostUpdateEvent<Entity>) => void)
  - - (event: Events.PostUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PostUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.off

Overrides Class.off
- Defined in Camera.ts:651
off(eventName: string, handler: ((event: Events.GameEvent<Camera, Camera>) => void)): void
Parameters
- eventName: string
- handler: ((event: Events.GameEvent<Camera, Camera>) => void)
  - - (event: Events.GameEvent<Camera, Camera>): void
    - Parameters
      
      event: Events.GameEvent<Camera, Camera>
      
      Returns void
Returns void
Implementation of CanUpdate.off

Overrides Class.off
- Defined in Camera.ts:652

on

on(eventName: "initialize", handler: ((event: Events.InitializeEvent<Entity>) => void)): void
Event signature
Parameters
- eventName: "initialize"
- handler: ((event: Events.InitializeEvent<Entity>) => void)
  - - (event: Events.InitializeEvent<Entity>): void
    - Parameters
      
      event: Events.InitializeEvent<Entity>
      
      Returns void
Returns void
Implementation of CanInitialize.on

Overrides Class.on
- Defined in Camera.ts:642
on(eventName: "preupdate", handler: ((event: Events.PreUpdateEvent<Entity>) => void)): void
Event signatures
Parameters
- eventName: "preupdate"
- handler: ((event: Events.PreUpdateEvent<Entity>) => void)
  - - (event: Events.PreUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PreUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.on

Overrides Class.on
- Defined in Camera.ts:643
on(eventName: "postupdate", handler: ((event: Events.PostUpdateEvent<Entity>) => void)): void
Parameters
- eventName: "postupdate"
- handler: ((event: Events.PostUpdateEvent<Entity>) => void)
  - - (event: Events.PostUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PostUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.on

Overrides Class.on
- Defined in Camera.ts:644

onInitialize

onInitialize(_engine: Engine): void
Safe to override onPostUpdate lifecycle event handler. Synonymous with .on('preupdate', (evt) =>{...})

onPostUpdate is called directly after a scene is updated.
Parameters
- _engine: Engine
Returns void
Implementation of CanInitialize.onInitialize
- Defined in Camera.ts:638

onPostUpdate

onPostUpdate(_engine: Engine, _delta: number): void
Safe to override onPostUpdate lifecycle event handler. Synonymous with .on('preupdate', (evt) =>{...})

onPostUpdate is called directly after a scene is updated.
Parameters
- _engine: Engine
- _delta: number
Returns void
Implementation of CanUpdate.onPostUpdate
- Defined in Camera.ts:579

onPreUpdate

onPreUpdate(_engine: Engine, _delta: number): void
Safe to override onPreUpdate lifecycle event handler. Synonymous with .on('preupdate', (evt) =>{...})

onPreUpdate is called directly before a scene is updated.
Parameters
- _engine: Engine
- _delta: number
Returns void
Implementation of CanUpdate.onPreUpdate
- Defined in Camera.ts:559

once

once(eventName: "initialize", handler: ((event: Events.InitializeEvent<Entity>) => void)): void
Once listens to an event one time, then unsubscribes from that event
Parameters
- eventName: "initialize"
  
  The name of the event to subscribe to once
- handler: ((event: Events.InitializeEvent<Entity>) => void)
  
  The handler of the event that will be auto unsubscribed
  - - (event: Events.InitializeEvent<Entity>): void
    - Parameters
      
      event: Events.InitializeEvent<Entity>
      
      Returns void
Returns void
Implementation of CanInitialize.once

Overrides Class.once
- Defined in Camera.ts:657
once(eventName: "preupdate", handler: ((event: Events.PreUpdateEvent<Entity>) => void)): void
Parameters
- eventName: "preupdate"
- handler: ((event: Events.PreUpdateEvent<Entity>) => void)
  - - (event: Events.PreUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PreUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.once

Overrides Class.once
- Defined in Camera.ts:658
once(eventName: "postupdate", handler: ((event: Events.PostUpdateEvent<Entity>) => void)): void
Parameters
- eventName: "postupdate"
- handler: ((event: Events.PostUpdateEvent<Entity>) => void)
  - - (event: Events.PostUpdateEvent<Entity>): void
    - Parameters
      
      event: Events.PostUpdateEvent<Entity>
      
      Returns void
Returns void
Implementation of CanUpdate.once

Overrides Class.once
- Defined in Camera.ts:659
once(eventName: string, handler: ((event: Events.GameEvent<Camera, Camera>) => void)): void
Parameters
- eventName: string
- handler: ((event: Events.GameEvent<Camera, Camera>) => void)
  - - (event: Events.GameEvent<Camera, Camera>): void
    - Parameters
      
      event: Events.GameEvent<Camera, Camera>
      
      Returns void
Returns void
Implementation of CanUpdate.once

Overrides Class.once
- Defined in Camera.ts:660

removeStrategy

removeStrategy<T>(cameraStrategy: CameraStrategy<T>): void
Removes a camera strategy by reference
Type Parameters
- T
Parameters
- cameraStrategy: CameraStrategy<T>
  
  Instance of an CameraStrategy
Returns void
- Defined in Camera.ts:532

runStrategies

runStrategies(engine: Engine, delta: number): void
Parameters
- engine: Engine
- delta: number
Returns void
- Defined in Camera.ts:665

shake

shake(magnitudeX: number, magnitudeY: number, duration: number): void
Sets the camera to shake at the specified magnitudes for the specified duration
Parameters
- magnitudeX: number
  
  The x magnitude of the shake
- magnitudeY: number
  
  The y magnitude of the shake
- duration: number
  
  The duration of the shake in milliseconds
Returns void
- Defined in Camera.ts:474

update

update(_engine: Engine, delta: number): void
Parameters
- _engine: Engine
- delta: number
Returns void
- Defined in Camera.ts:681

updateTransform

updateTransform(): void
Returns void
- Defined in Camera.ts:764

updateViewport

updateViewport(): void
Returns void
- Defined in Camera.ts:671

zoomOverTime

zoomOverTime(scale: number, duration?: number, easingFn?: Util.EasingFunction): Promise<boolean>
Zooms the camera in or out by the specified scale over the specified duration. If no duration is specified, it take effect immediately.
Parameters
- scale: number
  
  The scale of the zoom
- duration: number = 0
  
  The duration of the zoom in milliseconds
- easingFn: Util.EasingFunction = EasingFunctions.EaseInOutCubic
Returns Promise<boolean>
- Defined in Camera.ts:487

Class Camera

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Camera

Properties

Protected _follow

Protected _isShaking

Protected _isZooming

acc

az

dz

eventDispatcher

inverse

rotation

strategy

transform

vel

Accessors

angularVelocity

Returns number

Parameters

value: number

Returns void

ax

Returns number

Parameters

value: number

Returns void

ay

Returns number

Parameters

value: number

Returns void

dx

Returns number

Parameters

value: number

Returns void

dy

Returns number

Parameters

value: number

Returns void

isInitialized

Returns boolean

pos

Returns Vector

Parameters

vec: Vector

Returns void

viewport

Returns BoundingBox

x

Returns number

Parameters

value: number

Returns void

y

Returns number

Parameters

value: number

Returns void

zoom

Returns number

Parameters

val: number

Returns void

Methods

_initialize

Parameters

_engine: Engine

Returns void

_postupdate

`Protected` _follow

`Protected` _isShaking

`Protected` _isZooming

`Optional` easingFn: Util.EasingFunction = EasingFunctions.EaseInOutCubic

`Optional` handler: ((event: Events.InitializeEvent<Entity>) => void)

`Optional` handler: ((event: Events.PreUpdateEvent<Entity>) => void)

`Optional` handler: ((event: Events.PostUpdateEvent<Entity>) => void)