Camera | Excalibur.js Edge API Documentation

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

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

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
set angularVelocity(value: number): void

- Defined in Camera.ts:286
Get or set the camera's angular velocity

Returns number
- Defined in Camera.ts:290
Get or set the camera's angular velocity

Parameters
- value: number
Returns void

ax

get ax(): number
set ax(value: number): void

- Defined in Camera.ts:405
Get or set the camera's x acceleration

Returns number
- Defined in Camera.ts:409
Get or set the camera's x acceleration

Parameters
- value: number
Returns void

ay

get ay(): number
set ay(value: number): void

- Defined in Camera.ts:416
Get or set the camera's y acceleration

Returns number
- Defined in Camera.ts:420
Get or set the camera's y acceleration

Parameters
- value: number
Returns void

dx

get dx(): number
set dx(value: number): void

- Defined in Camera.ts:383
Get or set the camera's x velocity

Returns number
- Defined in Camera.ts:387
Get or set the camera's x velocity

Parameters
- value: number
Returns void

dy

get dy(): number
set dy(value: number): void

- Defined in Camera.ts:394
Get or set the camera's y velocity

Returns number
- Defined in Camera.ts:398
Get or set the camera's y velocity

Parameters
- value: number
Returns void

isInitialized

get isInitialized(): boolean

- Defined in Camera.ts:586
Returns boolean

pos

get pos(): Vector
set pos(vec: Vector): void

- Defined in Camera.ts:299
Returns Vector
- Defined in Camera.ts:302
Parameters
- vec: Vector
Returns void

viewport

get viewport(): BoundingBox

- Defined in Camera.ts:512
Gets the bounding box of the viewport of this camera in world coordinates

Returns BoundingBox

x

get x(): number
set x(value: number): void

- Defined in Camera.ts:351
Get the camera's x position

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

Parameters
- value: number
Returns void

y

get y(): number
set y(value: number): void

- Defined in Camera.ts:367
Get the camera's y position

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

Parameters
- value: number
Returns void

zoom

get zoom(): number
set zoom(val: number): void

- Defined in Camera.ts:256
Returns number
- Defined in Camera.ts:260
Parameters
- val: number
Returns void

Methods

_initialize

_initialize(_engine: Engine): void

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

_postupdate

_postupdate(engine: Engine, delta: number): void

- Defined in Camera.ts:569
It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPostUpdate lifecycle event

internal
Parameters
- engine: Engine
- delta: number
Returns void

_preupdate

_preupdate(engine: Engine, delta: number): void

- Defined in Camera.ts:549
It is not recommended that internal excalibur methods be overridden, do so at your own risk.

Internal _preupdate handler for onPreUpdate lifecycle event

internal
Parameters
- engine: Engine
- delta: number
Returns void

addStrategy

addStrategy<T>(cameraStrategy: CameraStrategy<T>): void

- Defined in Camera.ts:524
Adds a new camera strategy to this camera

Type Parameters
- T
Parameters
- cameraStrategy: CameraStrategy<T>
  
  Instance of an CameraStrategy
Returns void

clearAllStrategies

clearAllStrategies(): void

- Defined in Camera.ts:539
Clears all camera strategies from the camera

Returns void

draw

draw(ctx: ExcaliburGraphicsContext): void

- Defined in Camera.ts:760
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

emit

emit(eventName: string, eventObject: any): void

Inherited from Class.emit
- Defined in Class.ts:45
Emits a new event

Parameters
- eventName: string
  
  Name of the event to emit
- eventObject: any
  
  Data associated with this event
Returns void

getFocus

getFocus(): Vector

- Defined in Camera.ts:427
Returns the focal point of the camera, a new point giving the x and y position of the camera

Returns Vector

move

move(pos: Vector, duration: number, easingFn?: Util.EasingFunction): Promise<Vector>

- Defined in Camera.ts:440
This moves the camera focal point to the specified position using specified easing function. Cannot move when following an Actor.

Parameters
- pos: Vector
  
  The target position to move to
- duration: number
  
  The duration in milliseconds the move should last
