GameboardPatrolEventRecord
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:304
Serializable patrol event record.
Properties
Section titled “Properties”actorId?
Section titled “actorId?”
optionalactorId?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:308
Actor id when the patrol placement is actor-backed.
advanced
Section titled “advanced”advanced:
boolean
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:324
Whether the patrol pointer advanced.
currentWaypointIndex
Section titled “currentWaypointIndex”currentWaypointIndex:
number
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:316
Current waypoint index.
placementId
Section titled “placementId”placementId:
string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:306
Placement id controlled by the patrol agent.
reason?
Section titled “reason?”
optionalreason?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:326
Optional patrol blocked/waiting reason.
requested
Section titled “requested”requested:
boolean
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:322
Whether movement was requested.
roundsCompleted
Section titled “roundsCompleted”roundsCompleted:
number
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:320
Completed route rounds.
routeId
Section titled “routeId”routeId:
string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:310
Patrol route id.
status
Section titled “status”status:
GameboardPatrolStatus
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:312
Patrol status after advancement.
targetKey?
Section titled “targetKey?”
optionaltargetKey?:string
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:314
Current target waypoint tile key.
targetWaypointIndex
Section titled “targetWaypointIndex”targetWaypointIndex:
number
Defined in: packages/declarative-hex-worlds/src/systems/events.ts:318
Target waypoint index.