Phaser API Documentation

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

Description:

Shutdown the Scene, clearing display list, timers, etc.

This happens at the next Scene Manager update, not immediately.

Parameters:

name type arguments description
key string | Phaser.Scene <optional>

The Scene to stop.

data any <optional>

Optional data object to pass to Scene.Systems.shutdown.

Returns:
Description:

This Scene Plugin instance.

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