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 . BasePlugin

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 . BasePlugin

A Global Plugin is installed just once into the Game owned Plugin Manager. It can listen for Game events and respond to them.

Constructor:

new BasePlugin(pluginManager)

Parameters:

name type description
pluginManager Phaser.Plugins.PluginManager

A reference to the Plugin Manager.

Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 9)

Members

<protected> game: Phaser.Game
Focus
Focus

Description:

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

Type:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 38)
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:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 27)
Focus
Focus

Methods

destroy()
Focus
Focus

Description:

Game instance has been destroyed. You must release everything in here, all references, all objects, free it all up.

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).

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.

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.

Examples:
Since: 3.8.0
Source: src/plugins/BasePlugin.js (Line 92)
Focus
Focus