Filter
Classes
Namespace
Members
Description:
File has finished processing.
Type:
Description:
File has been destroyed
Type:
Description:
The File has errored somehow during processing.
Type:
Description:
File failed to load
Type:
Description:
File has loaded successfully, awaiting processing
Type:
Description:
File has been started to load by the loader (onLoad called)
Type:
Description:
File is in the load queue but not yet started
Type:
Description:
File was populated from local data and doesn't need an HTTP request
Type:
Description:
File is being processed (onProcess callback)
Type:
Description:
The Loader has completed loading and processing.
Type:
Description:
The Loader has been destroyed.
Type:
Description:
The Loader is idle.
Type:
Description:
The Loader is actively loading.
Type:
Description:
The Loader is processing files is has loaded.
Type:
Description:
The Loader is shutting down.
Type:
Methods
Description:
Given a File and a baseURL value this returns the URL the File will use to download from.
Parameters:
| name | type | description |
|---|---|---|
| file | Phaser.Loader.File |
The File object. |
| baseURL | string |
A default base URL. |
Returns:
Description:
The URL the File will use.
Type:
- string
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 | description |
|---|---|---|
| global | Phaser.Types.Loader.XHRSettingsObject |
The global XHRSettings object. |
| local | Phaser.Types.Loader.XHRSettingsObject |
The local XHRSettings object. |
Returns:
Description:
A newly formed XHRSettings object.
Description:
Creates a new XMLHttpRequest (xhr) object based on the given File and XHRSettings and starts the download of it. It uses the Files own XHRSettings and merges them with the global XHRSettings object to set the xhr values before download.
Parameters:
| name | type | description |
|---|---|---|
| file | Phaser.Loader.File |
The File to download. |
| globalXHRSettings | Phaser.Types.Loader.XHRSettingsObject |
The global XHRSettings object. |
Returns:
Description:
The XHR object.
Type:
- XMLHttpRequest
Description:
Creates an XHRSettings Object with default values.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| responseType | XMLHttpRequestResponseType | <optional> | '' |
The responseType, such as 'text'. |
| 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. |
| withCredentials | boolean | <optional> | false |
Optional XHR withCredentials value. |
Returns:
Description:
The XHRSettings object as used by the Loader.