NAME

lua_yield — yields a coroutine, function indicator [-?, +?, -]

SYNOPSIS

#include <lua.h>

int
lua_yield(lua_State *L, int nresults);

DESCRIPTION

lua_yield() yields a coroutine. This function should only be called as the return expression of a C function, as follows:

return lua_yield (L, nresults);

When a C function calls lua_yield in that way, the running coroutine suspends its execution, and the call to lua_resume that started this coroutine returns. The parameter nresults is the number of values from the stack that are passed as results to lua_resume(3).

SEE ALSO

Roberto Ierusalimschy, Luiz Henrique de Figueiredo, and Waldemar Celes, Lua 5.1 Reference Manual.

HISTORY

The lua_yield() manual page is based on Lua Reference Manual 5.1 and was created by Sergey Bronnikov.