TextFileAssetTask

Class TextFileAssetTask

Define a task used by AssetsManager to load text content

Hierarchy

AbstractAssetTask
- TextFileAssetTask

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TextFileAssetTask(name: string, url: string): TextFileAssetTask

Overrides AbstractAssetTask.constructor
- Defined in .temp/docdirectory/doc.d.ts:65154
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

nameSearch playground for name

name: string

Defines the name of the task

onErrorSearch playground for onError

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

Callback called when the task is successful

Type declaration

- (task: TextFileAssetTask, message?: string, exception?: any): void
- Parameters
  - task: TextFileAssetTask
  - Optional message: string
  - Optional exception: any
  Returns void

onSuccessSearch playground for onSuccess

onSuccess: (task: TextFileAssetTask) => void

Callback called when the task is successful

Type declaration

- (task: TextFileAssetTask): void
- Parameters
  - task: TextFileAssetTask
  Returns void

textSearch playground for text

text: string

Gets the loaded text string

urlSearch playground for url

url: string

Defines the location of the file to load

Accessors

errorObject

get errorObject(): { exception?: any; message?: string }

Inherited from AbstractAssetTask.errorObject
- Defined in .temp/docdirectory/doc.d.ts:64901
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

Inherited from AbstractAssetTask.isCompleted
- Defined in .temp/docdirectory/doc.d.ts:64893
Get if the task is completed

Returns boolean

taskState

get taskState(): AssetTaskState

Inherited from AbstractAssetTask.taskState
- Defined in .temp/docdirectory/doc.d.ts:64897
Gets the current state of the task

Returns AssetTaskState

Methods

resetSearch playground for reset

reset(): void

Inherited from AbstractAssetTask.reset
- Defined in .temp/docdirectory/doc.d.ts:64930
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

Inherited from AbstractAssetTask.run
- Defined in .temp/docdirectory/doc.d.ts:64918
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

Overrides AbstractAssetTask.runTask
- Defined in .temp/docdirectory/doc.d.ts:65175
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