AnimationJSONFile
A single Animation JSON File suitable for loading by the Loader.
These are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#animation.
Constructor
new AnimationJSONFile(loader, key, [url], [xhrSettings], [dataKey])
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.JSONFileConfig | 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>.json, i.e. if key was "alien" then the URL will be "alien.json". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
| dataKey | string | Yes | When the JSON file loads only this property will be stored in the Cache. |
Scope: static
Extends
Source: src/loader/filetypes/AnimationJSONFile.js#L12
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
onLoadComplete
<instance> onLoadComplete()
Description:
Called at the end of the load process, after the Loader has finished all files in its queue.
Source: src/loader/filetypes/AnimationJSONFile.js#L64
Since: 3.7.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/AnimationJSONFile.js#L48
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