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
Namespace: Plugins
Phaser.Types.Plugins

Type Definitions

CorePluginContainer
Focus
Focus
Properties:
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?

Type:
object
Since: 3.8.0
Focus
Focus
CustomPluginContainer
Focus
Focus
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.

Type:
object
Since: 3.8.0
Focus
Focus
GlobalPlugin
Focus
Focus
Properties:
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.

Type:
object
Since: 3.0.0
Focus
Focus