Class: Loader

Members

<static, constant> TEXTURE_ATLAS_JSON_ARRAY :number

Type:

• number

Source:

• loader/Loader.js, line 115

<static, constant> TEXTURE_ATLAS_JSON_HASH :number

Type:

• number

Source:

• loader/Loader.js, line 121

<static, constant> TEXTURE_ATLAS_XML_STARLING :number

Type:

• number

Source:

• loader/Loader.js, line 127

baseURL

If you want to append a URL before the path of any asset you can set this here. Useful if you need to allow an asset url to be configured outside of the game code. MUST have / on the end of it!

Properties:

Name	Type	Description
baseURL	string

Source:

• loader/Loader.js, line 87

crossOrigin

Properties:

Name	Type	Description
crossOrigin	string	The crossOrigin value applied to loaded images

Source:

• loader/Loader.js, line 78

game

Properties:

Name	Type	Description
game	Phaser.Game	Local reference to game.

Source:

• loader/Loader.js, line 22

hasLoaded

Properties:

Name	Type	Description
hasLoaded	boolean	True if all assets in the queue have finished loading.

Default Value:

• false

Source:

• loader/Loader.js, line 59

isLoading

Properties:

Name	Type	Description
isLoading	boolean	True if the Loader is in the process of loading the queue.

Default Value:

• false

Source:

• loader/Loader.js, line 53

onFileComplete

Properties:

Name	Type	Description
onFileComplete	Phaser.Signal	Event signal.

Source:

• loader/Loader.js, line 92

onFileError

Properties:

Name	Type	Description
onFileError	Phaser.Signal	Event signal.

Source:

• loader/Loader.js, line 97

onLoadComplete

Properties:

Name	Type	Description
onLoadComplete	Phaser.Signal	Event signal.

Source:

• loader/Loader.js, line 107

onLoadStart

Properties:

Name	Type	Description
onLoadStart	Phaser.Signal	Event signal.

Source:

• loader/Loader.js, line 102

preloadSprite

You can optionally link a sprite to the preloader. If you do so the Sprite's width or height will be cropped based on the percentage loaded.

Properties:

Name	Type	Description
preloadSprite	Description

Default Value:

• null

Source:

• loader/Loader.js, line 73

progress

Properties:

Name	Type	Description
progress	number	The Load progress percentage value (from 0 to 100)

Default Value:

• 0

Source:

• loader/Loader.js, line 65

Methods

<protected> addToFileList(type, key, url, properties)

Internal function that adds a new entry to the file list. Do not call directly.

Parameters:

Name	Type	Description
type	string	The type of resource to add to the list (image, audio, xml, etc).
key	string	The unique Cache ID key of this resource.
url	string	The URL the asset will be loaded from.
properties	object	Any additional properties needed to load the file.

Source:

• loader/Loader.js, line 226

atlas(key, textureURL, atlasURL, atlasData, format) → {Phaser.Loader}

Add a new texture atlas to the loader.

Parameters:

Name	Type	Argument	Description
key	string		Unique asset key of the texture atlas file.
textureURL	string		The url of the texture atlas image file.
atlasURL	string	<optional>	The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
atlasData	object	<optional>	A JSON or XML data object. You don't need this if the data is being loaded from a URL.
format	number	<optional>	A value describing the format of the data, the default is Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY.

Source:

• loader/Loader.js, line 592

Returns:

This Loader instance.

Type

Phaser.Loader

