Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Events
Phaser.Scenes.Events
Source: src/scene/events/index.js (Line 7)

Events

ADDED_TO_SCENE
Focus
Focus

Description:

The Game Object Added to Scene Event.

This event is dispatched when a Game Object is added to a Scene.

Listen for it from a Scene using this.events.on('addedtoscene', listener).

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was added to the Scene.

scene Phaser.Scene

The Scene to which the Game Object was added.

Since: 3.50.0
Focus
Focus
BOOT
Focus
Focus

Description:

The Scene Systems Boot Event.

This event is dispatched by a Scene during the Scene Systems boot process. Primarily used by Scene Plugins.

Listen to it from a Scene using this.events.on('boot', listener).

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

Since: 3.0.0
Focus
Focus
CREATE
Focus
Focus

Description:

The Scene Create Event.

This event is dispatched by a Scene after it has been created by the Scene Manager.

If a Scene has a create method then this event is emitted after that has run.

If there is a transition, this event will be fired after the TRANSITION_START event.

Listen to it from a Scene using this.events.on('create', listener).

Parameters:

name type description
scene Phaser.Scene

A reference to the Scene that emitted this event.

Since: 3.17.0
Focus
Focus
DESTROY
Focus
Focus

Description:

The Scene Systems Destroy Event.

This event is dispatched by a Scene during the Scene Systems destroy process.

Listen to it from a Scene using this.events.on('destroy', listener).

You should destroy any resources that may be in use by your Scene in this event handler.

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

Since: 3.0.0
Focus
Focus
PAUSE
Focus
Focus

Description:

The Scene Systems Pause Event.

This event is dispatched by a Scene when it is paused, either directly via the pause method, or as an action from another Scene.

