MUSHclient documentation: contents

coroutine.status

coroutine.status
Summary Returns the status of a thread Prototype `s = coroutine.status (thread)` Description Returns a string indicating the status of the thread. Raises an error if the argument is not a thread. If it is, the values returned can be: running normal suspended dead A thread is "running" if coroutine.status is called from within the thread itself. A thread is "normal" if the coroutine is active, but has resumed another coroutine. It is "suspended" after being created but before it is resumed, and after yielding. It is "dead" after it has returned from the entire function. `print (coroutine.status (thread)) --> suspended` See Also ... Lua functions coroutine.create - Creates a new coroutine thread coroutine.resume - Start or resume a thread coroutine.running - Returns the running coroutine coroutine.wrap - Creates a thread and returns a function to resume it coroutine.yield - Yields execution of thread back to the caller Topics Lua base functions Lua bc (big number) functions Lua bit manipulation functions Lua coroutine functions Lua debug functions Lua io functions Lua math functions Lua os functions Lua package functions Lua PCRE regular expression functions Lua script extensions Lua string functions Lua syntax Lua table functions Lua utilities Scripting Scripting callbacks - plugins (Help topic: lua=coroutine.status)

Summary

Returns the status of a thread

Prototype

s = coroutine.status (thread)

Description

Returns a string indicating the status of the thread. Raises an error if the argument is not a thread.

If it is, the values returned can be:

running
normal
suspended
dead

A thread is "running" if coroutine.status is called from within the thread itself.

A thread is "normal" if the coroutine is active, but has resumed another coroutine.

It is "suspended" after being created but before it is resumed, and after yielding.

It is "dead" after it has returned from the entire function.


print (coroutine.status (thread)) --> suspended

See Also ...

Lua functions

coroutine.create - Creates a new coroutine thread
coroutine.resume - Start or resume a thread
coroutine.running - Returns the running coroutine
coroutine.wrap - Creates a thread and returns a function to resume it
coroutine.yield - Yields execution of thread back to the caller

Topics

Lua base functions
Lua bc (big number) functions
Lua bit manipulation functions
Lua coroutine functions
Lua debug functions
Lua io functions
Lua math functions
Lua os functions
Lua package functions
Lua PCRE regular expression functions
Lua script extensions
Lua string functions
Lua syntax
Lua table functions
Lua utilities
Scripting
Scripting callbacks - plugins

(Help topic: lua=coroutine.status)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.