Phaser API Documentation

  Version: 
Event: TRANSITION_OUT
Phaser.Scenes.Events.TRANSITION_OUT
TRANSITION_OUT

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