Phaser API Documentation

  Version: 
sleep([key], [data])

Description:

Makes the Scene sleep (no update, no render) but doesn't shutdown.

This will happen at the next Scene Manager update, not immediately.

Parameters:

name type arguments description
key string <optional>

The Scene to put to sleep.

data object <optional>

An optional data object that will be passed to the Scene and emitted in its sleep event.

Returns:
Description:

This ScenePlugin object.

Since: 3.0.0
Source: src/scene/ScenePlugin.js (Line 544)