useTileState
useTileState(
entity): {baseAssetId:string;coastEdges:number;coastWaterless:boolean;coordinates:HexCoordinates;elevation:number;key:string;riverCrossing:"A"|"B"|undefined;riverCurvy:boolean;riverEdges:number;riverWaterless:boolean;roadEdges:number;roadSlope:"high"|"low"|undefined;supportAssetId:string;tags:string[];terrain:GameboardTerrain;textureSet:"default"|"fall"|"summer"|"winter"; } |undefined
Defined in: src/react/react.ts:833
Read the canonical tile trait for one tile entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ baseAssetId: string; coastEdges: number; coastWaterless: boolean; coordinates: HexCoordinates; elevation: number; key: string; riverCrossing: "A" | "B" | undefined; riverCurvy: boolean; riverEdges: number; riverWaterless: boolean; roadEdges: number; roadSlope: "high" | "low" | undefined; supportAssetId: string; tags: string[]; terrain: GameboardTerrain; textureSet: "default" | "fall" | "summer" | "winter"; }
baseAssetId
Section titled “baseAssetId”baseAssetId:
string=''
Asset id for the visible tile top.
coastEdges
Section titled “coastEdges”coastEdges:
number=0
Six-edge bitmask for coast connectivity.
coastWaterless
Section titled “coastWaterless”coastWaterless:
boolean=false
Whether this coast tile uses the waterless guide variant.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Axial tile coordinates.
elevation
Section titled “elevation”elevation:
number=0
Stacked elevation level for the tile top.
key:
string=''
Stable axial key in q,r form.
riverCrossing
Section titled “riverCrossing”riverCrossing:
"A"|"B"|undefined
River crossing variant, when present.
riverCurvy
Section titled “riverCurvy”riverCurvy:
boolean=false
Whether this river tile uses the curvy guide variant.
riverEdges
Section titled “riverEdges”riverEdges:
number=0
Six-edge bitmask for river connectivity.
riverWaterless
Section titled “riverWaterless”riverWaterless:
boolean=false
Whether this river tile uses the waterless guide variant.
roadEdges
Section titled “roadEdges”roadEdges:
number=0
Six-edge bitmask for road connectivity.
roadSlope
Section titled “roadSlope”roadSlope:
"high"|"low"|undefined
Road slope variant when a road changes elevation.
supportAssetId
Section titled “supportAssetId”supportAssetId:
string=''
Optional asset id for the vertical support below elevated tiles.
tags:
string[]
Free-form taxonomy and generation tags.
terrain
Section titled “terrain”terrain:
GameboardTerrain
Primary terrain biome represented by this tile.
textureSet
Section titled “textureSet”textureSet:
"default"|"fall"|"summer"|"winter"
KayKit texture set applied to this tile.
undefined