Skip to content
declarative-hex-worlds

GameboardPieceDeclarationInput

Defined in: src/pieces/pieces.ts:39

Input for declaring a reusable gameboard piece from any asset pack.

Properties

Section titled “Properties”

archetype?

Section titled “archetype?”

optional archetype?: GameboardLayoutArchetypeInput

Defined in: src/pieces/pieces.ts:51

Layout archetype id or inline archetype.

assetId?

Section titled “assetId?”

optional assetId?: string

Defined in: src/pieces/pieces.ts:43

Render asset id. Defaults to id.

criteria?

Section titled “criteria?”

optional criteria?: GameboardLayoutCriteria

Defined in: src/pieces/pieces.ts:59

Layout criteria for selecting valid sites.

elevationOffset?

Section titled “elevationOffset?”

optional elevationOffset?: number

Defined in: src/pieces/pieces.ts:65

Vertical offset above the tile elevation.

footprint?

Section titled “footprint?”

optional footprint?: GameboardLayoutFootprintInput

Defined in: src/pieces/pieces.ts:57

Placement footprint.

id

Section titled “id”

id: string

Defined in: src/pieces/pieces.ts:41

Stable piece id.

kind?

Section titled “kind?”

optional kind?: GameboardPlacementKind

Defined in: src/pieces/pieces.ts:53

Placement kind override.

label?

Section titled “label?”

optional label?: string

Defined in: src/pieces/pieces.ts:45

Human-readable label. Defaults from id.

layer?

Section titled “layer?”

optional layer?: GameboardPlacementLayer

Defined in: src/pieces/pieces.ts:55

Placement layer override.

metadata?

Section titled “metadata?”

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

Defined in: src/pieces/pieces.ts:71

Serializable metadata merged into generated placements.

requiresExtra?

Section titled “requiresExtra?”

optional requiresExtra?: boolean

Defined in: src/pieces/pieces.ts:67

Whether the asset is local-only or EXTRA.

role?

Section titled “role?”

optional role?: GameboardPieceRole

Defined in: src/pieces/pieces.ts:49

Placement role. Defaults from id heuristics.

rotationSteps?

Section titled “rotationSteps?”

optional rotationSteps?: number | "random"

Defined in: src/pieces/pieces.ts:63

Clockwise 60-degree rotation steps or random rotation.

scale?

Section titled “scale?”

optional scale?: number

Defined in: src/pieces/pieces.ts:61

Uniform render scale.

source?

Section titled “source?”

optional source?: string

Defined in: src/pieces/pieces.ts:47

Source pack or registry name.

tags?

Section titled “tags?”

optional tags?: readonly string[]

Defined in: src/pieces/pieces.ts:69

Piece tags used by registry selection.