Skip to content

SetUnitStancePatrol

SetUnitStancePatrol(units, position) · SetUnitStancePatrolTracked(units, position)

Inputs: units is one actor or a dense array; position is a finite map point.

Description: Requests an immediate single-point patrol order. For an ordered list of waypoints, use UnitsPatrolRoute.

Output: SetUnitStancePatrol returns true for queue admission, otherwise false. SetUnitStancePatrolTracked returns accepted, receipt.

Errors: Wrong Lua argument types raise an argument error. Invalid actors, non-finite coordinates, missing layout, or a changed session reject. A tracked receipt gives the rejection reason when available.