Phaser API Documentation

plugin(key, [url], [start], [mapping], [xhrSettings])


Adds a Plugin Script file, or array of plugin files, to the current load queue.

You can call this method from within your Scene's preload, along with any other files you wish to load:

function preload ()
    this.load.plugin('modplayer', 'plugins/ModPlayer.js');

The file is not loaded right away. It is added to a queue ready to be loaded either when the loader starts, or if it's already running, when the next free load slot becomes available. This happens automatically if you are calling this from within the Scene's preload method, or a related callback. Because the file is queued it means you cannot use the file immediately after calling this method, but must wait for the file to complete. The typical flow for a Phaser Scene is that you load assets in the Scene's preload method and then when the Scene's create method is called you are guaranteed that all of those assets are ready for use and have been loaded.

The key must be a unique String and not already in-use by another file in the Loader.

Instead of passing arguments you can pass a configuration object, such as:

    key: 'modplayer',
    url: 'plugins/ModPlayer.js'

See the documentation for Phaser.Types.Loader.FileTypes.PluginFileConfig for more details.

Once the file has finished loading it will automatically be converted into a script element via document.createElement('script'). It will have its language set to JavaScript, defer set to false and then the resulting element will be appended to document.head. Any code then in the script will be executed. It will then be passed to the Phaser PluginCache.register method.

The URL can be relative or absolute. If the URL is relative the Loader.baseURL and Loader.path values will be prepended to it.

If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien" and no URL is given then the Loader will set the URL to be "alien.js". It will always add .js as the extension, although this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.

Note: The ability to load this type of file will only be available if the Plugin File type has been built into Phaser. It is available in the default build but can be excluded from custom builds.


name type arguments description
key string | Phaser.Types.Loader.FileTypes.PluginFileConfig | Array.<Phaser.Types.Loader.FileTypes.PluginFileConfig>

The key to use for this file, or a file configuration object, or array of them.

url string | function <optional>

The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.js, i.e. if key was "alien" then the URL will be "alien.js". Or, a plugin function.

start boolean <optional>

Automatically start the plugin after loading?

mapping string <optional>

If this plugin is to be injected into the Scene, this is the property key used.

xhrSettings Phaser.Types.Loader.XHRSettingsObject <optional>

An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.


The Loader instance.

Since: 3.0.0