useGameboardState
useGameboardState(): {
placementCount:number;schemaVersion:string;seed:string;shape:GameboardShape;textureSet:"default"|"fall"|"summer"|"winter";tileCount:number; } |undefined
Defined in: src/react/react.ts:401
Read the root board state trait from the current Koota world.
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ placementCount: number; schemaVersion: string; seed: string; shape: GameboardShape; textureSet: "default" | "fall" | "summer" | "winter"; tileCount: number; }
placementCount
Section titled “placementCount”placementCount:
number=0
Number of placement entities loaded into the world.
schemaVersion
Section titled “schemaVersion”schemaVersion:
string=GAMEBOARD_SCHEMA_VERSION
Manifest/schema version used to generate the loaded board.
seed:
string=''
Seed used by deterministic layout or simulation helpers.
shape:
GameboardShape
Board shape descriptor, such as rectangle or hexagon.
textureSet
Section titled “textureSet”textureSet:
"default"|"fall"|"summer"|"winter"
Active KayKit texture set for generated terrain and placements.
tileCount
Section titled “tileCount”tileCount:
number=0
Number of tile entities loaded into the world.
undefined