LesserPanda

Class: Camera

Camera

new Camera()

Camera with ability to follow, scale and shake.

Source:

Members

acceleration :Vector

Camera acceleration speed.

Type:
Default Value:
  • (3, 3)
Source:

anchor :Vector

Anchor of the camera

Type:
Default Value:
  • (0.5, 0.5)
Source:

container :Container

Container that the camera is added to.

Type:
  • Container
Source:

game :Game

Reference of the game added to.

Type:
Source:

isShaking :boolean

Whether the camera is currently shaking

Type:
  • boolean
Default Value:
  • false
Source:

maxSpeed :number

Camera maximum move speed.

Type:
  • number
Default Value:
  • 200
Source:

maxX :null|number

Camera position limit (right)

Type:
  • null | number
Default Value:
  • null
Source:

maxY :null|number

Camera position limit (down)

Type:
  • null | number
Default Value:
  • null
Source:

minX :null|number

Camera position limit (left)

Type:
  • null | number
Default Value:
  • null
Source:

minY :null|number

Camera position limit (up)

Type:
  • null | number
Default Value:
  • null
Source:

position :Vector

Camera position.

Type:
Default Value:
  • (0, 0)
Source:

rotation :number

Rotation of the camera.

Type:
  • number
Default Value:
  • 0
Source:

rounding :boolean

Use rounding on container position.

Type:
  • boolean
Default Value:
  • false
Source:

sensor :Object

Sensor box

Type:
  • Object
Source:

speed :Vector

Current speed of camera.

Type:
Source:

target :Sprite

The Sprite this camera follows.

Type:
Source:

threshold :number

Type:
  • number
Source:

zoom :Vector

Camera zoom.
(2, 2) => 2x
(0.5, 0.5) => 0.5x

Type:
Default Value:
  • (1, 1)
Source:

Methods

addTo(game, container)

Add camera to container.

Parameters:
Name Type Description
game Game

Which game to add to
container Container

Which container to add to
Source:
Returns:

This for chaining

Type
Camera

remove()

Remove camera from parent container.

Source:

setPosition(x, y)

Set position of the camera

Parameters:
Name Type Description
x Number

X coordinate
y Number

Y coordinate
Source:

setTarget(target, lerp)

Set target of camera.

Parameters:
Name Type Description
target DisplayObject

The object to follow
lerp Boolean

Whether lerp to target instead of reseting camera position
Source:

shake(force, duration, count, forward)

Shake camera

Parameters:
Name Type Description
force Vector | Number

Max shake distance in pixel
duration Number

How long will the camera shake
count Number

How many times will the camera shake
forward Boolean

ONLY shake forward or not
Source:

<protected> update(dt, delta)

Update method

Parameters:
Name Type Description
dt Number

Delta time in millisecond
delta Number

Delta time in second
Source:

Class: Camera

Camera

new Camera()

Source:

Members

acceleration :Vector

Camera acceleration speed.

Type:
Default Value:
  • (3, 3)
Source:

anchor :Vector

Anchor of the camera

Type:
Default Value:
  • (0.5, 0.5)
Source:

container :Container

Container that the camera is added to.

Type:
  • Container
Source:

game :Game

Reference of the game added to.

Type:
Source:

isShaking :boolean

Whether the camera is currently shaking

Type:
  • boolean
Default Value:
  • false
Source:

maxSpeed :number

Camera maximum move speed.

Type:
  • number
Default Value:
  • 200
Source:

maxX :null|number

Camera position limit (right)

Type:
  • null | number
Default Value:
  • null
Source:

maxY :null|number

Camera position limit (down)

Type:
  • null | number
Default Value:
  • null
Source:

minX :null|number

Camera position limit (left)

Type:
  • null | number
Default Value:
  • null
Source:

minY :null|number

Camera position limit (up)

Type:
  • null | number
Default Value:
  • null
Source:

position :Vector

Camera position.

Type:
Default Value:
  • (0, 0)
Source:

rotation :number

Rotation of the camera.

Type:
  • number
Default Value:
  • 0
Source:

rounding :boolean

Use rounding on container position.

Type:
  • boolean
Default Value:
  • false
Source:

sensor :Object

Sensor box

Type:
  • Object
Source:

speed :Vector

Current speed of camera.

Type:
Source:

target :Sprite

The Sprite this camera follows.

Type:
Source:

threshold :number

Type:
  • number
Source:

zoom :Vector

Camera zoom.
(2, 2) => 2x
(0.5, 0.5) => 0.5x

Type:
Default Value:
  • (1, 1)
Source:

Methods

addTo(game, container)

Add camera to container.

Parameters:
Name Type Description
game Game

Which game to add to
container Container

Which container to add to
Source:
Returns:

This for chaining

Type
Camera

remove()

Remove camera from parent container.

Source:

setPosition(x, y)

Set position of the camera

Parameters:
Name Type Description
x Number

X coordinate
y Number

Y coordinate
Source:

setTarget(target, lerp)

Set target of camera.

Parameters:
Name Type Description
target DisplayObject

The object to follow
lerp Boolean

Whether lerp to target instead of reseting camera position
Source:

shake(force, duration, count, forward)

Shake camera

Parameters:
Name Type Description
force Vector | Number

Max shake distance in pixel
duration Number

How long will the camera shake
count Number

How many times will the camera shake
forward Boolean

ONLY shake forward or not
Source:

<protected> update(dt, delta)

Update method

Parameters:
Name Type Description
dt Number

Delta time in millisecond
delta Number

Delta time in second
Source: