Difference between revisions of "Coroutine.wrap"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Creates a new coroutine and returns a function that, when called, resumes the coroutine.
 
Creates a new coroutine and returns a function that, when called, resumes the coroutine.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(function) = coroutine.wrap(f)
 
(function) = coroutine.wrap(f)
 
</source>
 
</source>

Revision as of 15:26, 13 July 2023

Available since: Gideros 2011.6
Class: coroutine

Description

Creates a new coroutine and returns a function that, when called, resumes the coroutine. <syntaxhighlight lang="lua"> (function) = coroutine.wrap(f) </source>

Creates a new coroutine, with body f. f must be a Lua function. 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

Parameters

f: (function) lua function

Return values

Returns (function) function that resumes coroutine every time it is called, behaving similar to coroutine.resume