PluginFile
A single Plugin Script File suitable for loading by the Phaser Loader. A Plugin File represents an external JavaScript file that, once loaded, registers a Phaser plugin and makes it available to the Plugin Manager. The script is executed by appending it as a <script> element to the document head. The plugin can optionally be auto-started and injected into the current Scene under a given property key.
These are created when you use the Phaser.Loader.LoaderPlugin#plugin method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#plugin.
Constructor
new PluginFile(loader, key, [url], [start], [mapping], [xhrSettings])
Parameters
| name | type | optional | default | description |
|---|---|---|---|---|
| loader | Phaser.Loader.LoaderPlugin | No | A reference to the Loader that is responsible for this file. | |
| key | string | Phaser.Types.Loader.FileTypes.PluginFileConfig | 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". | |
| start | boolean | Yes | false | Automatically start the plugin after loading? |
| mapping | string | Yes | If this plugin is to be injected into the Scene, this is the property key used. | |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/PluginFile.js#L14
Since: 3.0.0
Inherited Methods
From Phaser.Loader.File:
- addToCache
- destroy
- hasCacheConflict
- load
- onBase64Load
- onError
- onLoad
- onProcessComplete
- onProcessError
- onProgress
- pendingDestroy
- resetXHR
- setLink
Public Methods
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile. Processes the loaded Plugin file and installs it into the Scene's Plugin Manager. If the plugin was provided directly as a class or function, it is installed immediately. Otherwise, a new <script> element is created containing the loaded JavaScript source, appended to the document head to execute it, and then the plugin is installed from the global scope using the file key. If a Scene mapping key or auto-start flag is set, the plugin is also injected into the current Scene and Scene Systems.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/PluginFile.js#L85
Since: 3.7.0
Inherited Members
From Phaser.Loader.File:
- base64
- bytesLoaded
- bytesTotal
- cache
- config
- crossOrigin
- data
- key
- linkFile
- loader
- multiFile
- percentComplete
- retryAttempts
- src
- state
- type
- url
- xhrLoader
- xhrSettings