PackFile
A single JSON Pack File suitable for loading by the Loader.
A Pack File is a JSON manifest that describes a collection of other assets to be loaded. When the Pack File is processed, the Loader reads its contents and queues each listed asset for loading, allowing you to define an entire set of game resources in a single external JSON file rather than calling individual load methods in code.
These are created when you use the Phaser.Loader.LoaderPlugin#pack method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#pack.
Constructor
new PackFile(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.PackFileConfig | No | The key to use for this file, or a file configuration object. |
| url | string | any | Yes | The absolute or relative URL to load this file from or a ready formed JSON object. 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/PackFile.js#L12
Since: 3.7.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. This method controls what extra work this File does with its loaded data.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/PackFile.js#L52
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