Phaser API Documentation

  Version: 
Event: PAN_START
Phaser.Cameras.Scene2D.Events.PAN_START
PAN_START

Description:

The Camera Pan Start Event.

This event is dispatched by a Camera instance when the Pan Effect starts.

Listen for it via either of the following:

this.cameras.main.on('camerapanstart', () => {});

or use the constant, to avoid having to remember the correct event string:

this.cameras.main.on(Phaser.Cameras.Scene2D.Events.PAN_START, () => {});

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The camera that the effect began on.

effect Phaser.Cameras.Scene2D.Effects.Pan

A reference to the effect instance.

duration number

The duration of the effect.

x number

The destination scroll x coordinate.

y number

The destination scroll y coordinate.

Since: 3.3.0