ReadonlycameraThe Camera this effect belongs to.
The destination zoom value.
ReadonlydurationThe duration of the effect, in milliseconds.
The ease function to use during the zoom.
ReadonlyisIs this effect actively running?
If this effect is running this holds the current percentage of the progress, a value between 0 and 1.
The starting zoom value;
Destroys this effect, releasing it from the Camera.
Called internally when the effect completes.
Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
This effect will zoom the Camera to the given scale, over the duration and with the ease specified.
The target Camera zoom value.
Optionalduration: numberThe duration of the effect in milliseconds. Default 1000.
Optionalease: string | FunctionThe ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function. Default 'Linear'.
Optionalforce: booleanForce the zoom effect to start immediately, even if already running. Default false.
Optionalcallback: CameraZoomCallbackThis 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.
Optionalcontext: anyThe context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
The main update loop for this effect. Called automatically by the Camera.
The current timestamp as generated by the Request Animation Frame or SetTimeout.
The delta time, in ms, elapsed since the last frame.
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
onUpdatecallback, which is invoked each frame for the duration of the effect if required.