SceneFile
A Scene File is an external JavaScript file that defines a Phaser Scene class, which is loaded by the Loader and then registered directly with the Scene Manager so it can be started, launched, or otherwise used like any Scene that was defined locally. This allows you to split your game's Scenes across multiple JavaScript files and load them on demand rather than bundling everything upfront.
The key used when loading must match the class name defined in the JavaScript file, as the file is evaluated and the class is instantiated by name. Once loaded, the Scene is available to the Scene Manager under either that key or whichever key was passed to super() in the Scene's constructor.
These are created when you use the Phaser.Loader.LoaderPlugin#sceneFile method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#sceneFile.
Constructor
new SceneFile(loader, key, [url], [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.SceneFileConfig | 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". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/SceneFile.js#L14
Since: 3.16.0
Inherited Methods
From Phaser.Loader.File:
- destroy
- hasCacheConflict
- load
- onBase64Load
- onError
- onLoad
- onProcessComplete
- onProcessError
- onProgress
- pendingDestroy
- resetXHR
- setLink
Public Methods
addToCache
<instance> addToCache()
Description:
Evaluates the loaded JavaScript source, instantiates the Scene class identified by this file's key, and registers the resulting Scene instance with the Scene Manager so it is available for use.
Overrides: Phaser.Loader.File#addToCache
Source: src/loader/filetypes/SceneFile.js#L88
Since: 3.16.0
onProcess
<instance> onProcess()
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/SceneFile.js#L72
Since: 3.16.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