SetGameboardPatrolAgentOptions
Defined in: src/patrol/patrol.ts:55
Options for attaching a patrol agent to a placement or actor.
Properties
Section titled “Properties”active?
Section titled “active?”
optionalactive?:boolean
Defined in: src/patrol/patrol.ts:63
Whether the patrol starts active.
alignToCurrentTile?
Section titled “alignToCurrentTile?”
optionalalignToCurrentTile?:boolean
Defined in: src/patrol/patrol.ts:61
Align starting waypoint to the placement’s current tile when possible.
currentWaypointIndex?
Section titled “currentWaypointIndex?”
optionalcurrentWaypointIndex?:number
Defined in: src/patrol/patrol.ts:59
Starting waypoint index.
movement?
Section titled “movement?”
optionalmovement?:GameboardMovementPathRequestOptions
Defined in: src/patrol/patrol.ts:67
Movement options used when requesting segment movement.
pauseTicks?
Section titled “pauseTicks?”
optionalpauseTicks?:number
Defined in: src/patrol/patrol.ts:65
Ticks to wait after reaching each waypoint.
Defined in: src/patrol/patrol.ts:57
Route plan or route input to follow.