Class AbstractAssetTask
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new AssetsManager
Parameters
-
name: string
defines the name of the task
Returns AbstractAssetTask
-
Properties
nameSearch playground for name
Task name
on ErrorSearch playground for onError
Callback called when the task is not successful
Type declaration
-
-
Parameters
-
task: any
-
Optional message: string
-
Optional exception: any
Returns void
-
-
on SuccessSearch playground for onSuccess
Callback called when the task is successful
Type declaration
-
-
Parameters
-
task: any
Returns void
-
-
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 an abstract asset task used with a AssetsManager class to load assets into a scene