GameboardPatrolAdvanceResult
Defined in: src/patrol/patrol.ts:101
Result returned after advancing a patrol agent.
Extends
Section titled “Extends”Properties
Section titled “Properties”actor?
Section titled “actor?”
optionalactor?:GameboardActorSnapshot
Defined in: src/patrol/patrol.ts:91
Actor snapshot when the patrol placement is registered as an actor.
Inherited from
Section titled “Inherited from”advanced
Section titled “advanced”advanced:
boolean
Defined in: src/patrol/patrol.ts:109
Whether this advance call completed a waypoint transition.
agent:
object
Defined in: src/patrol/patrol.ts:93
Patrol agent trait value.
active
Section titled “active”active:
boolean=true
Whether the patrol agent is active.
currentWaypointIndex
Section titled “currentWaypointIndex”currentWaypointIndex:
number=0
Current waypoint index.
loop:
boolean=true
Whether the route loops back to the first waypoint.
pauseTicks
Section titled “pauseTicks”pauseTicks:
number=0
Ticks to wait after reaching each waypoint.
roundsCompleted
Section titled “roundsCompleted”roundsCompleted:
number=0
Number of completed route rounds.
routeId
Section titled “routeId”routeId:
string=''
Route id followed by this patrol.
segmentCosts
Section titled “segmentCosts”segmentCosts:
number[]
Optional movement budget per route segment.
targetWaypointIndex
Section titled “targetWaypointIndex”targetWaypointIndex:
number=-1
Target waypoint index for an in-flight segment.
waitTicksRemaining
Section titled “waitTicksRemaining”waitTicksRemaining:
number=0
Remaining wait ticks before the next segment.
waypointKeys
Section titled “waypointKeys”waypointKeys:
string[]
Ordered route waypoint tile keys.
Inherited from
Section titled “Inherited from”entity
Section titled “entity”entity:
Entity
Defined in: src/patrol/patrol.ts:87
Live Koota entity.
Inherited from
Section titled “Inherited from”GameboardPatrolSnapshot.entity
movement?
Section titled “movement?”
optionalmovement?:GameboardMovementRequestResult
Defined in: src/patrol/patrol.ts:105
Movement request produced during advancement.
placement
Section titled “placement”placement:
object
Defined in: src/patrol/patrol.ts:89
Placement state associated with the patrol.
assetId
Section titled “assetId”assetId:
string=''
Manifest or external registry asset id.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Axial coordinates of the origin tile.
elevation
Section titled “elevation”elevation:
number=0
Base tile elevation where the placement was spawned.
elevationOffset
Section titled “elevationOffset”elevationOffset:
number=0
Extra vertical offset above the tile elevation.
id:
string=''
Stable placement id.
kind:
GameboardPlacementKind
Gameplay category for rules, selectors, and rendering.
layer:
GameboardPlacementLayer
Render and occupancy layer.
metadata
Section titled “metadata”metadata:
Record<string,string|number|boolean|null>
Serializable placement metadata for rules, ECS interop, and render hints.
order:
number=0
Stable sort order used by renderers and snapshots.
position
Section titled “position”position:
WorldPosition
World-space placement anchor after elevation and local offsets.
requiresExtra
Section titled “requiresExtra”requiresExtra:
boolean=false
Whether the placement depends on local-only EXTRA assets.
rotationRadians
Section titled “rotationRadians”rotationRadians:
number=0
Rotation in radians derived from rotationSteps.
rotationSteps
Section titled “rotationSteps”rotationSteps:
number=0
Clockwise 60-degree rotation steps.
scale:
number=1
Uniform render scale.
stackIndex
Section titled “stackIndex”stackIndex:
number|undefined
Optional stack index for layered terrain and vertical props.
textureSet
Section titled “textureSet”textureSet:
"default"|"fall"|"summer"|"winter"
KayKit texture set applied to this placement.
tileKey
Section titled “tileKey”tileKey:
string=''
Origin tile key in q,r form.
Inherited from
Section titled “Inherited from”GameboardPatrolSnapshot.placement
previousState
Section titled “previousState”previousState:
object
Defined in: src/patrol/patrol.ts:103
Patrol state before advancement.
lastPathKeys
Section titled “lastPathKeys”lastPathKeys:
string[]
Last requested movement path tile keys.
reason
Section titled “reason”reason:
string|undefined
Blocked or paused reason.
status
Section titled “status”status:
GameboardPatrolStatus
Current patrol status.
targetKey
Section titled “targetKey”targetKey:
string=''
Current target waypoint tile key.
requested
Section titled “requested”requested:
boolean
Defined in: src/patrol/patrol.ts:107
Whether this advance call requested a new movement segment.
state:
object
Defined in: src/patrol/patrol.ts:95
Patrol state trait value.
lastPathKeys
Section titled “lastPathKeys”lastPathKeys:
string[]
Last requested movement path tile keys.
reason
Section titled “reason”reason:
string|undefined
Blocked or paused reason.
status
Section titled “status”status:
GameboardPatrolStatus
Current patrol status.
targetKey
Section titled “targetKey”targetKey:
string=''
Current target waypoint tile key.