GameboardPieceCompatibilityDeclarationOptions
Defined in: src/pieces/pieces.ts:77
Overrides applied while declaring one piece from compatibility analysis.
Extends
Section titled “Extends”Omit<GameboardPieceDeclarationInput,"id">
Properties
Section titled “Properties”archetype?
Section titled “archetype?”
optionalarchetype?:GameboardLayoutArchetypeInput
Defined in: src/pieces/pieces.ts:51
Layout archetype id or inline archetype.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.archetype
assetId?
Section titled “assetId?”
optionalassetId?:string
Defined in: src/pieces/pieces.ts:43
Render asset id. Defaults to id.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.assetId
criteria?
Section titled “criteria?”
optionalcriteria?:GameboardLayoutCriteria
Defined in: src/pieces/pieces.ts:59
Layout criteria for selecting valid sites.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.criteria
elevationOffset?
Section titled “elevationOffset?”
optionalelevationOffset?:number
Defined in: src/pieces/pieces.ts:65
Vertical offset above the tile elevation.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.elevationOffset
footprint?
Section titled “footprint?”
optionalfootprint?:GameboardLayoutFootprintInput
Defined in: src/pieces/pieces.ts:57
Placement footprint.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.footprint
optionalid?:string
Defined in: src/pieces/pieces.ts:79
Override piece id. Defaults to the compatibility report id.
optionalkind?:GameboardPlacementKind
Defined in: src/pieces/pieces.ts:53
Placement kind override.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.kind
label?
Section titled “label?”
optionallabel?:string
Defined in: src/pieces/pieces.ts:45
Human-readable label. Defaults from id.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.label
layer?
Section titled “layer?”
optionallayer?:GameboardPlacementLayer
Defined in: src/pieces/pieces.ts:55
Placement layer override.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.layer
metadata?
Section titled “metadata?”
optionalmetadata?:Readonly<Record<string,string|number|boolean|null>>
Defined in: src/pieces/pieces.ts:71
Serializable metadata merged into generated placements.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.metadata
requiresExtra?
Section titled “requiresExtra?”
optionalrequiresExtra?:boolean
Defined in: src/pieces/pieces.ts:67
Whether the asset is local-only or EXTRA.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.requiresExtra
optionalrole?:GameboardPieceRole
Defined in: src/pieces/pieces.ts:49
Placement role. Defaults from id heuristics.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.role
rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number|"random"
Defined in: src/pieces/pieces.ts:63
Clockwise 60-degree rotation steps or random rotation.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.rotationSteps
scale?
Section titled “scale?”
optionalscale?:number
Defined in: src/pieces/pieces.ts:61
Uniform render scale.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.scale
source?
Section titled “source?”
optionalsource?:string
Defined in: src/pieces/pieces.ts:47
Source pack or registry name.
Inherited from
Section titled “Inherited from”GameboardPieceDeclarationInput.source
optionaltags?: readonlystring[]
Defined in: src/pieces/pieces.ts:69
Piece tags used by registry selection.