Coroutine.close

Available since: Gideros 2022.3
Class: coroutine

Description

Closes and puts the provided coroutine in a dead state.

(coroutine) = coroutine.close(co)
Closes and puts the provided coroutine in a dead state. This function returns true unless the coroutine is in an error state, in which case it returns false and the error message. A coroutine that is currently running cannot be closed. A coroutine cannot be resumed after it is closed

Parameters

co: (thread)

Return values

Returns (boolean) true unless the coroutine being closed is in an error state
Returns (string) the error message, if any