GameboardScenarioActorPatrolAgent
Defined in: src/scenario/scenario.ts:89
Patrol agent definition that references a named scenario route.
Extends
Section titled “Extends”Omit<SetGameboardPatrolAgentOptions,"route">
Properties
Section titled “Properties”active?
Section titled “active?”
optionalactive?:boolean
Defined in: src/patrol/patrol.ts:63
Whether the patrol starts active.
Inherited from
Section titled “Inherited from”SetGameboardPatrolAgentOptions.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.
Inherited from
Section titled “Inherited from”SetGameboardPatrolAgentOptions.alignToCurrentTile
currentWaypointIndex?
Section titled “currentWaypointIndex?”
optionalcurrentWaypointIndex?:number
Defined in: src/patrol/patrol.ts:59
Starting waypoint index.
Inherited from
Section titled “Inherited from”SetGameboardPatrolAgentOptions.currentWaypointIndex
movement?
Section titled “movement?”
optionalmovement?:GameboardMovementPathRequestOptions
Defined in: src/patrol/patrol.ts:67
Movement options used when requesting segment movement.
Inherited from
Section titled “Inherited from”SetGameboardPatrolAgentOptions.movement
pauseTicks?
Section titled “pauseTicks?”
optionalpauseTicks?:number
Defined in: src/patrol/patrol.ts:65
Ticks to wait after reaching each waypoint.
Inherited from
Section titled “Inherited from”SetGameboardPatrolAgentOptions.pauseTicks
routeId
Section titled “routeId”routeId:
string
Defined in: src/scenario/scenario.ts:92
Scenario patrol route id to attach to the actor.