Version: Phaser v4.0.0-rc.6

ScenePluginFile

A single Scene Plugin Script File suitable for loading by the Loader.

These are created when you use the Phaser.Loader.LoaderPlugin#scenePlugin method and are not typically created directly.

For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#scenePlugin.

Constructor

new ScenePluginFile(loader, key, [url], [systemKey], [sceneKey], [xhrSettings])

Parameters

name	type	optional	description
loader	Phaser.Loader.LoaderPlugin	No	A reference to the Loader that is responsible for this file.
key	string \| Phaser.Types.Loader.FileTypes.ScenePluginFileConfig	No	The key to use for this file, or a file configuration object.
url	string	Yes	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".
systemKey	string	Yes	If this plugin is to be added to Scene.Systems, this is the property key for it.
sceneKey	string	Yes	If this plugin is to be added to the Scene, this is the property key for it.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	Yes	Extra XHR Settings specifically for this file.

Scope: static

Extends

Phaser.Loader.File

Source: src/loader/filetypes/ScenePluginFile.js#L14
Since: 3.8.0

Inherited Methods

Description:

Called automatically by Loader.nextFile.

This method controls what extra work this File does with its loaded data.

Overrides: Phaser.Loader.File#onProcess

Source: src/loader/filetypes/ScenePluginFile.js#L82
Since: 3.8.0