atlasJSONArray(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Add a new texture atlas to the loader. This atlas uses the JSON Array data format.

Parameters:

Name	Type	Argument	Description
key	string		Unique asset key of the texture atlas file.
textureURL	string		The url of the texture atlas image file.
atlasURL	string	<optional>	The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
atlasData	object	<optional>	A JSON or XML data object. You don't need this if the data is being loaded from a URL.

Source:

• loader/Loader.js, line 544

Returns:

This Loader instance.

Type

Phaser.Loader

atlasJSONHash(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Add a new texture atlas to the loader. This atlas uses the JSON Hash data format.

Parameters:

Name	Type	Argument	Description
key	string		Unique asset key of the texture atlas file.
textureURL	string		The url of the texture atlas image file.
atlasURL	string	<optional>	The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
atlasData	object	<optional>	A JSON or XML data object. You don't need this if the data is being loaded from a URL.

Source:

• loader/Loader.js, line 560

Returns:

This Loader instance.

Type

Phaser.Loader

atlasXML(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

Add a new texture atlas to the loader. This atlas uses the Starling XML data format.

Parameters:

Name	Type	Argument	Description
key	string		Unique asset key of the texture atlas file.
textureURL	string		The url of the texture atlas image file.
atlasURL	string	<optional>	The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
atlasData	object	<optional>	A JSON or XML data object. You don't need this if the data is being loaded from a URL.

Source:

• loader/Loader.js, line 576

Returns:

This Loader instance.

Type

Phaser.Loader

audio(key, urls, autoDecode) → {Phaser.Loader}

Add a new audio file to the loader.

Parameters:

Name	Type	Description
key	string	Unique asset key of the audio file.
urls	Array | string	An array containing the URLs of the audio files, i.e.: [ 'jump.mp3', 'jump.ogg', 'jump.m4a' ] or a single string containing just one URL.
autoDecode	boolean	When using Web Audio the audio files can either be decoded at load time or run-time. They can't be played until they are decoded, but this let's you control when that happens. Decoding is a non-blocking async process.

Source:

• loader/Loader.js, line 412

Returns:

This Loader instance.

Type

Phaser.Loader

bitmapFont(key, textureURL, xmlURL, xmlData) → {Phaser.Loader}

Add a new bitmap font loading request.

Parameters:

Name	Type	Argument	Description
key	string		Unique asset key of the bitmap font.
textureURL	string		The url of the font image file.
xmlURL	string	<optional>	The url of the font data file (xml/fnt)
xmlData	object	<optional>	An optional XML data object.

Source:

• loader/Loader.js, line 484

Returns:

This Loader instance.

Type

Phaser.Loader

checkKeyExists(type, key) → {boolean}

Check whether asset exists with a specific key.

Parameters:

Name	Type	Description
type	string	The type asset you want to check.
key	string	Key of the asset you want to check.

Source:

• loader/Loader.js, line 162

Returns:

Return true if exists, otherwise return false.

Type

boolean

csvLoadComplete(index)

Successfully loaded a CSV file.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that loaded.

Source:

• loader/Loader.js, line 1106

dataLoadError(index)

Error occured when load a JSON.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that errored.

Source:

• loader/Loader.js, line 1131

fileComplete(index)

Called when a file is successfully loaded.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that loaded.

Source:

• loader/Loader.js, line 923

fileError(index)

Error occured when loading a file.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that errored.

Source:

• loader/Loader.js, line 904

getAsset(type, key) → {any}

Gets the asset that is queued for load.

Parameters:

Name	Type	Description
type	string	The type asset you want to check.
key	string	Key of the asset you want to check.

Source:

• loader/Loader.js, line 187

Returns:

Returns an object if found that has 2 properties: index and file. Otherwise false.

Type

any

image(key, url, overwrite) → {Phaser.Loader}

Add an image to the Loader.

Parameters:

Name	Type	Argument	Default	Description
key	string			Unique asset key of this image file.
url	string			URL of image file.
overwrite	boolean	<optional>	false	If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.

Source:

• loader/Loader.js, line 298

Returns:

This Loader instance.

Type

Phaser.Loader

jsonLoadComplete(index)

Successfully loaded a JSON file.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that loaded.

Source:

• loader/Loader.js, line 1074

removeAll()

Remove all file loading requests.

Source:

• loader/Loader.js, line 690

removeFile(type, key)

Remove loading request of a file.

Parameters:

Name	Type	Description
type	string	The type of resource to add to the list (image, audio, xml, etc).
key	string	Key of the file you want to remove.

Source:

• loader/Loader.js, line 672

<protected> replaceInFileList(type, key, url, properties)

Internal function that replaces an existing entry in the file list with a new one. Do not call directly.

Parameters:

Name	Type	Description
type	string	The type of resource to add to the list (image, audio, xml, etc).
key	string	The unique Cache ID key of this resource.
url	string	The URL the asset will be loaded from.
properties	object	Any additional properties needed to load the file.

Source:

• loader/Loader.js, line 262

reset()

Reset loader, this will remove the load queue.

Source:

• loader/Loader.js, line 212

script(key, url) → {Phaser.Loader}

Add a JavaScript file to the Loader. Once loaded the JavaScript file will be automatically turned into a script tag (and executed), so be careful what you load!

Parameters:

Name	Type	Description
key	string	Unique asset key of the script file.
url	string	URL of the JavaScript file.

Source:

• loader/Loader.js, line 350

Returns:

This Loader instance.

Type

Phaser.Loader

setPreloadSprite(sprite, direction)

You can set a Sprite to be a "preload" sprite by passing it to this method. A "preload" sprite will have its width or height crop adjusted based on the percentage of the loader in real-time. This allows you to easily make loading bars for games.

Parameters:

Name	Type	Argument	Default	Description
sprite	Phaser.Sprite			The sprite that will be cropped during the load.
direction	number	<optional>	0	A value of zero means the sprite width will be cropped, a value of 1 means its height will be cropped.

Source:

• loader/Loader.js, line 131

spritesheet(key, url, frameWidth, frameHeight, frameMax) → {Phaser.Loader}

Add a new sprite sheet to the loader.

Parameters:

Name	Type	Argument	Default	Description
key	string			Unique asset key of the sheet file.
url	string			URL of the sheet file.
frameWidth	number			Width of each single frame.
frameHeight	number			Height of each single frame.
frameMax	number	<optional>	-1	How many frames in this sprite sheet. If not specified it will divide the whole image into frames.

Source:

• loader/Loader.js, line 366

Returns:

This Loader instance.

Type

Phaser.Loader

start()

Start loading the assets. Normally you don't need to call this yourself as the StateManager will do so.

Source:

• loader/Loader.js, line 701

text(key, url, overwrite) → {Phaser.Loader}

Add a text file to the Loader.

Parameters:

Name	Type	Argument	Default	Description
key	string			Unique asset key of the text file.
url	string			URL of the text file.
overwrite	boolean	<optional>	false	If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.

Source:

• loader/Loader.js, line 324

Returns:

This Loader instance.

Type

Phaser.Loader

tilemap(key, mapDataURL, mapData, format) → {Phaser.Loader}

Add a new tilemap loading request.

Parameters:

Name	Type	Argument	Default	Description
key	string			Unique asset key of the tilemap data.
mapDataURL	string	<optional>		The url of the map data file (csv/json)
mapData	object	<optional>		An optional JSON data object. If given then the mapDataURL is ignored and this JSON object is used for map data instead.
format	string	<optional>	Phaser.Tilemap.CSV	The format of the map data. Either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.

Source:

• loader/Loader.js, line 431

Returns:

This Loader instance.

Type

Phaser.Loader

tileset(key, url, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) → {Phaser.Loader}

Add a new tile set to the loader. These are used in the rendering of tile maps.

Parameters:

Name	Type	Argument	Default	Description
key	string			Unique asset key of the tileset file.
url	string			URL of the tileset.
tileWidth	number			Width of each single tile in pixels.
tileHeight	number			Height of each single tile in pixels.
tileMax	number	<optional>	-1	How many tiles in this tileset. If not specified it will divide the whole image into tiles.
tileMargin	number	<optional>	0	If the tiles have been drawn with a margin, specify the amount here.
tileSpacing	number	<optional>	0	If the tiles have been drawn with spacing between them, specify the amount here.

Source:

• loader/Loader.js, line 387

Returns:

This Loader instance.

Type

Phaser.Loader

totalLoadedFiles() → {number}

Returns the number of files that have already been loaded, even if they errored.

Source:

• loader/Loader.js, line 1255

Returns:

The number of files that have already been loaded (even if they errored)

Type

number

totalQueuedFiles() → {number}

Returns the number of files still waiting to be processed in the load queue. This value decreases as each file is in the queue is loaded.

Source:

• loader/Loader.js, line 1276

Returns:

The number of files that still remain in the load queue.

Type

number

xmlLoadComplete(index)

Successfully loaded an XML file.

Parameters:

Name	Type	Description
index	number	The index of the file in the file queue that loaded.

Source:

• loader/Loader.js, line 1150