Task 类型

模块: cc.AssetManager

任务用于在管线中运行以达成某种效果

索引

属性（properties）

• id Number 任务id
• onComplete Function 完成回调
• onProgress Function 进度回调
• onError Function 错误回调
• source * 任务的源
• output * 任务的输出
• input * 任务的输入
• progress * 任务的进度
• options Object 自定义参数
• isFinish Boolean 此任务是否已经完成

方法

• constructor 创建一个任务
• set 设置任务的参数
• dispatch 发布事件
• recycle 回收 task 用于复用
• create 从对象池中创建 task

Details

属性（properties）

id

任务id

onComplete

完成回调

onProgress

进度回调

onError

错误回调

source

任务的源

output

任务的输出

input

任务的输入

progress

任务的进度

options

自定义参数

isFinish

此任务是否已经完成

方法

constructor

创建一个任务

参数列表

• 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

设置任务的参数

参数列表

• 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

示例

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

dispatch

发布事件

参数列表

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

示例

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

recycle

回收 task 用于复用

create

从对象池中创建 task

参数列表

• 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