coroutine

Show Deprecated

A coroutine is used to perform multiple tasks at the same time from within the same script. Such tasks might include producing values from inputs or performing work on a subroutine when solving a larger problem. A task doesn't even need to have a defined ending point, but it does need to define particular times at which it yields (pause) to let other things be worked on. See Coroutine basics to learn more.

Using Coroutines

A new coroutine can be created by providing a function to coroutine.create(). Once created, a coroutine doesn't begin running until the first call to coroutine.resume() which passes the arguments to the function. This call returns when the function either halts or calls coroutine.yield() and, when this happens, coroutine.resume() returns either the values returned by the function, the values sent to coroutine.yield(), or an error message. If it does error, the second return value is the thrown error.


local function task(...)
-- This function might do some work for a bit then yield some value
coroutine.yield("first") -- To be returned by coroutine.resume()
-- The function continues once it is resumed again
return "second"
end
local taskCoro = coroutine.create(task)
-- Call resume for the first time, which runs the function from the beginning
local success, result = coroutine.resume(taskCoro, ...)
print(success, result) --> true, first (task called coroutine.yield())
-- Continue running the function until it yields or halts
success, result = coroutine.resume(taskCoro)
print(success, result) --> true, second (task halted because it returned "second")

During the lifetime of the coroutine, you can call coroutine.status() to inspect its status:

StatusMeaning
suspendedThe coroutine is waiting to be resumed. Coroutines begin in this state and enter it when their function calls coroutine.yield().
runningThe coroutine is running right now.
normalThe coroutine is awaiting the yield of another coroutine; in other words, it has resumed another coroutine.
deadThe function has halted (returned or thrown an error). The coroutine cannot be used further.

Wrapping Coroutines

When working with coroutines, you can also forgo the use of the coroutine object and instead use a wrapper function. Such a wrapper function will resume a particular coroutine when it is called and will return only the yielded values. You can do this using coroutine.wrap():


-- Create coroutine and return a wrapper function that resumes it
local f = coroutine.wrap(task)
-- Resume the coroutine as if we called coroutine.resume()
local result = f()
-- If an error occurs it will be raised here!
-- This differs from coroutine.resume() which acts similar to pcall()

The first value returned from coroutine.resume() describes whether a coroutine ran without errors. However, functions returned by coroutine.wrap() will not do this: instead they directly return the values returned or passed to coroutine.yield(), if any. Should an error have occurred while running the coroutine function, the error is raised on the call of the returned function.

Producer Pattern Example

Imagine a task that produces repetitions of a word: each time it produces a repetition, the next one will produce one more. For example, providing Hello will produce Hello, HelloHello, HelloHelloHello, etc. To do this, you can define repeatThis():


-- This function repeats a word every time its coroutine is resumed
local function repeatThis(word)
local repetition = ""
while true do
-- Do one repetition then yield the result
repetition = repetition .. word
coroutine.yield(repetition)
end
end

To run this function as a coroutine, you can use coroutine.create() followed by multiple calls to coroutine.resume():


local repetitionCoro = coroutine.create(repeatThis)
print(coroutine.resume(repetitionCoro, "Hello")) -- true, Hello
print(coroutine.resume(repetitionCoro)) -- true, HelloHello
print(coroutine.resume(repetitionCoro)) -- true, HelloHelloHello

For this producer function, you can also use coroutine.wrap() to get a function that produces values:


local f = coroutine.wrap(repeatThis)
print(f("Hello")) -- Hello
print(f()) -- HelloHello
print(f()) -- HelloHelloHello

Summary

Functions

close(co: thread): boolean  

resume(co: thread, ...: Variant): boolean  

status(co: thread): string  

yield(...: Tuple): Tuple<Variant>  

Functions

close

Parameters

co: thread

Returns

Variant<string, void>

create

Parameters

Returns

isyieldable

Returns

resume

Parameters

co: thread
...: Variant

Returns

running

Returns

status

Parameters

co: thread

Returns

Parameters

Returns

yield

Tuple<Variant>

Parameters

...: Tuple

Returns

Tuple<Variant>