Filter
A Camera Pan effect.
This effect will scroll the Camera so that the center of its viewport finishes at the given destination, over the duration and with the ease specified.
Only the camera scroll is moved. None of the objects it is displaying are impacted, i.e. their positions do not change.
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 Pan(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 constantly updated value based on zoom.
Type:
Description:
The destination scroll coordinates to pan the camera to.
Type:
Description:
The duration of the effect, in milliseconds.
Type:
Description:
The ease function to use during the pan.
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 scroll coordinates to pan the camera from.
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 scroll the Camera so that the center of its viewport finishes at the given destination, over the duration and with the ease specified.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The destination x coordinate to scroll the center of the Camera viewport to. |
||
| y | number |
The destination y coordinate to scroll the center of the Camera viewport to. |
||
| duration | number | <optional> | 1000 |
The duration of the effect in milliseconds. |
| ease | string | function | <optional> | 'Linear' |
The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function. |
| force | boolean | <optional> | false |
Force the pan effect to start immediately, even if already running. |
| callback | Phaser.Types.Cameras.Scene2D.CameraPanCallback | <optional> |
This callback will be invoked every frame for the duration of the effect. It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, the current camera scroll x coordinate and the current camera scroll y coordinate. |
|
| 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. |