Phaser API Documentation

  Version: 
Event: SLEEP
Phaser.Scenes.Events.SLEEP
SLEEP

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