GameboardPieceDeclaration
Defined in: src/pieces/pieces.ts:98
Normalized reusable gameboard piece declaration.
Properties
Section titled “Properties”archetype
Section titled “archetype”archetype:
GameboardLayoutArchetypeInput
Defined in: src/pieces/pieces.ts:110
Layout archetype id or inline archetype.
assetId
Section titled “assetId”assetId:
string
Defined in: src/pieces/pieces.ts:102
Render asset id.
criteria
Section titled “criteria”criteria:
GameboardLayoutCriteria
Defined in: src/pieces/pieces.ts:118
Layout criteria for selecting valid sites.
elevationOffset?
Section titled “elevationOffset?”
optionalelevationOffset?:number
Defined in: src/pieces/pieces.ts:124
Vertical offset above the tile elevation.
footprint?
Section titled “footprint?”
optionalfootprint?:GameboardLayoutFootprintInput
Defined in: src/pieces/pieces.ts:116
Placement footprint.
id:
string
Defined in: src/pieces/pieces.ts:100
Stable piece id.
optionalkind?:GameboardPlacementKind
Defined in: src/pieces/pieces.ts:112
Placement kind override.
label:
string
Defined in: src/pieces/pieces.ts:104
Human-readable label.
layer?
Section titled “layer?”
optionallayer?:GameboardPlacementLayer
Defined in: src/pieces/pieces.ts:114
Placement layer override.
metadata
Section titled “metadata”metadata:
Readonly<Record<string,string|number|boolean|null>>
Defined in: src/pieces/pieces.ts:130
Serializable metadata merged into generated placements.
requiresExtra
Section titled “requiresExtra”requiresExtra:
boolean
Defined in: src/pieces/pieces.ts:126
Whether the asset is local-only or EXTRA.
role:
GameboardPieceRole
Defined in: src/pieces/pieces.ts:108
Placement role.
rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number|"random"
Defined in: src/pieces/pieces.ts:122
Clockwise 60-degree rotation steps or random rotation.
scale?
Section titled “scale?”
optionalscale?:number
Defined in: src/pieces/pieces.ts:120
Uniform render scale.
source
Section titled “source”source:
string
Defined in: src/pieces/pieces.ts:106
Source pack or registry name.
tags: readonly
string[]
Defined in: src/pieces/pieces.ts:128
Piece tags used by registry selection.