UnitsPatrolRoute

UnitsPatrolRoute(units, positions) · UnitsPatrolRouteTracked(units, positions)

Inputs: units is one actor or a dense array; positions is an ordered array of 1–10 finite {x=..., y=...} points.

Description: Sends one immediate native patrol route. It does not append to existing orders. The tracked form reports invalid-waypoint-count or invalid-position for malformed routes. Submission does not prove arrival at any waypoint.

Output: UnitsPatrolRoute returns true for queue admission, otherwise false. UnitsPatrolRouteTracked returns accepted, receipt.

Errors: Wrong Lua argument types raise an argument error. The tracked form reports invalid-waypoint-count or invalid-position for malformed routes. Invalid actors or unavailable layout also reject. A tracked receipt gives the rejection reason when available.