Phaser.Loader
Scope: static
Source: src/loader/index.js#L10
Static functions
Static functions
FILE_COMPLETE
FILE_COMPLETE: number
Description:
File has finished processing.
Source: src/loader/const.js#L117
Since: 3.0.0
FILE_DESTROYED
FILE_DESTROYED: number
Description:
File has been destroyed.
Source: src/loader/const.js#L126
Since: 3.0.0
FILE_ERRORED
FILE_ERRORED: number
Description:
The file encountered an error during processing.
Source: src/loader/const.js#L108
Since: 3.0.0
FILE_FAILED
FILE_FAILED: number
Description:
File failed to load.
Source: src/loader/const.js#L90
Since: 3.0.0
FILE_LOADED
FILE_LOADED: number
Description:
File has loaded successfully, awaiting processing.
Source: src/loader/const.js#L81
Since: 3.0.0
FILE_LOADING
FILE_LOADING: number
Description:
File has started loading by the loader (onLoad called).
Source: src/loader/const.js#L72
Since: 3.0.0
FILE_PENDING
FILE_PENDING: number
Description:
File is in the load queue but not yet started.
Source: src/loader/const.js#L63
Since: 3.0.0
FILE_PENDING_DESTROY
FILE_PENDING_DESTROY: number
Description:
File is pending destruction.
Source: src/loader/const.js#L144
Since: 3.60.0
FILE_POPULATED
FILE_POPULATED: number
Description:
File was populated from local data and doesn't need an HTTP request.
Source: src/loader/const.js#L135
Since: 3.0.0
FILE_PROCESSING
FILE_PROCESSING: number
Description:
File is being processed (onProcess callback).
Source: src/loader/const.js#L99
Since: 3.0.0
LOADER_COMPLETE
LOADER_COMPLETE: number
Description:
The Loader has completed loading and processing.
Source: src/loader/const.js#L36
Since: 3.0.0
LOADER_DESTROYED
LOADER_DESTROYED: number
Description:
The Loader has been destroyed.
Source: src/loader/const.js#L54
Since: 3.0.0
LOADER_IDLE
LOADER_IDLE: number
Description:
The Loader is idle.
Source: src/loader/const.js#L9
Since: 3.0.0
LOADER_LOADING
LOADER_LOADING: number
Description:
The Loader is actively loading.
Source: src/loader/const.js#L18
Since: 3.0.0
LOADER_PROCESSING
LOADER_PROCESSING: number
Description:
The Loader is processing files it has loaded.
Source: src/loader/const.js#L27
Since: 3.0.0
LOADER_SHUTDOWN
LOADER_SHUTDOWN: number
Description:
The Loader is shutting down.
Source: src/loader/const.js#L45
Since: 3.0.0
Static functions
Static functions
GetURL
<static> GetURL(file, baseURL)
Description:
Given a File and a baseURL value, this returns the URL the File will use to download from.
If the file has no URL, false is returned. If the file URL is already absolute (i.e. it begins with blob:, data:, capacitor://, file://, http://, https://, or //), it is returned as-is. Otherwise, the baseURL is prepended to the file URL to form a complete URL.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| file | Phaser.Loader.File | No | The File object whose URL will be resolved. |
| baseURL | string | No | A default base URL to prepend when the file URL is relative. |
Returns: string - The resolved URL the File will use to download from, or false if the file has no URL.
Source: src/loader/GetURL.js#L7
Since: 3.0.0
MergeXHRSettings
<static> MergeXHRSettings(global, local)
Description:
Takes two XHRSettings Objects and creates a new XHRSettings object from them.
The new object is seeded by the values given in the global settings, but any setting in the local object overrides the global ones.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| global | Phaser.Types.Loader.XHRSettingsObject | No | The global XHRSettings object. |
| local | Phaser.Types.Loader.XHRSettingsObject | No | The local XHRSettings object. |
Returns: Phaser.Types.Loader.XHRSettingsObject - A newly formed XHRSettings object.
Source: src/loader/MergeXHRSettings.js#L10
Since: 3.0.0
XHRLoader
<static> XHRLoader(file, globalXHRSettings)
Description:
Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings and starts the download of it. It uses the File's own XHRSettings and merges them with the global XHRSettings object to set the xhr values before download.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| file | Phaser.Loader.File | No | The File to download. |
| globalXHRSettings | Phaser.Types.Loader.XHRSettingsObject | No | The global XHRSettings object. |
Returns: XMLHttpRequest - The XHR object. For base64 files, file.onBase64Load is called directly and this function returns undefined.
Source: src/loader/XHRLoader.js#L9
Since: 3.0.0
XHRSettings
<static> XHRSettings([responseType], [async], [user], [password], [timeout], [withCredentials])
Description:
Creates an XHRSettings Object with default values.
The XHRSettings object is used by the Phaser Loader when making XMLHttpRequest calls to fetch external assets such as images, audio, JSON, and other files. You can pass a custom XHRSettings object to individual file load calls (e.g., this.load.image) to override the default request configuration on a per-file basis, or set global defaults via the Loader's xhr property. This is useful when loading from servers that require authentication credentials, custom headers, a specific MIME type override, or a non-default response type.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| responseType | XMLHttpRequestResponseType | Yes | "''" | The responseType, such as 'text'. |
| async | boolean | Yes | true | Should the XHR request use async or not? |
| user | string | Yes | "''" | Optional username for the XHR request. |
| password | string | Yes | "''" | Optional password for the XHR request. |
| timeout | number | Yes | 0 | Optional XHR timeout value, in milliseconds. A value of 0 disables the timeout. |
| withCredentials | boolean | Yes | false | Optional XHR withCredentials value. |
Returns: Phaser.Types.Loader.XHRSettingsObject - The XHRSettings object as used by the Loader.
Source: src/loader/XHRSettings.js#L7
Since: 3.0.0