You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Namespace: Plugins

Phaser.Types. Plugins

Source: src/plugins/typedefs/index.js (Line 7)

Type Definitions

CorePluginContainer

Type:
  • object
Properties:
Name Type Argument 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?
Since: 3.8.0
Source: src/plugins/typedefs/CorePluginContainer.js (Line 1)

CustomPluginContainer

Type:
  • object
Properties:
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.
Since: 3.8.0
Source: src/plugins/typedefs/CustomPluginContainer.js (Line 1)

GlobalPlugin

Type:
  • object
Properties:
Name Type Argument 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.
Since: 3.0.0
Source: src/plugins/typedefs/GlobalPlugin.js (Line 1)