Coroutine<T>

package lua

extends Thread

@:native("_G.coroutine") Available on lua

Externs for native Lua coroutines.

Static methods

static create<T> (f:T ):Coroutine<T>

Creates a new coroutine, with body f. f must be a Lua function.

static resume (c:Coroutine<Dynamic>, args:Rest<Dynamic>):CoroutineResume

Starts or continues the execution of coroutine. The first time you resume a coroutine, it starts running its body. The values args are passed as the arguments to the body function. If the coroutine has yielded, resume restarts it; the values args are passed as the results from the yield.

If the coroutine runs without any errors, resume returns true plus any values passed to yield (if the coroutine yields) or any values returned by the body function (if the coroutine terminates). If there is any error, resume returns false plus the error message.

static running ():CoroutineRunning

Returns the running coroutine plus a boolean, true when the running coroutine is the main one.

static status (c:Coroutine<Dynamic>):CoroutineState

Returns the status of coroutine.

static wrap<T> (f:T ):Coroutine<T>

Creates a new coroutine, with body f. Returns a function that resumes the coroutine each time it is called. Any arguments passed to the function behave as the extra arguments to resume. Returns the same values returned by resume, except the first boolean. In case of error, propagates the error.

static yield<T> (args:Rest<T>):T

Suspends the execution of the calling coroutine. The coroutine cannot be running a C function, a metamethod, or an iterator. Any arguments to yield are passed as extra results to resume.