Filter
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.
Constructor:
new Zoom(camera)
Parameters:
| name | type | description |
|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera |
The camera this effect is acting upon. |
Members
Description:
The Camera this effect belongs to.
Description:
The destination zoom value.
Type:
Description:
The duration of the effect, in milliseconds.
Type:
Description:
The ease function to use during the zoom.
Type:
Description:
Is this effect actively running?
Type:
Description:
If this effect is running this holds the current percentage of the progress, a value between 0 and 1.
Type:
Description:
The starting zoom value;
Type:
Methods
Description:
Destroys this effect, releasing it from the Camera.
Description:
Called internally when the effect completes.
Description:
Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
Description:
This effect will zoom the Camera to the given scale, over the duration and with the ease specified.
Parameters:
| name | type | arguments | 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. |
Returns:
Description:
The Camera on which the effect was started.
Description:
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. |