Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractAssetTask

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

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

name: string

Task name

onErrorSearch playground for onError

onError: (task: any, message?: string, exception?: any) => void

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

onSuccessSearch playground for onSuccess

onSuccess: (task: any) => void

Callback called when the task is successful

Type declaration

    • (task: any): void
    • Parameters

      • task: any

      Returns void

Accessors

errorObject

  • get errorObject(): { exception?: any; message?: string }
  • Gets the current error object (if task is in error)

    Returns { exception?: any; message?: string }

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

isCompleted

  • get isCompleted(): boolean
  • Get if the task is completed

    Returns boolean

taskState

  • Gets the current state of the task

    Returns AssetTaskState

Methods

resetSearch playground for reset

  • 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

runSearch playground for run

  • run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void
  • 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

        • (): void
        • Returns void

    • onError: (message?: string, exception?: any) => void

      is a callback called if an error occurs

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

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

runTaskSearch playground for runTask

  • runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void
  • 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

        • (): void
        • Returns void

    • onError: (message?: string, exception?: any) => void

      is a callback called if an error occurs

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

          • Optional message: string
          • Optional exception: any

          Returns void

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method