usePlacementState
usePlacementState(
entity): {assetId:string;coordinates:HexCoordinates;elevation:number;elevationOffset:number;id:string;kind:GameboardPlacementKind;layer:GameboardPlacementLayer;metadata:Record<string,string|number|boolean|null>;order:number;position:WorldPosition;requiresExtra:boolean;rotationRadians:number;rotationSteps:number;scale:number;stackIndex:number|undefined;textureSet:"default"|"fall"|"summer"|"winter";tileKey:string; } |undefined
Defined in: src/react/react.ts:897
Read placement state for one placement or actor entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ assetId: string; coordinates: HexCoordinates; elevation: number; elevationOffset: number; id: string; kind: GameboardPlacementKind; layer: GameboardPlacementLayer; metadata: Record<string, string | number | boolean | null>; order: number; position: WorldPosition; requiresExtra: boolean; rotationRadians: number; rotationSteps: number; scale: number; stackIndex: number | undefined; textureSet: "default" | "fall" | "summer" | "winter"; tileKey: string; }
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.
undefined