Options
All
  • Public
  • Public/Protected
  • All
Menu

Define a task used by AssetsManager to load text content

Hierarchy

Index

Constructors

  • Creates a new TextFileAssetTask object

    Parameters

    • name: string

      defines the name of the task

    • url: string

      defines the location of the file to load

    Returns TextFileAssetTask

Properties

name: string

Defines the name of the task

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

Type declaration

    • Callback called when the task is successful

      Parameters

      Returns void

onSuccess: (task: TextFileAssetTask) => void

Type declaration

text: string

Gets the loaded text string

url: string

Defines the location of the file to load

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

Settings

Theme