Skip to content

SetUnitStanceUngarrison

SetUnitStanceUngarrison(buildings) · SetUnitStanceUngarrisonTracked(buildings, guardedOccupants?)

Inputs: buildings is one container or a dense array. The tracked form's optional guardedOccupants validates listed occupants; it does not select which units leave.

Description: Requests ungarrison behavior for the containers. The tracked form rechecks supplied guards, validates the whole building group, and supports at most 16,378 buildings after deduplication. See Command receipts for guard rules.

Output: SetUnitStanceUngarrison returns true for queue admission, otherwise false. SetUnitStanceUngarrisonTracked returns accepted, receipt.

Errors: Wrong Lua argument types raise an argument error. Invalid buildings or guards, more than 16,378 distinct buildings, missing layout, or a changed session reject. A tracked receipt gives the rejection reason when available.