Phaser API Documentation

<static> registerCustom(key, plugin, mapping, data)


Stores a custom plugin in the global plugin cache. The key must be unique, within the scope of the cache.


name type 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.

data any

A value to be passed to the plugin's init method.

Since: 3.8.0