Filter

Hide inherited members:

show private members:

Phaser . Scenes . SceneManager

The Scene Manager.

The Scene Manager is a Game level system, responsible for creating, processing and updating all of the Scenes in a Game instance. ó *

Constructor:

new SceneManager(game, sceneConfig)

Parameters:

name	type	description
game	Phaser.Game	The Phaser.Game instance this Scene Manager belongs to.
sceneConfig	object	Scene specific configuration settings.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 17)

Members

<private> _data: object

Description:

Boot time data to merge.

Type:

object

Since: 3.4.0

Source: src/scene/SceneManager.js (Line 96)

<private> _pending: array

Description:

Scenes pending to be added are stored in here until the manager has time to add it.

Type:

array

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 66)

<private> _queue: array

Description:

An operations queue, because we don't manipulate the scenes array during processing.

Type:

array

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 86)

<private> _start: array

Description:

An array of scenes waiting to be started once the game has booted.

Type:

array

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 76)

customViewports: number

Description:

Do any of the Cameras in any of the Scenes require a custom viewport? If not we can skip scissor tests.

Type:

number

Default: 0

Since: 3.12.0

Source: src/scene/SceneManager.js (Line 128)

game: Phaser.Game

Description:

The Game that this SceneManager belongs to.

Type:

Phaser.Game

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 39)

<readonly> isBooted: boolean

Description:

Has the Scene Manager properly started?

Type:

boolean

Default: false

Since: 3.4.0

Source: src/scene/SceneManager.js (Line 117)

<readonly> isProcessing: boolean

Description:

Is the Scene Manager actively processing the Scenes list?

Type:

boolean

Default: false

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 106)

keys: object

Description:

An object that maps the keys to the scene so we can quickly get a scene from a key without iteration.

Type:

object

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 48)

scenes: array

Description:

The array in which all of the scenes are kept.

Type:

array

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 57)

Methods

add(key, sceneConfig, [autoStart], [data])

Description:

Adds a new Scene into the SceneManager. You must give each Scene a unique key by which you'll identify it.

The sceneConfig can be:

A Phaser.Scene object, or an object that extends it.
A plain JavaScript object
A JavaScript ES6 Class that extends Phaser.Scene
A JavaScript ES5 prototype based Class
A JavaScript function

If a function is given then a new Scene will be created by calling it.

Parameters:

name	type	arguments	Default	description
key	string			A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
sceneConfig	function \| Phaser.Scene \| Phaser.Types.Scenes.SettingsConfig \| Phaser.Types.Scenes.CreateSceneFromObjectConfig			The config for the Scene
autoStart	boolean	<optional>	false	If `true` the Scene will be started immediately after being added.
data	object	<optional>		Optional data object. This will be set as `Scene.settings.data` and passed to `Scene.init`, and `Scene.create`.

Returns:

Description:

The added Scene, if it was added immediately, otherwise null.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 297)

<private> bootQueue()

Description:

Internal first-time Scene boot handler.

Since: 3.2.0

Source: src/scene/SceneManager.js (Line 161)

<private> bootScene(scene)

Description:

Boot the given Scene.

Parameters:

name	type	description
scene	Phaser.Scene	The Scene to boot.

Fires:

Phaser.Scenes.Events.TRANSITION_INIT

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 440)

bringToTop(key)

Description:

Brings a Scene to the top of the Scenes list.

This means it will render above all other Scenes.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to move.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1296)

<private> create(scene)

Description:

Calls the given Scene's Phaser.Scene#create method and updates its status.

Parameters:

name	type	description
scene	Phaser.Scene	The Scene to create.

Fires:

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 594)

<private> createSceneFromFunction(key, scene)

Description:

Creates and initializes a Scene from a function.

Parameters:

name	type	description
key	string	The key of the Scene.
scene	function	The function to create the Scene from.

Returns:

Description:

The created Scene.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 638)

<private> createSceneFromInstance(key, newScene)

Description:

Creates and initializes a Scene instance.

Parameters:

name	type	description
key	string	The key of the Scene.
newScene	Phaser.Scene	The Scene instance.

