Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageAssetTask

Define a task used by AssetsManager to load images

Hierarchy

Index

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

Properties

imageSearch playground for image

image: HTMLImageElement

Gets the loaded images

nameSearch playground for name

name: string

Defines the name of the task

onErrorSearch playground for onError

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

Callback called when the task is successful

Type declaration

    • Parameters

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

      Returns void

onSuccessSearch playground for onSuccess

onSuccess: (task: ImageAssetTask) => void

Callback called when the task is successful

Type declaration

urlSearch playground for url

url: string

Defines the location of the image to load

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

taskState

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