Skip to content

UngarrisonTo

UngarrisonTo(containers, position) · UngarrisonToTracked(containers, position)

Inputs: containers is 1–255 owned, live objects; position is a finite {x=..., y=...} destination. Invalid members reject the whole group.

Description: Requests group unloading toward that point. The native command uses the acting player ID as its occupant filter; the game determines who can emerge. The tracked form can report invalid-position, invalid-actors, actor-group-too-large, or packet-layout-unavailable. Submission does not prove that anyone unloaded or reached the destination.

Output: UngarrisonTo returns true for queue admission, otherwise false. UngarrisonToTracked returns accepted, receipt.

Errors: Wrong Lua argument types raise an argument error. The tracked form can report invalid-position, invalid-actors, actor-group-too-large, or packet-layout-unavailable. A tracked receipt gives the rejection reason when available.

This is a group unload action, separate from selecting an individual occupant with UngarrisonUnit. Combining occupant selection with an explicit destination is not currently exposed.