You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Class: Zoom

Phaser.Cameras.Scene2D.Effects. Zoom

A Camera Zoom effect.

This effect will zoom the Camera to the given scale, over the duration and with the ease specified.

The effect will dispatch several events on the Camera itself and you can also specify an onUpdate callback, which is invoked each frame for the duration of the effect if required.

new Zoom(camera)

Parameters:
Name Type Description
camera Phaser.Cameras.Scene2D.Camera

The camera this effect is acting upon.
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 12)

Members

<readonly> camera :Phaser.Cameras.Scene2D.Camera

The Camera this effect belongs to.

Type:
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 34)

destination :number

The destination zoom value.

Type:
  • number
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 75)

<readonly> duration :number

The duration of the effect, in milliseconds.

Type:
  • number
Since: 3.11.0
Default Value:
  • 0
Source: src/cameras/2d/effects/Zoom.js (Line 55)

ease :function

The ease function to use during the zoom.

Type:
  • function
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 84)

<readonly> isRunning :boolean

Is this effect actively running?

Type:
  • boolean
Since: 3.11.0
Default Value:
  • false
Source: src/cameras/2d/effects/Zoom.js (Line 44)

progress :number

If this effect is running this holds the current percentage of the progress, a value between 0 and 1.

Type:
  • number
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 93)

source :number

The starting zoom value;

Type:
  • number
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 66)

Methods

destroy()

Destroys this effect, releasing it from the Camera.

Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 272)

effectComplete()

Called internally when the effect completes.

Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 240)
Fires:

reset()

Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.

Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 257)

start(zoom [, duration] [, ease] [, force] [, callback] [, context])

This effect will zoom the Camera to the given scale, over the duration and with the ease specified.

Parameters:
Name Type Argument Default Description
zoom number

The target Camera zoom value.
duration number <optional>
 1000

The duration of the effect in milliseconds.
ease string | function <optional>
 'Linear'

The ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function.
force boolean <optional>
 false

Force the zoom effect to start immediately, even if already running.
callback Phaser.Types.Cameras.Scene2D.CameraZoomCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, and the current camera zoom value.
context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 134)
Fires:
Returns:

The Camera on which the effect was started.

Type
Phaser.Cameras.Scene2D.Camera

update(time, delta)

The main update loop for this effect. Called automatically by the Camera.

Parameters:
Name Type Description
time number

The current timestamp as generated by the Request Animation Frame or SetTimeout.
delta number

The delta time, in ms, elapsed since the last frame.
Since: 3.11.0
Source: src/cameras/2d/effects/Zoom.js (Line 198)