CoroutineLib (luna-all-shaded 0.3 API)

java.lang.Object
- org.classdump.luna.lib.CoroutineLib

```
public final class CoroutineLib
extends Object
```
This library comprises the operations to manipulate coroutines, which come inside the table coroutine. See §2.6 of the Lua Reference Manual for a general description of coroutines.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static org.classdump.luna.runtime.LuaFunction`	`create()` Returns the function `coroutine.create`.
`static void`	`installInto(org.classdump.luna.StateContext context, org.classdump.luna.Table env)` Installs the coroutine library to the global environment `env` in the state context `context`.
`static org.classdump.luna.runtime.LuaFunction`	`isyieldable()` Returns the function `coroutine.isyieldable`.
`static org.classdump.luna.runtime.LuaFunction`	`resume()` Returns the function `coroutine.resume`.
`static org.classdump.luna.runtime.LuaFunction`	`running()` Returns the function `coroutine.running`.
`static org.classdump.luna.runtime.LuaFunction`	`status()` Returns the function `coroutine.status`.
`static org.classdump.luna.runtime.LuaFunction`	`wrap()` Returns the function `coroutine.wrap`.
`static org.classdump.luna.runtime.LuaFunction`	`yield()` Returns the function `coroutine.yield`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static org.classdump.luna.runtime.LuaFunction create()
```
    Returns the function coroutine.create.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.create (f)
    Creates a new coroutine, with body f. f must be a function. Returns this new coroutine, an object with type "thread".
    
    Returns:
    
    the coroutine.create function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.create
  - isyieldable
```
public static org.classdump.luna.runtime.LuaFunction isyieldable()
```
    Returns the function coroutine.isyieldable.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.isyieldable ()
    Returns true when the running coroutine can yield.
    
    A running coroutine is yieldable if it is not the main thread and it is not inside a non-yieldable C function.
    
    Returns:
    
    the coroutine.isyieldable function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.isyieldable
  - resume
```
public static org.classdump.luna.runtime.LuaFunction resume()
```
    Returns the function coroutine.resume.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.resume (co [, val1, ···])
    Starts or continues the execution of coroutine co. The first time you resume a coroutine, it starts running its body. The values val1, ... are passed as the arguments to the body function. If the coroutine has yielded, resume restarts it; the values val1, ... are passed as the results from the yield.
    
    If the coroutine runs without any errors, resume returns true plus any values passed to yield (when the coroutine yields) or any values returned by the body function (when the coroutine terminates). If there is any error, resume returns false plus the error message.
    
    Returns:
    
    the coroutine.resume function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.resume
  - running
```
public static org.classdump.luna.runtime.LuaFunction running()
```
    Returns the function coroutine.running.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.running ()
    Returns the running coroutine plus a boolean, true when the running coroutine is the main one.
    
    Returns:
    
    the coroutine.running function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.running
  - status
```
public static org.classdump.luna.runtime.LuaFunction status()
```
    Returns the function coroutine.status.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.status (co)
    Returns the status of coroutine co, as a string: "running", if the coroutine is running (that is, it called status); "suspended", if the coroutine is suspended in a call to yield, or if it has not started running yet; "normal" if the coroutine is active but not running (that is, it has resumed another coroutine); and "dead" if the coroutine has finished its body function, or if it has stopped with an error.
    
    Returns:
    
    the coroutine.status function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.status
  - wrap
```
public static org.classdump.luna.runtime.LuaFunction wrap()
```
    Returns the function coroutine.wrap.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.wrap (f)
    Creates a new coroutine, with body f. f must be a 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.
    
    Returns:
    
    the coroutine.wrap function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.wrap
  - yield
```
public static org.classdump.luna.runtime.LuaFunction yield()
```
    Returns the function coroutine.yield.
    The following is the corresponding entry from the Lua Reference Manual:
    
    coroutine.yield (···)
    Suspends the execution of the calling coroutine. Any arguments to yield are passed as extra results to resume.
    
    Returns:
    
    the coroutine.yield function
    
    See Also:
    
    the Lua 5.3 Reference Manual entry for coroutine.yield
  - installInto
```
public static void installInto(org.classdump.luna.StateContext context,
                               org.classdump.luna.Table env)
```
    Installs the coroutine library to the global environment env in the state context context.
    If env.package.loaded is a table, adds the library table to it with the key "coroutine", using raw access.
    
    Parameters:
    
    context - the state context, must not be null
    
    env - the global environment, must not be null
    
    Throws:
    
    NullPointerException - if context or env is null

Class CoroutineLib

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

isyieldable

resume

running

status

wrap

yield

installInto