Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Loader . MultiFile

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Loader . MultiFile

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.

Since: 3.7.0
Source: src/loader/MultiFile.js (Line 9)

Members

baseURL: string
Focus
Focus

Description:

A reference to the Loaders baseURL at the time this MultiFile was created. Used to populate child-files.

Type:
string
Since: 3.20.0
Source: src/loader/MultiFile.js (Line 128)
Focus
Focus
complete: boolean
Focus
Focus

Description:

The completion status of this MultiFile.

Type:
boolean
Default: false
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 89)
Focus
Focus
config: any
Focus
Focus

Description:

A storage container for transient data that the loading files need.

Type:
any
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 119)
Focus
Focus
failed: number
Focus
Focus

Description:

The number of files that failed to load.

Type:
number
Default: 0
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 109)
Focus
Focus
files: Array.<Phaser.Loader.File>
Focus
Focus

Description:

Array of files that make up this MultiFile.

Type:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 80)
Focus
Focus
key: string
Focus
Focus

Description:

Unique cache key (unique within its file type)

Type:
string
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 61)
Focus
Focus

Description:

A reference to the Loader that is going to load this file.

Type:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 43)
Focus
Focus
<private> multiKeyIndex: number
Focus
Focus

Description:

The current index being used by multi-file loaders to avoid key clashes.

Type:
number
Since: 3.20.0
Source: src/loader/MultiFile.js (Line 70)
Focus
Focus
path: string
Focus
Focus

Description:

A reference to the Loaders path at the time this MultiFile was created. Used to populate child-files.

Type:
string
Since: 3.20.0
Source: src/loader/MultiFile.js (Line 138)
Focus
Focus
pending: number
Focus
Focus

Description:

The number of files to load.

Type:
number
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 99)
Focus
Focus
prefix: string
Focus
Focus

Description:

A reference to the Loaders prefix at the time this MultiFile was created. Used to populate child-files.

Type:
string
Since: 3.20.0
Source: src/loader/MultiFile.js (Line 148)
Focus
Focus
type: string
Focus
Focus

Description:

The file type string for sorting within the Loader.

Type:
string
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 52)
Focus
Focus

Methods

addToMultiFile(files)
Focus
Focus

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.

Examples:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 178)
Focus
Focus
isReadyToProcess()
Focus
Focus

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
Examples:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 165)
Focus
Focus
onFileComplete(file)
Focus
Focus

Description:

Called by each File when it finishes loading.

Parameters:

name type description
file Phaser.Loader.File

The File that has completed processing.

Examples:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 201)
Focus
Focus
onFileFailed(file)
Focus
Focus

Description:

Called by each File that fails to load.

Parameters:

name type description
file Phaser.Loader.File

The File that has failed to load.

Examples:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 219)
Focus
Focus