AbstractAssetTask

Define an abstract asset task used with a AssetsManager class to load assets into a scene

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • Creates a new AssetsManager

    Parameters

    • name: string

      defines the name of the task

    Returns AbstractAssetTask

Properties

errorObject

Find examples in Playground
errorObject: object

Gets the current error object (if task is in error)

Type declaration

  • Optional exception?: any
  • Optional message?: string

isCompleted

Find examples in Playground
isCompleted: boolean

Get if the task is completed

name

Find examples in Playground
name: string

Task name

onError

Find examples in Playground
onError: function

Callback called when the task is not successful

Type declaration

    • (task: any, message?: string, exception?: any): void
    • Parameters

      • task: any
      • Optional message: string
      • Optional exception: any

      Returns void

onSuccess

Find examples in Playground
onSuccess: function

Callback called when the task is successful

Type declaration

    • (task: any): void
    • Parameters

      • task: any

      Returns void

taskState

Find examples in Playground
taskState: AssetTaskState

Gets the current state of the task

Methods

reset

Find examples in Playground
  • reset(): void
  • 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

Find examples in Playground
  • run(scene: Scene, onSuccess: function, onError: function): void
  • Execute the current task

    Parameters

    • scene: Scene

      defines the scene where you want your assets to be loaded

    • onSuccess: function

      is a callback called when the task is successfully executed

        • (): void
        • Returns void

    • onError: function

      is a callback called if an error occurs

        • (message?: string, exception?: any): void
        • Parameters

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

runTask

Find examples in Playground
  • runTask(scene: Scene, onSuccess: function, onError: function): void
  • Execute the current task

    Parameters

    • scene: Scene

      defines the scene where you want your assets to be loaded

    • onSuccess: function

      is a callback called when the task is successfully executed

        • (): void
        • Returns void

    • onError: function

      is a callback called if an error occurs

        • (message?: string, exception?: any): void
        • Parameters

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

Generated using TypeDoc