Skip to content

UnitsAttackMoveRoute

UnitsAttackMoveRoute(units, positions) · UnitsAttackMoveRouteTracked(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 attack-move route without appending to existing orders. The tracked form reports invalid-waypoint-count or invalid-position for malformed routes. The game determines whether the actors can execute it.

Output: UnitsAttackMoveRoute returns true for queue admission, otherwise false. UnitsAttackMoveRouteTracked 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.