GameboardMovementRequestResult
Defined in: src/movement/movement.ts:117
Result returned after requesting movement.
Properties
Section titled “Properties”entity
Section titled “entity”entity:
Entity
Defined in: src/movement/movement.ts:119
Movement agent entity.
Defined in: src/movement/movement.ts:125
Planned path.
placement
Section titled “placement”placement:
object
Defined in: src/movement/movement.ts:121
Placement state after the request.
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.
profile
Section titled “profile”profile:
GameboardMovementProfile
Defined in: src/movement/movement.ts:123
Resolved movement profile.
state:
object
Defined in: src/movement/movement.ts:127
Movement path state written to the entity.
cost:
number=0
Total planned path cost.
destinationKey
Section titled “destinationKey”destinationKey:
string=''
Destination tile key for the current request.
nextIndex
Section titled “nextIndex”nextIndex:
number=0
Next path index to advance to.
pathKeys
Section titled “pathKeys”pathKeys:
string[]
Planned path tile keys.
reason
Section titled “reason”reason:
string|undefined
Blocked or out-of-range reason.
spentCost
Section titled “spentCost”spentCost:
number=0
Cost spent so far.
status
Section titled “status”status:
GameboardMovementStatus
Current movement status.
visited
Section titled “visited”visited:
number=0
Number of pathfinder nodes visited for the request.