Skip to content
declarative-hex-worlds

GameboardPieceCollectionLayoutRuleOptions

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

Overrides used when turning a compatible piece collection into one fill rule.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

archetypes?

Section titled “archetypes?”

optional archetypes?: Readonly<Record<string, GameboardLayoutArchetype>>

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

Archetype registry used by layout.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.archetypes

count?

Section titled “count?”

optional count?: number

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

Explicit placement count.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.count

criteria?

Section titled “criteria?”

optional criteria?: GameboardLayoutCriteria

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

Criteria merged over piece defaults.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.criteria

elevationOffset?

Section titled “elevationOffset?”

optional elevationOffset?: number

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

Vertical offset override.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.elevationOffset

fill?

Section titled “fill?”

optional fill?: number

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

Fraction of candidate sites to fill.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.fill

id?

Section titled “id?”

optional id?: string

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

Fill rule id.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.id

idPrefix?

Section titled “idPrefix?”

optional idPrefix?: string

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

Prefix used for generated placement ids.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.idPrefix

maxCount?

Section titled “maxCount?”

optional maxCount?: number

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

Maximum placement count.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.maxCount

metadata?

Section titled “metadata?”

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

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

Metadata merged over piece metadata.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.metadata

minCount?

Section titled “minCount?”

optional minCount?: number

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

Minimum placement count.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.minCount

occupancyGuard?

Section titled “occupancyGuard?”

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy guard for spawned placements.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.occupancyGuard

requiresExtra?

Section titled “requiresExtra?”

optional requiresExtra?: boolean

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

Local-only asset override.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.requiresExtra

rotationSteps?

Section titled “rotationSteps?”

optional rotationSteps?: number | "random"

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

Rotation override.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.rotationSteps

scale?

Section titled “scale?”

optional scale?: number

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

Uniform render scale override.

Inherited from

Section titled “Inherited from”

GameboardPieceLayoutRuleOptions.scale