Phaser API Documentation

  Version: 
<static> register(key, plugin, mapping, [custom])

Description:

Static method called directly by the Core internal Plugins. Key is a reference used to get the plugin from the plugins object (i.e. InputPlugin) Plugin is the object to instantiate to create the plugin Mapping is what the plugin is injected into the Scene.Systems as (i.e. input)

Parameters:

name type arguments Default description
key string

A reference used to get this plugin from the plugin cache.

plugin function

The plugin to be stored. Should be the core object, not instantiated.

mapping string

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?

Examples:
Since: 3.8.0