Listen to it from a Scene using this.events.on('pause', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was paused.

Since: 3.0.0
Focus
Focus
POST_UPDATE
Focus
Focus

Description:

The Scene Systems Post Update Event.

This event is dispatched by a Scene during the main game loop step.

The event flow for a single step of a Scene is as follows:

  1. PRE_UPDATE
  2. UPDATE
  3. The Scene.update method is called, if it exists
  4. POST_UPDATE
  5. PRE_RENDER
  6. RENDER

Listen to it from a Scene using this.events.on('postupdate', listener).

A Scene will only run its step if it is active.

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

time number

The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.

delta number

The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Since: 3.0.0
Focus
Focus
PRE_RENDER
Focus
Focus

Description:

The Scene Systems Pre-Render Event.

This event is dispatched by a Scene during the main game loop step.

The event flow for a single step of a Scene is as follows:

  1. PRE_UPDATE
  2. UPDATE
  3. The Scene.update method is called, if it exists
  4. POST_UPDATE
  5. PRE_RENDER
  6. RENDER

Listen to this event from a Scene using this.events.on('prerender', listener).

A Scene will only render if it is visible.

This event is dispatched after the Scene Display List is sorted and before the Scene is rendered.

Parameters:

name type description
renderer Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer

The renderer that rendered the Scene.

Since: 3.53.0
Focus
Focus
PRE_UPDATE
Focus
Focus

Description:

The Scene Systems Pre Update Event.

This event is dispatched by a Scene during the main game loop step.

The event flow for a single step of a Scene is as follows:

  1. PRE_UPDATE
  2. UPDATE
  3. The Scene.update method is called, if it exists
  4. POST_UPDATE
  5. PRE_RENDER
  6. RENDER

Listen to it from a Scene using this.events.on('preupdate', listener).

A Scene will only run its step if it is active.

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

time number

The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.

delta number

The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Since: 3.0.0
Focus
Focus
READY
Focus
Focus

Description:

The Scene Systems Ready Event.

This event is dispatched by a Scene during the Scene Systems start process. By this point in the process the Scene is now fully active and rendering. This event is meant for your game code to use, as all plugins have responded to the earlier 'start' event.

Listen to it from a Scene using this.events.on('ready', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was started.

Since: 3.0.0
Focus
Focus
REMOVED_FROM_SCENE
Focus
Focus

Description:

The Game Object Removed from Scene Event.

This event is dispatched when a Game Object is removed from a Scene.

Listen for it from a Scene using this.events.on('removedfromscene', listener).

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was removed from the Scene.

scene Phaser.Scene

The Scene from which the Game Object was removed.

Since: 3.50.0
Focus
Focus
RENDER
Focus
Focus

Description:

The Scene Systems Render Event.

This event is dispatched by a Scene during the main game loop step.

The event flow for a single step of a Scene is as follows:

  1. PRE_UPDATE
  2. UPDATE
  3. The Scene.update method is called, if it exists
  4. POST_UPDATE
  5. PRE_RENDER
  6. RENDER

Listen to it from a Scene using this.events.on('render', listener).

A Scene will only render if it is visible.

By the time this event is dispatched, the Scene will have already been rendered.

Parameters:

name type description
renderer Phaser.Renderer.Canvas.CanvasRenderer | Phaser.Renderer.WebGL.WebGLRenderer

The renderer that rendered the Scene.

Since: 3.0.0
Focus
Focus
RESUME
Focus
Focus

Description:

The Scene Systems Resume Event.

This event is dispatched by a Scene when it is resumed from a paused state, either directly via the resume method, or as an action from another Scene.

Listen to it from a Scene using this.events.on('resume', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was resumed.

Since: 3.0.0
Focus
Focus
SHUTDOWN
Focus
Focus

Description:

The Scene Systems Shutdown Event.

This event is dispatched by a Scene during the Scene Systems shutdown process.

Listen to it from a Scene using this.events.on('shutdown', listener).

You should free-up any resources that may be in use by your Scene in this event handler, on the understanding that the Scene may, at any time, become active again. A shutdown Scene is not 'destroyed', it's simply not currently active. Use the DESTROY event to completely clear resources.

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was shutdown.

Since: 3.0.0
Focus
Focus
SLEEP
Focus
Focus

Description:

The Scene Systems Sleep Event.

This event is dispatched by a Scene when it is sent to sleep, either directly via the sleep method, or as an action from another Scene.

Listen to it from a Scene using this.events.on('sleep', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was sent to sleep.

Since: 3.0.0
Focus
Focus
START
Focus
Focus

Description:

The Scene Systems Start Event.

This event is dispatched by a Scene during the Scene Systems start process. Primarily used by Scene Plugins.

Listen to it from a Scene using this.events.on('start', listener).

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

Since: 3.0.0
Focus
Focus
TRANSITION_COMPLETE
Focus
Focus

Description:

The Scene Transition Complete Event.

This event is dispatched by the Target Scene of a transition.

It happens when the transition process has completed. This occurs when the duration timer equals or exceeds the duration of the transition.

Listen to it from a Scene using this.events.on('transitioncomplete', listener).

The Scene Transition event flow is as follows:

  1. TRANSITION_OUT - the Scene that started the transition will emit this event.
  2. TRANSITION_INIT - the Target Scene will emit this event if it has an init method.
  3. TRANSITION_START - the Target Scene will emit this event after its create method is called, OR ...
  4. TRANSITION_WAKE - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.
  5. TRANSITION_COMPLETE - the Target Scene will emit this event when the transition finishes.

Parameters:

name type description
scene Phaser.Scene

The Scene on which the transitioned completed.

Since: 3.5.0
Focus
Focus
TRANSITION_INIT
Focus
Focus

Description:

The Scene Transition Init Event.

This event is dispatched by the Target Scene of a transition.

It happens immediately after the Scene.init method is called. If the Scene does not have an init method, this event is not dispatched.

Listen to it from a Scene using this.events.on('transitioninit', listener).

The Scene Transition event flow is as follows:

  1. TRANSITION_OUT - the Scene that started the transition will emit this event.
  2. TRANSITION_INIT - the Target Scene will emit this event if it has an init method.
  3. TRANSITION_START - the Target Scene will emit this event after its create method is called, OR ...
  4. TRANSITION_WAKE - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.
  5. TRANSITION_COMPLETE - the Target Scene will emit this event when the transition finishes.

Parameters:

name type description
from Phaser.Scene

A reference to the Scene that is being transitioned from.

duration number

The duration of the transition in ms.

Since: 3.5.0
Focus
Focus
TRANSITION_OUT
Focus
Focus

Description:

The Scene Transition Out Event.

This event is dispatched by a Scene when it initiates a transition to another Scene.

Listen to it from a Scene using this.events.on('transitionout', listener).

The Scene Transition event flow is as follows:

  1. TRANSITION_OUT - the Scene that started the transition will emit this event.
  2. TRANSITION_INIT - the Target Scene will emit this event if it has an init method.
  3. TRANSITION_START - the Target Scene will emit this event after its create method is called, OR ...
  4. TRANSITION_WAKE - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.
  5. TRANSITION_COMPLETE - the Target Scene will emit this event when the transition finishes.

Parameters:

name type description
target Phaser.Scene

A reference to the Scene that is being transitioned to.

duration number

The duration of the transition in ms.

Since: 3.5.0
Focus
Focus
TRANSITION_START
Focus
Focus

Description:

The Scene Transition Start Event.

This event is dispatched by the Target Scene of a transition, only if that Scene was not asleep.

It happens immediately after the Scene.create method is called. If the Scene does not have a create method, this event is dispatched anyway.

If the Target Scene was sleeping then the TRANSITION_WAKE event is dispatched instead of this event.

Listen to it from a Scene using this.events.on('transitionstart', listener).

The Scene Transition event flow is as follows:

  1. TRANSITION_OUT - the Scene that started the transition will emit this event.
  2. TRANSITION_INIT - the Target Scene will emit this event if it has an init method.
  3. TRANSITION_START - the Target Scene will emit this event after its create method is called, OR ...
  4. TRANSITION_WAKE - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.
  5. TRANSITION_COMPLETE - the Target Scene will emit this event when the transition finishes.

Parameters:

name type description
from Phaser.Scene

A reference to the Scene that is being transitioned from.

duration number

The duration of the transition in ms.

Since: 3.5.0
Focus
Focus
TRANSITION_WAKE
Focus
Focus

Description:

The Scene Transition Wake Event.

This event is dispatched by the Target Scene of a transition, only if that Scene was asleep before the transition began. If the Scene was not asleep the TRANSITION_START event is dispatched instead.

Listen to it from a Scene using this.events.on('transitionwake', listener).

The Scene Transition event flow is as follows:

  1. TRANSITION_OUT - the Scene that started the transition will emit this event.
  2. TRANSITION_INIT - the Target Scene will emit this event if it has an init method.
  3. TRANSITION_START - the Target Scene will emit this event after its create method is called, OR ...
  4. TRANSITION_WAKE - the Target Scene will emit this event if it was asleep and has been woken-up to be transitioned to.
  5. TRANSITION_COMPLETE - the Target Scene will emit this event when the transition finishes.

Parameters:

name type description
from Phaser.Scene

A reference to the Scene that is being transitioned from.

duration number

The duration of the transition in ms.

Since: 3.5.0
Focus
Focus
UPDATE
Focus
Focus

Description:

The Scene Systems Update Event.

This event is dispatched by a Scene during the main game loop step.

The event flow for a single step of a Scene is as follows:

  1. PRE_UPDATE
  2. UPDATE
  3. The Scene.update method is called, if it exists
  4. POST_UPDATE
  5. PRE_RENDER
  6. RENDER

Listen to it from a Scene using this.events.on('update', listener).

A Scene will only run its step if it is active.

Parameters:

name type description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

time number

The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.

delta number

The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Since: 3.0.0
Focus
Focus
WAKE
Focus
Focus

Description:

The Scene Systems Wake Event.

This event is dispatched by a Scene when it is woken from sleep, either directly via the wake method, or as an action from another Scene.

Listen to it from a Scene using this.events.on('wake', listener).

Parameters:

name type arguments description
sys Phaser.Scenes.Systems

A reference to the Scene Systems class of the Scene that emitted this event.

data any <optional>

An optional data object that was passed to this Scene when it was woken up.

Since: 3.0.0
Focus
Focus