Returns:

Description:

The created Scene.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 682)

<private> createSceneFromObject(key, sceneConfig)

Description:

Creates and initializes a Scene from an Object definition.

Parameters:

name	type	description
key	string	The key of the Scene.
sceneConfig	string \| Phaser.Types.Scenes.SettingsConfig \| Phaser.Types.Scenes.CreateSceneFromObjectConfig	The Scene config.

Returns:

Description:

The created Scene.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 708)

destroy()

Description:

Destroy the SceneManager and all of its Scene's systems.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1610)

dump()

Description:

Dumps debug information about each Scene to the developer console.

Since: 3.2.0

Source: src/scene/SceneManager.js (Line 1586)

getAt(index)

Description:

Retrieves a Scene by numeric index.

Parameters:

name	type	description
index	number	The index of the Scene to retrieve.

Returns:

Description:

The Scene.

Type:

Phaser.Scene
undefined

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1264)

getIndex(key)

Description:

Retrieves the numeric index of a Scene.

Parameters:

name	type	description
key	string \| Phaser.Scene	The key of the Scene.

Returns:

Description:

The index of the Scene.

Type:

number

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1279)

<private> getKey(key, sceneConfig)

Description:

Retrieves the key of a Scene from a Scene config.

Parameters:

name	type	description
key	string	The key to check in the Scene config.
sceneConfig	function \| Phaser.Scene \| Phaser.Types.Scenes.SettingsConfig	The Scene config.

Returns:

Description:

The Scene key.

Type:

string

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 791)

getScene(key)

Description:

Retrieves a Scene.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to retrieve.

Returns:

Description:

The Scene.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 867)

getScenes([isActive], [inReverse])

Description:

Returns an array of all the current Scenes being managed by this Scene Manager.

You can filter the output by the active state of the Scene and choose to have the array returned in normal or reversed order.

Parameters:

name	type	arguments	Default	description
isActive	boolean	<optional>	true	Only include Scene's that are currently active?
inReverse	boolean	<optional>	false	Return the array of Scenes in reverse?

Returns:

Description:

An array containing all of the Scenes in the Scene Manager.

Type:

Array.<Phaser.Scene>

Since: 3.16.0

Source: src/scene/SceneManager.js (Line 832)

isActive(key)

Description:

Determines whether a Scene is running.

Parameters:

name	type	description
key	string	The Scene to check.

Returns:

Description:

Whether the Scene is running.

Type:

boolean

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 900)

isPaused(key)

Description:

Determines whether a Scene is paused.

Parameters:

name	type	description
key	string	The Scene to check.

Returns:

Description:

Whether the Scene is paused.

Type:

boolean

Since: 3.17.0

Source: src/scene/SceneManager.js (Line 922)

isSleeping(key)

Description:

Determines whether a Scene is sleeping.

Parameters:

name	type	description
key	string	The Scene to check.

Returns:

Description:

Whether the Scene is sleeping.

Type:

boolean

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 966)

isVisible(key)

Description:

Determines whether a Scene is visible.

Parameters:

name	type	description
key	string	The Scene to check.

Returns:

Description:

Whether the Scene is visible.

Type:

boolean

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 944)

<private> loadComplete(loader)

Description:

Handles load completion for a Scene's Loader.

Starts the Scene that the Loader belongs to.

Parameters:

name	type	description
loader	Phaser.Loader.LoaderPlugin	The loader that has completed loading.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 504)

moveAbove(keyA, keyB)

Description:

Moves a Scene so it is immediately above another Scene in the Scenes list.

This means it will render over the top of the other Scene.

Parameters:

name	type	description
keyA	string \| Phaser.Scene	The Scene that Scene B will be moved above.
keyB	string \| Phaser.Scene	The Scene to be moved.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.2.0

Source: src/scene/SceneManager.js (Line 1432)

moveBelow(keyA, keyB)

Description:

Moves a Scene so it is immediately below another Scene in the Scenes list.

This means it will render behind the other Scene.

Parameters:

