BinaryFile
A single Binary File suitable for loading by the Loader.
Binary files are used to load raw binary data, such as custom level formats, game data archives, or any file whose contents must be handled as an ArrayBuffer rather than parsed text or an image. Once loaded, the data is stored in the Binary Cache and can optionally be cast to a typed array (e.g. Uint8Array) automatically by providing a dataType constructor.
These are created when you use the Phaser.Loader.LoaderPlugin#binary method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#binary.
Constructor
new BinaryFile(loader, key, [url], [xhrSettings], [dataType])
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.BinaryFileConfig | 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>.bin, i.e. if key was "alien" then the URL will be "alien.bin". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
| dataType | any | Yes | Optional type to cast the binary file to once loaded. For example, Uint8Array. |
Scope: static
Extends
Source: src/loader/filetypes/BinaryFile.js#L14
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. This method processes the raw XHR response: if a dataType constructor was specified (e.g. Uint8Array), it wraps the ArrayBuffer response in a new instance of that type; otherwise the raw ArrayBuffer is stored directly as the file's data.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/BinaryFile.js#L74
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