Skip to content

GameboardPlacementSpec

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:163

Serializable placement state in a generated gameboard plan.

assetId: string

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:173

Manifest or external registry asset id.


coordinates: HexCoordinates

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:169

Origin tile coordinates.


elevation: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:181

Origin tile elevation.


elevationOffset: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:183

Vertical offset above the origin tile.


id: string

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:165

Stable placement id.


kind: GameboardPlacementKind

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:175

Placement category.


layer: GameboardPlacementLayer

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:177

Render and gameplay layer.


metadata: Readonly<Record<string, string | number | boolean | null>>

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:197

Serializable metadata for gameplay, layout, and renderer hints.


order: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:191

Stable render and snapshot sort order.


position: WorldPosition

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:171

World position after tile elevation and placement offset.


requiresExtra: boolean

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:195

Whether this placement requires local-only EXTRA assets.


rotationRadians: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:187

Rotation in radians derived from rotationSteps.


rotationSteps: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:185

Clockwise 60-degree rotation steps.


scale: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:189

Uniform render scale.


optional stackIndex?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:193

Optional stack index for vertical or layered pieces.


textureSet: "default" | "fall" | "summer" | "winter"

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:179

KayKit texture set applied to this placement.


tileKey: string

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:167

Origin tile key in q,r form.