Class: PluginManager

Members

game : Phaser.Game

A reference to the currently running game.

Type:

• Phaser.Game

Source:

src/core/PluginManager.js line 19

plugins : Array.<Phaser.Plugin>

An array of all the plugins being managed by this PluginManager.

Type:

• Array.<Phaser.Plugin>

Source:

src/core/PluginManager.js line 24

Methods

add(plugin, parameter)

Add a new Plugin into the PluginManager. The Plugin must have 2 properties: game and parent. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.

Parameters:

Name	Type	Argument	Description
plugin	object | Phaser.Plugin		The Plugin to add into the PluginManager. This can be a function or an existing object.
parameter	*	<repeatable>	Additional arguments that will be passed to the Plugin.init method.

Source:

src/core/PluginManager.js line 41

Returns:

The Plugin that was added to the manager.

Type

Phaser.Plugin

destroy()

Clear down this PluginManager, calls destroy on every plugin and nulls out references.

Source:

src/core/PluginManager.js line 269

postRender()

Post-render is called after the Game Renderer and State.render have run. It only calls plugins who have visible=true.

Source:

src/core/PluginManager.js line 250

postUpdate()

PostUpdate is the last thing to be called before the world render. In particular, it is called after the world postUpdate, which means the camera has been adjusted. It only calls plugins who have active=true.

Source:

src/core/PluginManager.js line 211

preUpdate()

Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics). It only calls plugins who have active=true.

Source:

src/core/PluginManager.js line 173

remove(plugin [, destroy])

Remove a Plugin from the PluginManager. It calls Plugin.destroy on the plugin before removing it from the manager.

Parameters:

Name	Type	Argument	Default	Description
plugin	Phaser.Plugin			The plugin to be removed.
destroy	boolean	<optional>	true	Call destroy on the plugin that is removed?

Source:

src/core/PluginManager.js line 126

removeAll()

Remove all Plugins from the PluginManager. It calls Plugin.destroy on every plugin before removing it from the manager.

Source:

src/core/PluginManager.js line 155

render()

Render is called right after the Game Renderer completes, but before the State.render. It only calls plugins who have visible=true.

Source:

src/core/PluginManager.js line 231

update()

Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render. It only calls plugins who have active=true.

Source:

src/core/PluginManager.js line 192