Skip to content

GatherInside

GatherInside(actors, state?) · GatherInsideTracked(actors, state?)

Inputs: actors is one object or a dense array; state is -1, 0, or 1 and defaults to -1.

Description: Requests the native gather/garrison state. Another state value is rejected; the tracked form supplies a rejection receipt.

Output: GatherInside returns true for queue admission, otherwise false. GatherInsideTracked returns accepted, receipt.

Errors: Wrong Lua argument types raise an argument error. A state outside -1, 0, and 1, invalid actors, missing layout, or a changed session rejects. A tracked receipt gives the rejection reason when available.