Class BinaryFileAssetTask
Hierarchy
- AbstractAssetTask
- BinaryFileAssetTask
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new BinaryFileAssetTask object
Parameters
name: string
defines the name of the new task
url: string
defines the location of the file to load
Returns BinaryFileAssetTask
Properties
dataSearch playground for data
Gets the loaded data (as an array buffer)
nameSearch playground for name
Defines the name of the task
on ErrorSearch playground for onError
Type declaration
Callback called when the task is successful
Parameters
task: BinaryFileAssetTask
Optional message: string
Optional exception: any
Returns void
on SuccessSearch playground for onSuccess
Type declaration
Callback called when the task is successful
Parameters
task: BinaryFileAssetTask
Returns void
urlSearch playground for url
Defines the location of the file to load
Accessors
error Object
Gets the current error object (if task is in error)
Returns { exception?: any; message?: string }
Optional exception?: any
Optional message?: string
is Completed
Get if the task is completed
Returns boolean
task State
Gets the current state of the task
Returns AssetTaskState
Methods
resetSearch playground for reset
Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again. This can be used with failed tasks that have the reason for failure fixed.
Returns void
runSearch playground for run
Execute the current task
Parameters
scene: Scene
defines the scene where you want your assets to be loaded
onSuccess: (() => void)
is a callback called when the task is successfully executed
Returns void
onError: ((message?: string, exception?: any) => void)
is a callback called if an error occurs
Parameters
Optional message: string
Optional exception: any
Returns void
Returns void
run TaskSearch playground for runTask
Execute the current task
Parameters
scene: Scene
defines the scene where you want your assets to be loaded
onSuccess: (() => void)
is a callback called when the task is successfully executed
Returns void
onError: ((message?: string, exception?: any) => void)
is a callback called if an error occurs
Parameters
Optional message: string
Optional exception: any
Returns void
Returns void
Define a task used by AssetsManager to load binary data