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.
| 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. |
The Camera on which the effect was started.