GameboardPlanValidationConfig
Defined in: src/rules/validation.ts:21
Validation config for complete gameboard plans.
Extends
Section titled “Extends”Properties
Section titled “Properties”allowUnknownAssetIds?
Section titled “allowUnknownAssetIds?”
optionalallowUnknownAssetIds?: readonlystring[]
Defined in: src/rules/validation.ts:31
Specific unknown asset ids to allow even when unknown assets are otherwise errors.
allowUnknownAssets?
Section titled “allowUnknownAssets?”
optionalallowUnknownAssets?:boolean
Defined in: src/rules/validation.ts:29
Whether unknown asset ids are allowed.
assetCatalog?
Section titled “assetCatalog?”
optionalassetCatalog?:ManifestAssetCatalog
Defined in: src/rules/validation.ts:27
Optional manifest catalog used to validate asset ids and editions.
forbidStructuresOnWater?
Section titled “forbidStructuresOnWater?”
optionalforbidStructuresOnWater?:boolean
Defined in: src/rules/rule-types.ts:35
Whether structure placements are forbidden on water tiles.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.forbidStructuresOnWater
maxElevation?
Section titled “maxElevation?”
optionalmaxElevation?:number
Defined in: src/rules/rule-types.ts:27
Maximum allowed tile elevation.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.maxElevation
registry?
Section titled “registry?”
optionalregistry?:HexTileRegistry
Defined in: src/rules/validation.ts:23
Optional tile declaration registry for declaration-aware validation.
requireCoastsTouchWater?
Section titled “requireCoastsTouchWater?”
optionalrequireCoastsTouchWater?:boolean
Defined in: src/rules/rule-types.ts:33
Whether coast edges should face adjacent water tiles.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.requireCoastsTouchWater
requireExtraAssetFlags?
Section titled “requireExtraAssetFlags?”
optionalrequireExtraAssetFlags?:boolean
Defined in: src/rules/validation.ts:33
Whether EXTRA assets must be marked with requiresExtra.
requireHarborsTouchWater?
Section titled “requireHarborsTouchWater?”
optionalrequireHarborsTouchWater?:boolean
Defined in: src/rules/rule-types.ts:37
Whether harbor placements must face adjacent water tiles.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.requireHarborsTouchWater
requireReciprocalRivers?
Section titled “requireReciprocalRivers?”
optionalrequireReciprocalRivers?:boolean
Defined in: src/rules/rule-types.ts:31
Whether river edges must connect back from neighboring tiles.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.requireReciprocalRivers
requireReciprocalRoads?
Section titled “requireReciprocalRoads?”
optionalrequireReciprocalRoads?:boolean
Defined in: src/rules/rule-types.ts:29
Whether road edges must connect back from neighboring tiles.
Inherited from
Section titled “Inherited from”GameboardRuleConfig.requireReciprocalRoads
validatePlacementBlockingOverlap?
Section titled “validatePlacementBlockingOverlap?”
optionalvalidatePlacementBlockingOverlap?:boolean
Defined in: src/rules/validation.ts:37
Whether blocking placements may overlap.
validatePlacementFootprints?
Section titled “validatePlacementFootprints?”
optionalvalidatePlacementFootprints?:boolean
Defined in: src/rules/validation.ts:35
Whether placement layout footprints must point at existing tiles.
validateRegisteredDeclarations?
Section titled “validateRegisteredDeclarations?”
optionalvalidateRegisteredDeclarations?:boolean
Defined in: src/rules/validation.ts:25
Whether to validate base/support assets and declaration adjacency rules.