coroutine.create
Lua function

coroutine.create

Summary

Creates a new coroutine thread

Prototype

thread = coroutine.create (f)


Description

Creates a thread consisting of the body f.


thread = coroutine.create (f)


Then you can resume it with coroutine.resume.

For example:


function f (a, b, c)
  print (a, b, c)
end -- f

thread = coroutine.create (f)  -- thread will run function f
assert (coroutine.resume (thread, 1, 2, 3))  -- start thread, passing arguments: 1, 2, 3


See Also ...

Topics

DOC_lua_base Lua base functions
DOC_lua_bc Lua bc (big number) functions
DOC_lua_bit Lua bit manipulation functions
DOC_lua_coroutines Lua coroutine functions
DOC_lua_debug Lua debug functions
DOC_lua_io Lua io functions
DOC_lua_math Lua math functions
DOC_lua_os Lua os functions
DOC_lua_package Lua package functions
DOC_lua_rex Lua PCRE regular expression functions
DOC_lua Lua script extensions
DOC_lua_string Lua string functions
DOC_lua_tables Lua table functions
DOC_lua_utils Lua utilities
DOC_scripting Scripting

Lua functions

LUA_coroutine.resume coroutine.resume (Start or resume a thread)
LUA_coroutine.running coroutine.running (Returns the running coroutine)
LUA_coroutine.status coroutine.status (Returns the status of a thread)
LUA_coroutine.wrap coroutine.wrap (Creates a thread and returns a function to resume it)
LUA_coroutine.yield coroutine.yield (Yields execution of thread back to the caller)

(Help topic: lua=coroutine.create)

DOC_contents Documentation contents page