name	type	description
keyA	string \| Phaser.Scene	The Scene that Scene B will be moved above.
keyB	string \| Phaser.Scene	The Scene to be moved.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.2.0

Source: src/scene/SceneManager.js (Line 1476)

moveDown(key)

Description:

Moves a Scene down one position in the Scenes list.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to move.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1364)

moveUp(key)

Description:

Moves a Scene up one position in the Scenes list.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to move.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1398)

pause(key, [data])

Description:

Pauses the given Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to pause.
data	object	<optional>	An optional data object that will be passed to the Scene and emitted by its pause event.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 988)

<private> payloadComplete(loader)

Description:

Handle payload completion for a Scene.

Parameters:

name	type	description
loader	Phaser.Loader.LoaderPlugin	The loader that has completed loading its Scene's payload.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 529)

processQueue()

Description:

Process the Scene operations queue.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 244)

<private> queueOp(op, keyA, [keyB])

Description:

Queue a Scene operation for the next update.

Parameters:

name	type	arguments	description
op	string		The operation to perform.
keyA	string \| Phaser.Scene		Scene A.
keyB	any \| string \| Phaser.Scene	<optional>	Scene B, or a data object.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1527)

remove(key)

Description:

Removes a Scene from the SceneManager.

The Scene is removed from the local scenes array, it's key is cleared from the keys cache and Scene.Systems.destroy is then called on it.

If the SceneManager is processing the Scenes when this method is called it will queue the operation for the next update sequence.

Parameters:

name	type	description
key	string	A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.2.0

Source: src/scene/SceneManager.js (Line 388)

render(renderer)

Description:

Renders the Scenes.

Parameters:

name	type	description
renderer	Phaser.Renderer.Canvas.CanvasRenderer \| Phaser.Renderer.WebGL.WebGLRenderer	The renderer to use.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 570)

resume(key, [data])

Description:

Resumes the given Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to resume.
data	object	<optional>	An optional data object that will be passed to the Scene and emitted by its resume event.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1011)

run(key, [data])

Description:

Runs the given Scene.

If the given Scene is paused, it will resume it. If sleeping, it will wake it. If not running at all, it will be started.

Use this if you wish to open a modal Scene by calling pause on the current Scene, then run on the modal Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to run.
data	object	<optional>	A data object that will be passed to the Scene on start, wake, or resume.

Returns:

Description:

This Scene Manager.

Type:

Phaser.Scenes.SceneManager

Since: 3.10.0

Source: src/scene/SceneManager.js (Line 1080)

sendToBack(key)

Description:

Sends a Scene to the back of the Scenes list.

This means it will render below all other Scenes.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to move.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1330)

sleep(key, [data])

Description:

Puts the given Scene to sleep.

Parameters:

name	type	arguments	description
key	string		The Scene to put to sleep.
data	object	<optional>	An optional data object that will be passed to the Scene and emitted by its sleep event.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1034)

start(key, [data])

Description:

Starts the given Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to start.
data	object	<optional>	Optional data object to pass to `Scene.Settings` and `Scene.init`, and `Scene.create`.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1131)

stop(key, [data])

Description:

Stops the given Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to stop.
data	object	<optional>	Optional data object to pass to Scene.shutdown.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1208)

swapPosition(keyA, keyB)

Description:

Swaps the positions of two Scenes in the Scenes list.

Parameters:

name	type	description
keyA	string \| Phaser.Scene	The first Scene to swap.
keyB	string \| Phaser.Scene	The second Scene to swap.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1547)

switch(from, to)

Description:

Sleeps one one Scene and starts the other.

Parameters:

name	type	description
from	string	The Scene to sleep.
to	string	The Scene to start.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1231)

update(time, delta)

Description:

Updates the Scenes.

Parameters:

name	type	description
time	number	Time elapsed.
delta	number	Delta time from the last update.

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 543)

wake(key, [data])

Description:

Awakens the given Scene.

Parameters:

name	type	arguments	description
key	string		The Scene to wake up.
data	object	<optional>	An optional data object that will be passed to the Scene and emitted by its wake event.

Returns:

Description:

This SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/SceneManager.js (Line 1057)

Possible examples