Phaser.Types.Plugins - Phaser 3 API Documentation (beta)

Hide inherited members:

show private members:

Namespace: Plugins

Phaser.Types.Plugins

CorePluginContainer

name	type	arguments	Default	description
key	string			The unique name of this plugin in the core plugin cache.
plugin	function			The plugin to be stored. Should be the source object, not instantiated.
mapping	string	<optional>		If this plugin is to be injected into the Scene Systems, this is the property key map used.
custom	boolean	<optional>	false	Core Scene plugin or a Custom Scene plugin?

object

Since: 3.8.0

Source: src/plugins/typedefs/CorePluginContainer.js (Line 1)

CustomPluginContainer

name	type	description
key	string	The unique name of this plugin in the custom plugin cache.
plugin	function	The plugin to be stored. Should be the source object, not instantiated.

object

Since: 3.8.0

GlobalPlugin

name	type	arguments	description
key	string		The unique name of this plugin within the plugin cache.
plugin	function		An instance of the plugin.
active	boolean	<optional>	Is the plugin active or not?
mapping	string	<optional>	If this plugin is to be injected into the Scene Systems, this is the property key map used.

object

Since: 3.0.0

Source: src/plugins/typedefs/GlobalPlugin.js (Line 1)