Filter

Hide inherited members:

show private members:

Phaser . Scenes . ScenePlugin

The Scene Plugin is the main interface to the Scene Manager and allows you to control any Scene running in your game. You should always use this plugin. By default, it is mapped to the Scene property this.scene. Meaning, from within a Scene, you can call methods such as this.scene.start().

Note that nearly all methods in this class are run on a queue-basis and not immediately. For example, calling this.scene.launch('SceneB') will try to launch SceneB when the Scene Manager next updates, which is at the start of the game step. All operations are queued and run in the order in which they are invoked here.

Constructor:

new ScenePlugin(scene)

Parameters:

name	type	description
scene	Phaser.Scene	The Scene that this ScenePlugin belongs to.

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 13)

Members

<private> _duration: number

Description:

Transition duration.

Type:

number

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 113)

<private> _elapsed: number

Description:

Transition elapsed timer.

Type:

number

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 93)

<private> _onUpdate: function

Description:

Transition callback.

Type:

function

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 123)

<private> _onUpdateScope: object

Description:

Transition callback scope.

Type:

object

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 133)

<private, nullable> _target: Phaser.Scene

Description:

Transition elapsed timer.

Type:

Phaser.Scene

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 103)

<private> _willRemove: boolean

Description:

Will this Scene be removed from the Scene Manager after the transition completes?

Type:

boolean

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 153)

<private> _willSleep: boolean

Description:

Will this Scene sleep (true) after the transition, or stop (false)

Type:

boolean

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 143)

key: string

Description:

The key of the Scene this ScenePlugin belongs to.

Type:

string

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 65)

manager: Phaser.Scenes.SceneManager

Description:

The Game's SceneManager.

Type:

Phaser.Scenes.SceneManager

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 74)

scene: Phaser.Scene

Description:

The Scene that this ScenePlugin belongs to.

Type:

Phaser.Scene

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 38)

settings: Phaser.Types.Scenes.SettingsObject

Description:

The settings of the Scene this ScenePlugin belongs to.

Type:

Phaser.Types.Scenes.SettingsObject

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 56)

systems: Phaser.Scenes.Systems

Description:

The Scene Systems instance of the Scene that this ScenePlugin belongs to.

Type:

Phaser.Scenes.Systems

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 47)

transitionProgress: number

Description:

If this Scene is currently transitioning to another, this holds the current percentage of the transition progress, between 0 and 1.

Type:

number

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 83)

Methods

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

Description:

Add the Scene into the Scene Manager and start it if 'autoStart' is true or the Scene config 'active' property is set.

Parameters:

name	type	arguments	Default	description
key	string			A unique key used to reference the Scene, i.e. `MainMenu` or `Level1`.
sceneConfig	Phaser.Types.Scenes.SceneType			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/ScenePlugin.js (Line 447)

<private> boot()

Description:

This method is called automatically, only once, when the Scene is first created. Do not invoke it directly.

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 167)

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	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to move.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 969)

<private> checkValidTransition(target)

Description:

Checks to see if this Scene can transition to the target Scene or not.

Parameters:

name	type	description
target	Phaser.Scene	The Scene to test against.

Returns:

Description:

true if this Scene can transition, otherwise false.

Type:

boolean

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 356)

<private> destroy()

Description:

The Scene that owns this plugin is being destroyed.

We need to shutdown and then kill off all external references.

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 1098)

get(key)

Description:

Retrieves a Scene based on the given key.

If an actual Scene is passed to this method, it can be used to check if its currently within the Scene Manager, or not.

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/ScenePlugin.js (Line 1017)

getIndex([key])

Description:

Retrieves the numeric index of a Scene in the Scenes list.

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to get the index of.

Returns:

Description:

The index of the Scene.

Type:

number

Since: 3.7.0

Source: src/scene/ScenePlugin.js (Line 1061)

getStatus(key)

Description:

Return the status of the Scene.

Parameters:

