XMLFile
A single XML File suitable for loading by the Phaser Loader. Once loaded, the XML response text is parsed into a DOM Document object and stored in the global XML Cache, keyed by the file key you provided. You can then retrieve it at any time via this.cache.xml.get(key) and traverse it using standard DOM methods.
These are created when you use the Phaser.Loader.LoaderPlugin#xml method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#xml.
Constructor
new XMLFile(loader, key, [url], [xhrSettings])
Parameters
| name | type | optional | description |
|---|---|---|---|
| loader | Phaser.Loader.LoaderPlugin | No | A reference to the Loader that is responsible for this file. |
| key | string | Phaser.Types.Loader.FileTypes.XMLFileConfig | No | The key to use for this file, or a file configuration object. |
| url | string | Yes | The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.xml, i.e. if key was "alien" then the URL will be "alien.xml". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/XMLFile.js#L15
Since: 3.0.0
Inherited Methods
From Phaser.Loader.File:
- addToCache
- destroy
- hasCacheConflict
- load
- onBase64Load
- onError
- onLoad
- onProcessComplete
- onProcessError
- onProgress
- pendingDestroy
- resetXHR
- setLink
Public Methods
onProcess
<instance> onProcess()
Description:
Called automatically by Loader.nextFile. Parses the raw XHR response text as XML using ParseXML and stores the resulting DOM Document in this.data. If parsing succeeds, onProcessComplete is called to add the document to the XML Cache and advance the load queue. If parsing fails (i.e. ParseXML returns a falsy value), onProcessError is called instead.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/XMLFile.js#L69
Since: 3.7.0
Inherited Members
From Phaser.Loader.File:
- base64
- bytesLoaded
- bytesTotal
- cache
- config
- crossOrigin
- data
- key
- linkFile
- loader
- multiFile
- percentComplete
- retryAttempts
- src
- state
- type
- url
- xhrLoader
- xhrSettings