Task

Summary

Functions

Task.cancel(thread: thread)Task.defer(functionOrThread: thread | (T...) -> ...any, ...: T...) → threadTask.delay(duration: number, functionOrThread: thread | (T...) -> ...any, ...: T...) → threadTask.spawn(functionOrThread: thread | (T...) -> ...any, ...: T...) → threadTask.wait(duration: number?) → number

Functions

cancel

Task . cancel ( thread )  -> ()

Stops a currently scheduled thread from resuming.

Parameters

thread: thread

defer

Task . defer ( functionOrThread ,  ... )  -> thread

Defers a thread or function to run at the end of the current task queue.

Parameters

functionOrThread: any
...:

Returns

thread

delay

Task . delay ( duration ,  functionOrThread ,  ... )  -> thread

Delays a thread or function to run after duration seconds.

Parameters

duration: number
functionOrThread: any
...:

Returns

thread

spawn

Task . spawn ( functionOrThread ,  ... )  -> thread

Instantly runs a thread or function.

If the spawned task yields, the thread that spawned the task will resume, letting the spawned task run in the background.

Parameters

functionOrThread: any
...:

Returns

thread

wait

Task . wait ( duration )  -> number

Waits for at least the given amount of time.

The minimum wait time possible when using task.wait is limited by the underlying OS sleep implementation. For most systems this means task.wait is accurate down to about 5 milliseconds or less.

Parameters

duration: number?

Returns

number