Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Plugins . ScenePlugin

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Plugins . ScenePlugin

A Scene Level Plugin is installed into every Scene and belongs to that Scene. It can listen for Scene events and respond to them. It can map itself to a Scene property, or into the Scene Systems, or both.

Constructor:

new ScenePlugin(scene, pluginManager, pluginKey)

Parameters:

name type description
scene Phaser.Scene

A reference to the Scene that has installed this plugin.

pluginManager Phaser.Plugins.PluginManager

A reference to the Plugin Manager.

pluginKey string

The key under which this plugin has been installed into the Scene Systems.

Since: 3.8.0

Extends


Members

<protected> game: Phaser.Game
Focus
Focus

Description:

A reference to the Game instance this plugin is running under.

Type:
Inherited from: Phaser.Plugins.BasePlugin#game
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 38)
Focus
Focus
<readonly> pluginKey: string
Focus
Focus

Description:

The key under which this plugin was installed into the Scene Systems.

This property is only set when the plugin is instantiated and added to the Scene, not before. You can use it during the boot method.

Type:
string
Since: 3.54.0
Focus
Focus
<protected> pluginManager: Phaser.Plugins.PluginManager
Focus
Focus

Description:

A handy reference to the Plugin Manager that is responsible for this plugin. Can be used as a route to gain access to game systems and events.

Type:
Inherited from: Phaser.Plugins.BasePlugin#pluginManager
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 27)
Focus
Focus
<protected, nullable> scene: Phaser.Scene
Focus
Focus

Description:

A reference to the Scene that has installed this plugin. Only set if it's a Scene Plugin, otherwise null. This property is only set when the plugin is instantiated and added to the Scene, not before. You can use it during the boot method.

Type:
Since: 3.8.0
Focus
Focus
<protected, nullable> systems: Phaser.Scenes.Systems
Focus
Focus

Description:

A reference to the Scene Systems of the Scene that has installed this plugin. Only set if it's a Scene Plugin, otherwise null. This property is only set when the plugin is instantiated and added to the Scene, not before. You can use it during the boot method.

Type:
Since: 3.8.0
Focus
Focus

Methods

boot()
Focus
Focus

Description:

This method is called when the Scene boots. It is only ever called once.

By this point the plugin properties scene and systems will have already been set.

In here you can listen for Scene and set-up whatever you need for this plugin to run. Here are the Scene events you can listen to:

  • start
  • ready
  • preupdate
  • update
  • postupdate
  • resize
  • pause
  • resume
  • sleep
  • wake
  • transitioninit
  • transitionstart
  • transitioncomplete
  • transitionout
  • shutdown
  • destroy

At the very least you should offer a destroy handler for when the Scene closes down, i.e:

var eventEmitter = this.systems.events;
eventEmitter.once('destroy', this.sceneDestroy, this);
Examples:
Since: 3.8.0
Focus
Focus
destroy()
Focus
Focus

Description:

Game instance has been destroyed.

You must release everything in here, all references, all objects, free it all up.

Overrides: Phaser.Plugins.BasePlugin#destroy
Examples:
Since: 3.8.0
Focus
Focus
init([data])
Focus
Focus

Description:

The PluginManager calls this method on a Global Plugin when the plugin is first instantiated. It will never be called again on this instance. In here you can set-up whatever you need for this plugin to run. If a plugin is set to automatically start then BasePlugin.start will be called immediately after this. On a Scene Plugin, this method is never called. Use Phaser.Plugins.ScenePlugin#boot instead.

Parameters:

name type arguments description
data any <optional>

A value specified by the user, if any, from the data property of the plugin's configuration object (if started at game boot) or passed in the PluginManager's install method (if started manually).

Inherited from: Phaser.Plugins.BasePlugin#init
Examples:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 49)
Focus
Focus
start()
Focus
Focus

Description:

The PluginManager calls this method on a Global Plugin when the plugin is started. If a plugin is stopped, and then started again, this will get called again. Typically called immediately after BasePlugin.init. On a Scene Plugin, this method is never called.

Inherited from: Phaser.Plugins.BasePlugin#start
Examples:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 65)
Focus
Focus
stop()
Focus
Focus

Description:

The PluginManager calls this method on a Global Plugin when the plugin is stopped. The game code has requested that your plugin stop doing whatever it does. It is now considered as 'inactive' by the PluginManager. Handle that process here (i.e. stop listening for events, etc) If the plugin is started again then BasePlugin.start will be called again. On a Scene Plugin, this method is never called.

Inherited from: Phaser.Plugins.BasePlugin#stop
Examples:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 92)
Focus
Focus