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 . FileTypes . AtlasJSONFile

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 . 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.

https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm

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 null it will be set to <key>.png, i.e. if key was "alien" then the URL will be "alien.png".

atlasURL object | string <optional>

The absolute or relative URL to load the texture atlas json data 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". Or, a well formed JSON object.

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.

Since: 3.0.0

Extends


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
Inherited from: Phaser.Loader.MultiFile#baseURL
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
Inherited from: Phaser.Loader.MultiFile#complete
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
Inherited from: Phaser.Loader.MultiFile#config
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
Inherited from: Phaser.Loader.MultiFile#failed
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:
Inherited from: Phaser.Loader.MultiFile#files
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
Inherited from: Phaser.Loader.MultiFile#key
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:
Inherited from: Phaser.Loader.MultiFile#loader
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
Inherited from: Phaser.Loader.MultiFile#multiKeyIndex
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
Inherited from: Phaser.Loader.MultiFile#path
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
Inherited from: Phaser.Loader.MultiFile#pending
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
Inherited from: Phaser.Loader.MultiFile#prefix
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
Inherited from: Phaser.Loader.MultiFile#type
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 52)
Focus
Focus

Methods

addToCache()
Focus
Focus

Description:

Adds this file to its target cache upon successful loading and processing.

Examples:
Since: 3.7.0
Focus
Focus
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.

Inherited from: Phaser.Loader.MultiFile#addToMultiFile
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
Inherited from: Phaser.Loader.MultiFile#isReadyToProcess
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.

Inherited from: Phaser.Loader.MultiFile#onFileComplete
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.

Inherited from: Phaser.Loader.MultiFile#onFileFailed
Examples:
Since: 3.7.0
Source: src/loader/MultiFile.js (Line 219)
Focus
Focus