Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

Index

Constructors

  • Creates a new AssetsManager

    Parameters

    • name: string

      defines the name of the task

    Returns AbstractAssetTask

Properties

name: string

Task name

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

Type declaration

    • (task: any, message?: string, exception?: any): void
    • Callback called when the task is not successful

      Parameters

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

      Returns void

onSuccess: ((task: any) => void)

Type declaration

    • (task: any): void
    • Callback called when the task is successful

      Parameters

      • task: any

      Returns void

Accessors

  • 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
  • get isCompleted(): boolean
  • Get if the task is completed

    Returns boolean

  • Gets the current state of the task

    Returns AssetTaskState

Methods

  • 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(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

  • 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 constructor
  • Static method

Settings

Theme