Filter
Phaser . Loader . FileTypes . AtlasJSONFile
Phaser . Loader . FileTypes . AtlasJSONFile
A single JSON based Texture Atlas File suitable for loading by the Loader.
These are created when you use the Phaser.Loader.LoaderPlugin#atlas method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlas.
Constructor:
new AtlasJSONFile(loader, key, [textureURL], [atlasURL], [textureXhrSettings], [atlasXhrSettings])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| loader | Phaser.Loader.LoaderPlugin |
A reference to the Loader that is responsible for this file. |
|
| key | string | Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig |
The key to use for this file, or a file configuration object. |
|
| textureURL | string | Array.<string> | <optional> |
The absolute or relative URL to load the texture image file from. If undefined or |
| atlasURL | object | string | <optional> |
The absolute or relative URL to load the texture atlas json data file from. If undefined or |
| textureXhrSettings | Phaser.Types.Loader.XHRSettingsObject | <optional> |
An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings. |
| atlasXhrSettings | Phaser.Types.Loader.XHRSettingsObject | <optional> |
An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings. |
Extends
Members
Description:
A reference to the Loaders baseURL at the time this MultiFile was created. Used to populate child-files.
Type:
Description:
The completion status of this MultiFile.
Type:
Description:
A storage container for transient data that the loading files need.
Type:
Description:
The number of files that failed to load.
Type:
Description:
Array of files that make up this MultiFile.
Type:
Description:
Unique cache key (unique within its file type)
Type:
Description:
A reference to the Loader that is going to load this file.
Description:
A reference to the Loaders path at the time this MultiFile was created. Used to populate child-files.
Type:
Description:
The number of files to load.
Type:
Description:
A reference to the Loaders prefix at the time this MultiFile was created. Used to populate child-files.
Type:
Description:
The current state of the file. One of the FILE_CONST values.
Type:
Description:
The file type string for sorting within the Loader.
Type:
Methods
Description:
Adds this file to its target cache upon successful loading and processing.
Description:
Adds another child to this MultiFile, increases the pending count and resets the completion status.
Parameters:
| name | type | description |
|---|---|---|
| files | Phaser.Loader.File |
The File to add to this MultiFile. |
Returns:
Description:
This MultiFile instance.
Type:
Description:
Destroy this Multi File and any references it holds.
Description:
Checks if this MultiFile is ready to process its children or not.
Returns:
Description:
true if all children of this MultiFile have loaded, otherwise false.
Type:
- boolean
Description:
Called by each File when it finishes loading.
Parameters:
| name | type | description |
|---|---|---|
| file | Phaser.Loader.File |
The File that has completed processing. |
Description:
Called by each File that fails to load.
Parameters:
| name | type | description |
|---|---|---|
| file | Phaser.Loader.File |
The File that has failed to load. |
Description:
Called once all children of this multi file have been added to their caches and is now ready for deletion from the Loader.
It will emit a filecomplete event from the LoaderPlugin.