task

Accepts a function or a thread (as returned by coroutine.create) and calls/resumes it immediately through the engine's scheduler. Arguments after the first are sent to the function/thread.

This function is based on the fastSpawn pattern rather than being a replacement for the deprecated global spawn function. It is recommended that this function be used in place of fastSpawn.

If the calling script is currently running in a serial execution phase, then the spawned function or thread is resumed in the current serial execution phase. If the calling script is currently running in a parallel execution phase, then the spawned function or thread is resumed in the current parallel execution phase. For more information, see Parallel Luau.

Accepts a function or a thread (as returned by coroutine.create) and defers it until the end of the current resumption cycle, at which point it is resumed with the engine's scheduler like with task.spawn(). Arguments after the first are sent to the function/thread.

This function should be used when a similar behavior to task.spawn() is desirable, but the thread does not need to run immediately.

If the calling script is currently running in a serial execution phase, then the deferred function or thread is resumed in a serial execution phase. If the calling script is currently running in a parallel execution phase, then the deferred function or thread is resumed in a parallel execution phase. For more information, see Parallel Luau.

Accepts a function or a thread (as returned by coroutine.create) and schedules it to be called/resumed on the next Heartbeat after the given amount of time in seconds has elapsed. Arguments after the second are sent to the function/thread.

This function differs from the deprecated global delay function in that no throttling occurs: on the very same Heartbeat step in which enough time has passed, the function is guaranteed to be called/resumed. Providing a duration of zero (0) will guarantee that the function is called on the very next Heartbeat.

You can calculate the actual time passed by calling os.clock() upon scheduling and in the scheduled function.

If the calling script is currently running in a serial execution phase, then the delayed function or thread is resumed in a serial execution phase. If the calling script is currently running in a parallel execution phase, then the delayed function or thread is resumed in a parallel execution phase. For more information, see Parallel Luau.

If the calling script is currently running in a serial execution phase, desynchronize suspends the script and the script will be resumed in the next parallel execution phase. If the calling script is currently running in a parallel execution phase, desynchronize returns immediately and has no effect.

Only scripts which are descendants of an Actor may call this method. If a script outside of an Actor calls this method, an error will be raised. ModuleScript's may also call desynchronize as long as the instantiation of the module calling it was required by a script that is a descendant of an Actor.

For more information, see Parallel Luau.

If the calling script is currently running in a parallel execution phase, synchronize suspends the script and the script will be resumed in the next serial execution phase. If the calling script is currently running in a serial execution phase, synchronize returns immediately and has no effect.

Only scripts which are descendants of an Actor may call this method. If a script outside of an Actor calls this method, an error will be raised. ModuleScript's may also call synchronize as long as the instantiation of the module calling it was required by a script that is a descendant of an Actor.

For more information, see Parallel Luau.

Yields the current thread until the given duration (in seconds) has elapsed, then resumes the thread on the next Heartbeat step. The actual amount of time elapsed is returned.

If no duration is given, it will default to zero (0). This means the thread resumes on the very next step, which is equivalent in behavior to RunService.Heartbeat:Wait()

Unlike the deprecated global wait, this function does not throttle and guarantees the resumption of the thread on the first Heartbeat that occurs when it is due. This function also only returns the elapsed time and nothing else.

If the calling script is currently running in a serial execution phase, then the script is resumed in a serial execution phase. If the calling script is currently running in a parallel execution phase, then the script is resumed in a parallel execution phase. For more information, see Parallel Luau.

Cancels a thread and closes it, preventing it from being resumed manually or by the task scheduler.

This function can be used with other members of the task library that return a thread to cancel them before they are resumed. For example:

local thread = task.delay(5, function()
	print("Hello world!")
end)

task.cancel(thread)

Note: Threads may be in a state where it is impossible to cancel them. For example, the currently executing thread and threads that have resumed another coroutine may not be cancelled. If this is the case, a lua error will be generated.

However, code should not rely on specific thread states or conditions causing task.cancel() to fail. It is possible that future updates will eliminate these constraints and allow threads in these states to be successfully cancelled.