Class: ThrottledTaskQueueProcess
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:46
A process which dispatches tasks in a task queue potentially over multiple frames.
Constructors
Constructor
new ThrottledTaskQueueProcess(
queue,handler):ThrottledTaskQueueProcess
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:56
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
queue | TaskQueue | The queue to process. |
handler | ThrottledTaskQueueHandler | A handler which defines the behavior of this process. |
Returns
ThrottledTaskQueueProcess
Methods
abort()
abort():
void
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:116
Aborts this process. Has no effect if the process has not been started or if it has already ended.
Returns
void
hasEnded()
hasEnded():
boolean
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:71
Checks whether this process has ended.
Returns
boolean
whether this process has ended.
hasStarted()
hasStarted():
boolean
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:63
Checks whether this process has been started.
Returns
boolean
whether this process has been started.
start()
start():
void
Defined in: src/sdk/utils/task/ThrottledTaskQueueProcess.ts:78
Starts this process.
Returns
void