GameboardPieceRegistryFillRulesOptions
Defined in: src/pieces/pieces.ts:279
Options for creating fill rules from all pieces selected from a registry.
Extends
Section titled “Extends”Omit<GameboardPieceLayoutRuleOptions,"id"|"assetId">
Properties
Section titled “Properties”archetypes?
Section titled “archetypes?”
optionalarchetypes?: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?”
optionalcount?:number
Defined in: src/pieces/pieces.ts:243
Explicit placement count.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.count
criteria?
Section titled “criteria?”
optionalcriteria?: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?”
optionalelevationOffset?:number
Defined in: src/pieces/pieces.ts:259
Vertical offset override.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.elevationOffset
optionalfill?:number
Defined in: src/pieces/pieces.ts:245
Fraction of candidate sites to fill.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.fill
idPrefix?
Section titled “idPrefix?”
optionalidPrefix?: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?”
optionalmaxCount?:number
Defined in: src/pieces/pieces.ts:249
Maximum placement count.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.maxCount
metadata?
Section titled “metadata?”
optionalmetadata?: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?”
optionalminCount?:number
Defined in: src/pieces/pieces.ts:247
Minimum placement count.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.minCount
occupancyGuard?
Section titled “occupancyGuard?”
optionaloccupancyGuard?: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?”
optionalrequiresExtra?:boolean
Defined in: src/pieces/pieces.ts:263
Local-only asset override.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.requiresExtra
rotationSteps?
Section titled “rotationSteps?”
optionalrotationSteps?:number|"random"
Defined in: src/pieces/pieces.ts:257
Rotation override.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.rotationSteps
ruleIdPrefix?
Section titled “ruleIdPrefix?”
optionalruleIdPrefix?:string
Defined in: src/pieces/pieces.ts:284
Prefix applied to generated rule ids.
scale?
Section titled “scale?”
optionalscale?:number
Defined in: src/pieces/pieces.ts:255
Uniform render scale override.
Inherited from
Section titled “Inherited from”GameboardPieceLayoutRuleOptions.scale
selection?
Section titled “selection?”
optionalselection?:GameboardPieceRegistrySelection
Defined in: src/pieces/pieces.ts:282
Selection used to choose registry pieces.