GameboardLayoutFillRuleAnalysis
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:493
Analysis for one layout fill rule.
Properties
Section titled “Properties”archetypeId?
Section titled “archetypeId?”
optionalarchetypeId?:GameboardLayoutArchetypeId
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:499
Resolved archetype id.
assetIds
Section titled “assetIds”assetIds: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:505
Configured asset ids.
candidateCount
Section titled “candidateCount”candidateCount:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:509
Candidate site count before target count limits.
errors
Section titled “errors”errors: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:525
Fatal diagnostics for the rule.
id:
string
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:495
Stable rule id.
optionalkind?:GameboardPlacementKind
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:501
Resolved placement kind.
layer?
Section titled “layer?”
optionallayer?:GameboardPlacementLayer
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:503
Resolved placement layer.
rejectedSiteCount
Section titled “rejectedSiteCount”rejectedSiteCount:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:511
Rejected site count.
rejectionCounts
Section titled “rejectionCounts”rejectionCounts:
Readonly<Partial<Record<GameboardLayoutSiteRejectionCode,number>>>
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:513
Rejection counts grouped by code.
requestedCount
Section titled “requestedCount”requestedCount:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:515
Count requested by count, fill, and min/max settings.
ruleIndex
Section titled “ruleIndex”ruleIndex:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:497
Rule index in the fill options.
selectedAssetIds
Section titled “selectedAssetIds”selectedAssetIds: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:507
Asset ids selected for generated placements.
selectedCount
Section titled “selectedCount”selectedCount:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:519
Number of placements selected by the rule.
selectedTileKeys
Section titled “selectedTileKeys”selectedTileKeys: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:521
Tile keys selected by the rule.
targetCount
Section titled “targetCount”targetCount:
number
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:517
Final target count after candidate limits and diagnostics.
warnings
Section titled “warnings”warnings: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:523
Non-fatal diagnostics for the rule.