name	type	description
key	string \| Phaser.Scene	The Scene to get the status from.

Returns:

Description:

The Scene status. This maps to the Phaser.Scene constants, such as Phaser.Scene.LOADING.

Type:

number

Since: 3.60.0

Source: src/scene/ScenePlugin.js (Line 1038)

isActive([key])

Description:

Checks if the given Scene is running or not?

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to check.

Returns:

Description:

Whether the Scene is running, or null if no matching Scene was found.

Type:

boolean

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 751)

isPaused([key])

Description:

Checks if the given Scene is paused or not?

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to check.

Returns:

Description:

Whether the Scene is paused, or null if no matching Scene was found.

Type:

boolean

Since: 3.17.0

Source: src/scene/ScenePlugin.js (Line 771)

isSleeping([key])

Description:

Checks if the given Scene is sleeping or not?

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to check.

Returns:

Description:

Whether the Scene is sleeping, or null if no matching Scene was found.

Type:

boolean

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 731)

isVisible([key])

Description:

Checks if the given Scene is visible or not?

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to check.

Returns:

Description:

Whether the Scene is visible, or null if no matching Scene was found.

Type:

boolean

Since: 3.0.0

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

launch(key, [data])

Description:

Launch the given Scene and run it in parallel with this one.

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

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene		The Scene to launch.
data	object	<optional>	The Scene data.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 465)

moveAbove(keyA, [keyB])

Description:

Moves a Scene so it is immediately above another Scene in the Scenes list. If the Scene is already above the other, it isn't moved.

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

Parameters:

name	type	arguments	description
keyA	string \| Phaser.Scene		The Scene that Scene B will be moved to be above.
keyB	string \| Phaser.Scene	<optional>	The Scene to be moved. If none is given it defaults to this Scene.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.2.0

Source: src/scene/ScenePlugin.js (Line 839)

moveBelow(keyA, [keyB])

Description:

Moves a Scene so it is immediately below another Scene in the Scenes list. If the Scene is already below the other, it isn't moved.

This means it will render behind the other Scene.

Parameters:

name	type	arguments	description
keyA	string \| Phaser.Scene		The Scene that Scene B will be moved to be below.
keyB	string \| Phaser.Scene	<optional>	The Scene to be moved. If none is given it defaults to this Scene.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.2.0

Source: src/scene/ScenePlugin.js (Line 868)

moveDown([key])

Description:

Moves a Scene down one position in the Scenes list.

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to move.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 947)

moveUp([key])

Description:

Moves a Scene up one position in the Scenes list.

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to move.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 925)

pause([key], [data])

Description:

Pause the Scene - this stops the update step from happening but it still renders.

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

Parameters:

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

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 523)

<private> pluginStart()

Description:

This method is called automatically by the Scene when it is starting up. It is responsible for creating local systems, properties and listening for Scene events. Do not invoke it directly.

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 180)

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	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to be removed.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.2.0

Source: src/scene/ScenePlugin.js (Line 897)

restart([data])

Description:

Restarts this Scene.

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

Parameters:

name	type	arguments	description
data	object	<optional>	The Scene data. If no value is given it will not overwrite any previous data that may exist.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.4.0

Source: src/scene/ScenePlugin.js (Line 222)

resume([key], [data])

Description:

Resume the Scene - starts the update loop again.

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

Parameters:

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

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 548)

run(key, [data])

Description:

Runs the given Scene, but does not change the state of this Scene.

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

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 \| Phaser.Scene		The Scene to run.
data	object	<optional>	A data object that will be passed to the Scene and emitted in its ready, wake, or resume events.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.10.0

Source: src/scene/ScenePlugin.js (Line 491)

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	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to move.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 993)

setActive(value, [key], [data])

Description:

Sets the active state of the given Scene.

Parameters:

name	type	arguments	description
value	boolean		If `true` the Scene will be resumed. If `false` it will be paused.
key	string \| Phaser.Scene	<optional>	The Scene to set the active state of.
data	object	<optional>	An optional data object that will be passed to the Scene and emitted with its events.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 674)

