Phaser.Types.Loader - Phaser 3 API Documentation (beta)

Hide inherited members:

show private members:

Namespace: Loader

Phaser.Types.Loader

Source: src/loader/typedefs/index.js (Line 7)

FileConfig

name	type	arguments	Default	description
type	string			The file type string (image, json, etc) for sorting within the Loader.
key	string			Unique cache key (unique within its file type)
url	string	<optional>		The URL of the file, not including baseURL.
path	string	<optional>		The path of the file, not including the baseURL.
extension	string	<optional>		The default extension this file uses.
responseType	XMLHttpRequestResponseType	<optional>		The responseType to be used by the XHR request.
xhrSettings	false \| Phaser.Types.Loader.XHRSettingsObject	<optional>	false	Custom XHR Settings specific to this file and merged with the Loader defaults.
config	any	<optional>		A config object that can be used by file types to store transitional data.

object

Since: 3.0.0

Source: src/loader/typedefs/FileConfig.js (Line 1)

XHRSettingsObject

name	type	arguments	Default	description
responseType	XMLHttpRequestResponseType			The response type of the XHR request, i.e. `blob`, `text`, etc.
async	boolean	<optional>	true	Should the XHR request use async or not?
user	string	<optional>	''	Optional username for the XHR request.
password	string	<optional>	''	Optional password for the XHR request.
timeout	number	<optional>	0	Optional XHR timeout value.
headers	object \| undefined	<optional>		This value is used to populate the XHR `setRequestHeader` and is undefined by default.
header	string \| undefined	<optional>		This value is used to populate the XHR `setRequestHeader` and is undefined by default.
headerValue	string \| undefined	<optional>		This value is used to populate the XHR `setRequestHeader` and is undefined by default.
requestedWith	string \| undefined	<optional>		This value is used to populate the XHR `setRequestHeader` and is undefined by default.
overrideMimeType	string \| undefined	<optional>		Provide a custom mime-type to use instead of the default.
withCredentials	boolean	<optional>	false	The withCredentials property indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.

object

Since: 3.0.0

Source: src/loader/typedefs/XHRSettingsObject.js (Line 1)