- easingFn: Util.EasingFunction = EasingFunctions.EaseInOutCubic
Returns Promise<Vector>
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.

off

off(eventName: "initialize", handler?: ((event: Events.InitializeEvent<Entity>) => void)): void
off(eventName: "preupdate", handler?: ((event: Events.PreUpdateEvent<Entity>) => void)): void
off(eventName: "postupdate", handler?: ((event: Events.PostUpdateEvent<Entity>) => void)): void
off(eventName: string, handler: ((event: Events.GameEvent<Camera, Camera>) => void)): void

Implementation of CanInitialize.off
Overrides Class.off
- Defined in Camera.ts:649
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"
- Optional handler: ((event: Events.InitializeEvent<Entity>) => void)
  - - (event: Events.InitializeEvent<Entity>): void
    - Parameters
      - event: Events.InitializeEvent<Entity>
      Returns void
Returns void
Implementation of CanUpdate.off
Overrides Class.off
- Defined in Camera.ts:650
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:651
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:652
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

on

on(eventName: "initialize", handler: ((event: Events.InitializeEvent<Entity>) => void)): void
on(eventName: "preupdate", handler: ((event: Events.PreUpdateEvent<Entity>) => void)): void
on(eventName: "postupdate", handler: ((event: Events.PostUpdateEvent<Entity>) => void)): void

Implementation of CanInitialize.on
Overrides Class.on
- Defined in Camera.ts:642
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 CanUpdate.on
Overrides Class.on
- Defined in Camera.ts:643
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:644
Parameters
- eventName: "postupdate"
- handler: ((event: Events.PostUpdateEvent<Entity>) => void)
  - - (event: Events.PostUpdateEvent<Entity>): void
    - Parameters
      - event: Events.PostUpdateEvent<Entity>
      Returns void
Returns void

onInitialize

onInitialize(_engine: Engine): void

Implementation of CanInitialize.onInitialize
- Defined in Camera.ts:638
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

onPostUpdate

onPostUpdate(_engine: Engine, _delta: number): void

Implementation of CanUpdate.onPostUpdate
- Defined in Camera.ts:579
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

onPreUpdate

onPreUpdate(_engine: Engine, _delta: number): void

Implementation of CanUpdate.onPreUpdate
- Defined in Camera.ts:559
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

once

once(eventName: "initialize", handler: ((event: Events.InitializeEvent<Entity>) => void)): void
once(eventName: "preupdate", handler: ((event: Events.PreUpdateEvent<Entity>) => void)): void
once(eventName: "postupdate", handler: ((event: Events.PostUpdateEvent<Entity>) => void)): void
once(eventName: string, handler: ((event: Events.GameEvent<Camera, Camera>) => void)): void

Implementation of CanInitialize.once
Overrides Class.once
- Defined in Camera.ts:657
Once listens to an event one time, then unsubscribes from that event

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 CanUpdate.once
Overrides Class.once
- Defined in Camera.ts:658
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:659
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:660
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

removeStrategy

removeStrategy<T>(cameraStrategy: CameraStrategy<T>): void

- Defined in Camera.ts:532
Removes a camera strategy by reference

Type Parameters
- T
Parameters
- cameraStrategy: CameraStrategy<T>
  
  Instance of an CameraStrategy
Returns void

runStrategies

runStrategies(engine: Engine, delta: number): void

- Defined in Camera.ts:665
Parameters
- engine: Engine
- delta: number
Returns void

shake

shake(magnitudeX: number, magnitudeY: number, duration: number): void

- Defined in Camera.ts:474
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

update

update(_engine: Engine, delta: number): void

- Defined in Camera.ts:681
Parameters
- _engine: Engine
- delta: number
Returns void

updateTransform

updateTransform(): void

- Defined in Camera.ts:764
Returns void

updateViewport

updateViewport(): void

- Defined in Camera.ts:671
Returns void

zoomOverTime

zoomOverTime(scale: number, duration?: number, easingFn?: Util.EasingFunction): Promise<boolean>

- Defined in Camera.ts:487
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>

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

Parameters