Task
Built-in task scheduler & thread spawning
Example usage
Section titled “Example usage”local task = require("@lune/task")
-- Waiting for a certain amount of timetask.wait(1)print("Waited for one second")
-- Running a task after a given amount of timetask.delay(2, function() print("Ran after two seconds")end)
-- Spawning a new task that runs concurrentlytask.spawn(function() print("Running instantly") task.wait(1) print("One second passed inside the task")end)
print("Running after task.spawn yields")
Functions
Section titled “Functions”cancel
Section titled “cancel”Stops a currently scheduled thread from resuming.
Parameters
Section titled “Parameters”thread
The thread to cancel
Defers a thread or function to run at the end of the current task queue.
Parameters
Section titled “Parameters”-
functionOrThread
The function or thread to defer -
...
T…
Returns
Section titled “Returns”- The thread that will be deferred
Delays a thread or function to run after duration
seconds.
Parameters
Section titled “Parameters”-
duration
number -
functionOrThread
The function or thread to delay -
...
T…
Returns
Section titled “Returns”- The thread that will be delayed
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
Section titled “Parameters”-
functionOrThread
The function or thread to spawn -
...
T…
Returns
Section titled “Returns”- The thread that was spawned
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
Section titled “Parameters”duration
The amount of time to wait
Returns
Section titled “Returns”- The exact amount of time waited