Plugin system

Introduction¶

Plugin system, built-in system of phaser.

Author: Richard Davey

Usage¶

Global plugin¶

Load plugin¶

Load plugin before any scene start
In game configuration

// import pluginKlass from '...';
var config = {
    // ...
    plugins: {
        global: [
            {
                key: key,
                plugin: pluginKlass,
                start: true
                // mapping: memberName  // member name in each scene instance, optional
                // data: undefined
            },
            // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

pluginKlass : Class instance
start : Whether the plugin should be started automatically.
mapping : If this plugin is to be injected into the Scene Systems, this is the property key map used.
data : Arbitrary data passed to the plugin's init() method.

Load plugin in scene

scene.load.plugin(key, url, true);
// scene.load.plugin(key, url, true, mapping);

url : File url or class instance.

Get instance¶

var pluginInst = scene.plugins.get(key);

Scene plugin¶

Load plugin¶

Load plugin before any scene start
In game configuration

// import pluginKlass from '...';
var config = {
    // ...
    plugins: {
        scene: [
            {
                key: key,
                plugin: pluginKlass,
                mapping: sceneKey,    // member name in each scene instance
            },
            // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

pluginKlass : Class instance

Load plugin in scene

scene.load.scenePlugin(key, url, systemKey, sceneKey);

url : File url or class instance.

Get instance¶

var pluginInst = scene[sceneKey];

Plugin cache¶

Has custom plugin

var hasPlugin = Phaser.Plugins.PluginCache.hasCustom(key);