ImageAssetTask

Define a task used by AssetsManager to load images

Hierarchy

Index

Constructors

constructor

Find examples in Playground

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

image

Find examples in Playground
image: HTMLImageElement

Gets the loaded images

isCompleted

Find examples in Playground
isCompleted: boolean

Get if the task is completed

name

Find examples in Playground
name: string

Defines the name of the task

onError

Find examples in Playground
onError: function

Callback called when the task is successful

Type declaration

    • Parameters

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

      Returns void

onSuccess

Find examples in Playground
onSuccess: function

Callback called when the task is successful

Type declaration

taskState

Find examples in Playground
taskState: AssetTaskState

Gets the current state of the task

url

Find examples in Playground
url: string

Defines the location of the image to load

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