Class AnimationAssetTask
Hierarchy
- AbstractAssetTask
- AnimationAssetTask
Index
Constructors
constructor
Creates a new AnimationAssetTask
Parameters
name: string
defines the name of the task
rootUrl: string
defines the root url to use as a base to load your meshes and associated resources
filename: string | File
defines the filename or File of the scene to load from
Optional targetConverter: Nullable<((target: any) => any)>
defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
Optional extension: string
Returns AnimationAssetTask
Properties
Optional extensionSearch playground for extension
Defines the extension to use to load the scene (if not defined, ".babylon" will be used)
filenameSearch playground for filename
Defines the filename to load from
loaded
Gets the list of loaded animatables
loaded
Gets the list of loaded animation groups
nameSearch playground for name
Defines the name of the task
on
Type declaration
Callback called when the task is successful
Parameters
task: AnimationAssetTask
Optional message: string
Optional exception: any
Returns void
on
Type declaration
Callback called when the task is successful
Parameters
task: AnimationAssetTask
Returns void
root
Defines the root url to use as a base to load your meshes and associated resources
Optional target
Defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
Accessors
error
Gets the current error object (if task is in error)
Returns { exception?: any; message?: string }
Optional exception?: any
Optional message?: string
is
Get if the task is completed
Returns boolean
task
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
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 animations