PatrolState
Defined in: server/api.d.ts:4904
A running patrol’s snapshot. Indices and laps start at zero.
Properties
Section titled “Properties”direction
Section titled “direction”direction:
number
Defined in: server/api.d.ts:4923
1 forward, -1 backward.
lap:
number
Defined in: server/api.d.ts:4918
Completed loops or round trips.
phase:
"moving"|"waiting"
Defined in: server/api.d.ts:4928
Whether the actor is approaching or waiting at the waypoint.
routeId
Section titled “routeId”routeId:
string|null
Defined in: server/api.d.ts:4908
Stable route id; null for an anonymous point-array patrol.
waypointIndex
Section titled “waypointIndex”waypointIndex:
number
Defined in: server/api.d.ts:4913
Target waypoint index.