PatrolRoute

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

Named patrol definition. Actors snapshot it when ordered; update or destroy affects future starts.

Methods

destroy()

destroy(): boolean

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

Removes the definition. Active patrols keep their snapshots.

Returns

boolean

---

toJSON()

toJSON(): PatrolRouteDefinition | null

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

Returns an independent definition, or null after destruction.

Returns

PatrolRouteDefinition | null

---

update()

update(changes): boolean

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

Updates defaults or waypoints atomically. Invalid input throws; a destroyed handle returns false.

Parameters

changes

Partial<PatrolRouteDefinition>

Fields to replace; id cannot change.

Returns

boolean

---

all()

static all(): PatrolRoute[]

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

Lists registered routes in creation order.

Returns

PatrolRoute[]

---

create()

static create(definition): PatrolRoute

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

Registers a route. Invalid data or a duplicate id throws.

Parameters

definition

PatrolRouteDefinition

The route to register.

Returns

PatrolRoute

---

getById()

static getById(id): PatrolRoute | null

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

Looks up a registered route.

Parameters

id

string

Exact route id.

Returns

PatrolRoute | null

Properties

exists

readonly exists: boolean

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

False after destruction.

---

id

readonly id: string

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

Stable id; empty after destruction.

---

name

readonly name: string

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

Display name.