Class ImageAssetTask
Hierarchy (View Summary)
- AbstractAssetTask
- ImageAssetTask
Constructors
constructor
-
Creates a new ImageAssetTask
Parameters
- name: string
defines the name of the task
- url: string
defines the location of the image to load
Returns ImageAssetTask
- name: string
Properties
image
Gets the loaded images
name
Defines the name of the task
on
Callback called when the task is successful
on
Callback called when the task is successful
url
Defines the location of the image to load
Accessors
error
-
get errorObject(): { exception?: any; message?: string }
Gets the current error object (if task is in error)
Returns { exception?: any; message?: string }
is
-
get isCompleted(): boolean
Get if the task is completed
Returns boolean
task
-
Gets the current state of the task
Returns AssetTaskState
Methods
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
run
-
run(
scene: Scene,
onSuccess: () => void,
onError: (message?: string, exception?: any) => void,
): voidExecute 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
- onError: (message?: string, exception?: any) => void
is a callback called if an error occurs
Returns void
- scene: Scene
run
-
runTask(
scene: Scene,
onSuccess: () => void,
onError: (message?: string, exception?: any) => void,
): voidExecute 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
- onError: (message?: string, exception?: any) => void
is a callback called if an error occurs
Returns void
- scene: Scene
Define a task used by AssetsManager to load images