PatrolRouteDefinition

Defined in: server/api.d.ts:4864

The format saved by World Builder and accepted by PatrolRoute.create.

Properties

id

id: string

Defined in: server/api.d.ts:4868

Stable globally unique id, up to 128 bytes. Use a namespace such as town.guard-loop.

---

mode?

optional mode?: "once" | "loop" | "pingPong"

Defined in: server/api.d.ts:4883

Defaults to loop. Ping-pong visits each endpoint once per turn.

---

name?

optional name?: string

Defined in: server/api.d.ts:4873

Display name, up to 256 bytes.

---

points

points: PatrolPoint[]

Defined in: server/api.d.ts:4878

1 to 256 ordered waypoints.

---

radius?

optional radius?: number

Defined in: server/api.d.ts:4898

Default arrival radius; 1.5 metres when omitted.

---

speed?

optional speed?: "walk" | "jog" | "run"

Defined in: server/api.d.ts:4888

Default leg speed; walk when omitted.

---

waitSeconds?

optional waitSeconds?: number

Defined in: server/api.d.ts:4893

Default arrival wait, 0 to 3600; defaults to zero.