Filter
A MultiFile is a special kind of parent that contains two, or more, Files as children and looks after the loading and processing of them all. It is commonly extended and used as a base class for file types such as AtlasJSON or BitmapFont.
You shouldn't create an instance of a MultiFile directly, but should extend it with your own class, setting a custom type and processing methods.
Constructor:
new MultiFile(loader, type, key, files)
Parameters:
| name | type | description |
|---|---|---|
| loader | Phaser.Loader.LoaderPlugin |
The Loader that is going to load this File. |
| type | string |
The file type string for sorting within the Loader. |
| key | string |
The key of the file within the loader. |
| files | Array.<Phaser.Loader.File> |
An array of Files that make-up this MultiFile. |
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 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.