Task Class

Module: cc.AssetManager

Task is used to run in the pipeline for some effect

Index

Properties

• id Number The id of task
• onComplete Function The callback when task is completed
• onProgress Function The callback of progression
• onError Function The callback when something goes wrong
• source * The source of task
• output * The output of task
• input * The input of task
• progress * The progression of task
• options Object Custom options
• isFinish Boolean Whether or not this task is completed

Methods

• constructor Create a new Task
• set Set paramters of this task
• dispatch Dispatch event
• recycle Recycle this for reuse
• create Create a new task from pool

Details

Properties

id

The id of task

onComplete

The callback when task is completed

onProgress

The callback of progression

onError

The callback when something goes wrong

source

The source of task

output

The output of task

input

The input of task

progress

The progression of task

options

Custom options

isFinish

Whether or not this task is completed

Methods

constructor

Create a new Task

Parameters

• options Object Some optional paramters
  • onComplete Function Callback when the task is completed, if the pipeline is synchronous, onComplete is unnecessary.
  • onProgress Function Continuously callback when the task is runing, if the pipeline is synchronous, onProgress is unnecessary.
  • onError Function Callback when something goes wrong, if the pipeline is synchronous, onError is unnecessary.
  • input Something will be handled with pipeline
  • progress Progress information, you may need to assign it manually when multiple pipeline share one progress
  • options Object Custom parameters

set

Set paramters of this task

Parameters

• options Object Some optional paramters
  • onComplete Function Callback when the task complete, if the pipeline is synchronous, onComplete is unnecessary.
  • onProgress Function Continuously callback when the task is runing, if the pipeline is synchronous, onProgress is unnecessary.
  • onError Function Callback when something goes wrong, if the pipeline is synchronous, onError is unnecessary.
  • input Something will be handled with pipeline
  • progress Progress information, you may need to assign it manually when multiple pipeline share one progress
  • options Object Custom parameters

Examples

var task = new Task();
task.set({input: ['test'], onComplete: (err, result) => console.log(err), onProgress: (finish, total) => console.log(finish / total)});

dispatch

Dispatch event

Parameters

• event string The event name
• param1 Any Parameter 1
• param2 Any Parameter 2
• param3 Any Parameter 3
• param4 Any Parameter 4

Examples

var task = Task.create();
Task.onComplete = (msg) => console.log(msg);
Task.dispatch('complete', 'hello world');

recycle

Recycle this for reuse

create

Create a new task from pool

Parameters

• options Object Some optional paramters
  • onComplete Function Callback when the task complete, if the pipeline is synchronous, onComplete is unnecessary.
  • onProgress Function Continuously callback when the task is runing, if the pipeline is synchronous, onProgress is unnecessary.
  • onError Function Callback when something goes wrong, if the pipeline is synchronous, onError is unnecessary.
  • input Something will be handled with pipeline
  • progress Progress information, you may need to assign it manually when multiple pipeline share one progress
  • options Object Custom parameters