Class Camera

constructor

• new Camera(): Camera

  Returns Camera

isActive

false
Copy

pos

• get pos(): { x: number; y: number }

  Gets the camera's position as a readonly {x, y} object that won't be updated if the camera moves. Useful for saving the camera's position at a specific moment in time.

  Returns { x: number; y: number }

• set pos(val: number[] | { x: number; y: number }): void

  The camera's position.

  Parameters

  • val: number[] | { x: number; y: number }

  Returns void

position

• get position(): Vector

  The camera's position vector.

  Returns Vector

• set position(val: number[] | { x: number; y: number }): void

  Parameters

  • val: number[] | { x: number; y: number }

  Returns void

x

• get x(): number

  The camera's x position.

  Returns number

• set x(val: number): void

  Parameters

  • val: number

  Returns void

y

• get y(): number

  The camera's y position.

  Returns number

• set y(val: number): void

  Parameters

  • val: number

  Returns void

zoom

• get zoom(): number

  Camera zoom.

  A scale of 1 will be the normal size. Setting it to 2 will make everything appear twice as big. .5 will make everything look half size.

  Returns number

  Default

  1
  Copy

• set zoom(val: number): void

  Parameters

  • val: number

  Returns void

moveTo

• moveTo(x: number, y: number, speed: number): Promise<boolean>

  Moves the camera to a position.

  Parameters

  • x: number
  • y: number
  • speed: number

  Returns Promise<boolean>

  resolves true when the camera reaches the target position

off

• off(): void

  Deactivates the camera.

  The canvas will be drawn normally, ignoring the camera's position and scale until camera.on() is called.

  Returns void

on

• on(): void

  Activates the camera.

  The canvas will be drawn according to the camera position and scale until camera.off() is called.

  Returns void

zoomTo

• zoomTo(target: number, speed: number): Promise<boolean>

  Zoom the camera at a given speed.

  Parameters

  • target: number

    The target zoom

  • speed: number

    The amount of zoom per frame

  Returns Promise<boolean>

  resolves true when the camera reaches the target zoom