Class: Pan

Members

---

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

The Camera this effect belongs to.

Type:

• Phaser.Cameras.Scene2D.Camera

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 39)

---

current :Phaser.Math.Vector2

The constantly updated value based on zoom.

Type:

• Phaser.Math.Vector2

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 80)

---

destination :Phaser.Math.Vector2

The destination scroll coordinates to pan the camera to.

Type:

• Phaser.Math.Vector2

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 89)

---

<readonly> duration :number

The duration of the effect, in milliseconds.

Type:

• number

Since: 3.11.0

Default Value:

• 0

Source: src/cameras/2d/effects/Pan.js (Line 60)

---

ease :function

The ease function to use during the pan.

Type:

• function

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 98)

---

<readonly> isRunning :boolean

Is this effect actively running?

Type:

• boolean

Since: 3.11.0

Default Value:

• false

Source: src/cameras/2d/effects/Pan.js (Line 49)

---

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/Pan.js (Line 107)

---

source :Phaser.Math.Vector2

The starting scroll coordinates to pan the camera from.

Type:

• Phaser.Math.Vector2

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 71)

Methods

---

destroy()

Destroys this effect, releasing it from the Camera.

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 302)

---

effectComplete()

Called internally when the effect completes.

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 270)

Fires:

• Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE

---

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/Pan.js (Line 287)

---

start(x, y [, duration] [, ease] [, force] [, callback] [, context])

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	Argument	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.

Since: 3.11.0

Source: src/cameras/2d/effects/Pan.js (Line 148)

Fires:

• Phaser.Cameras.Scene2D.Events#event:PAN_START
• Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE

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/Pan.js (Line 217)