setVisible(value, [key])

Description:

Sets the visible state of the given Scene.

Parameters:

name	type	arguments	description
value	boolean		The visible value.
key	string \| Phaser.Scene	<optional>	The Scene to set the visible state for.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 703)

<private> shutdown()

Description:

The Scene that owns this plugin is shutting down.

We need to kill and reset all internal properties as well as stop listening to Scene events.

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 1081)

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 \| Phaser.Scene	<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 Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 573)

start([key], [data])

Description:

Shutdown this Scene and run the given one.

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

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene	<optional>	The Scene to start.
data	object	<optional>	The Scene data. If no value is given it will not overwrite any previous data that may exist.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 196)

<private> step(time, delta)

Description:

A single game step. This is only called if the parent Scene is transitioning out to another Scene.

Parameters:

name	type	description
time	number	The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.
delta	number	The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 378)

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.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 649)

swapPosition(keyA, [keyB])

Description:

Swaps the position of two scenes in the Scenes list.

This controls the order in which they are rendered and updated.

Parameters:

name	type	arguments	description
keyA	string \| Phaser.Scene		The first Scene to swap.
keyB	string \| Phaser.Scene	<optional>	The second Scene to swap. If none is given it defaults to this Scene.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.2.0

Source: src/scene/ScenePlugin.js (Line 811)

switch(key, [data])

Description:

Makes this Scene sleep then starts the Scene given.

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

Parameters:

name	type	arguments	description
key	string \| Phaser.Scene		The Scene to start.
data	any	<optional>	Optional data object to pass to either the Scene `wake` or `start` method.

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 623)

transition(config)

Description:

This will start a transition from the current Scene to the target Scene given.

The target Scene cannot be the same as the current Scene.

The transition will last for the duration specified in milliseconds.

You can have the target Scene moved above or below this one in the display list.

You can specify an update callback. This callback will be invoked every frame for the duration of the transition.

This Scene can either be sent to sleep at the end of the transition, or stopped. The default is to stop.

There are also 5 transition related events: This scene will emit the event transitionout when the transition begins, which is typically the frame after calling this method.

The target Scene will emit the event transitioninit when that Scene's init method is called. It will then emit the event transitionstart when its create method is called. If the Scene was sleeping and has been woken up, it will emit the event transitionwake instead of these two, as the Scenes init and create methods are not invoked when a Scene wakes up.

When the duration of the transition has elapsed it will emit the event transitioncomplete. These events are cleared of all listeners when the Scene shuts down, but not if it is sent to sleep.

It's important to understand that the duration of the transition begins the moment you call this method. If the Scene you are transitioning to includes delayed processes, such as waiting for files to load, the time still counts down even while that is happening. If the game itself pauses, or something else causes this Scenes update loop to stop, then the transition will also pause for that duration. There are checks in place to prevent you accidentally stopping a transitioning Scene but if you've got code to override this understand that until the target Scene completes it might never be unlocked for input events.

Parameters:

name	type	description
config	Phaser.Types.Scenes.SceneTransitionConfig	The transition configuration object.

Returns:

Description:

true is the transition was started, otherwise false.

Type:

boolean

Fires:

Phaser.Scenes.Events.TRANSITION_OUT

Since: 3.5.0

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

<private> transitionComplete()

Description:

Called by step when the transition out of this scene to another is over.

Fires:

Phaser.Scenes.Events.TRANSITION_COMPLETE

Since: 3.5.0

Source: src/scene/ScenePlugin.js (Line 406)

wake([key], [data])

Description:

Makes the Scene wake-up (starts update and render)

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

Parameters:

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

Returns:

Description:

This Scene Plugin instance.

Type:

Phaser.Scenes.ScenePlugin

Since: 3.0.0

Source: src/scene/ScenePlugin.js (Line 598)

Possible examples