PlacementOccupancySnapshot
Defined in: src/koota/koota.ts:186
Serializable occupancy record joined from a placement and an occupied tile.
Properties
Section titled “Properties”blocksMovement
Section titled “blocksMovement”blocksMovement:
boolean
Defined in: src/koota/koota.ts:198
Whether this occupancy record blocks movement.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Defined in: src/koota/koota.ts:190
Axial coordinates for the occupied tile.
footprintIndex
Section titled “footprintIndex”footprintIndex:
number
Defined in: src/koota/koota.ts:196
Zero-based index within the placement footprint.
occupancyGroup
Section titled “occupancyGroup”occupancyGroup:
string
Defined in: src/koota/koota.ts:200
Occupancy group used to allow compatible colocated placements.
originTileKey
Section titled “originTileKey”originTileKey:
string
Defined in: src/koota/koota.ts:194
Origin tile key for the placement.
placement
Section titled “placement”placement:
object
Defined in: src/koota/koota.ts:192
Placement occupying the tile.
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.
tileKey
Section titled “tileKey”tileKey:
string
Defined in: src/koota/koota.ts:188
Tile key for the occupied tile.