Skip to content
declarative-hex-worlds

SeededGameboardOptions

Defined in: src/rules/rules.ts:167

High-level options for generating a playable seeded medieval gameboard.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

defaultTerrain?

Section titled “defaultTerrain?”

optional defaultTerrain?: "grass" | "water"

Defined in: src/gameboard/gameboard.ts:146

Initial terrain used for every generated tile.

Inherited from

Section titled “Inherited from”

GameboardPlanOptions.defaultTerrain

faction?

Section titled “faction?”

optional faction?: "blue" | "green" | "red" | "yellow"

Defined in: src/rules/rules.ts:171

Primary faction used for settlements, harbors, and generated units.

forestTiles?

Section titled “forestTiles?”

optional forestTiles?: number

Defined in: src/rules/rules.ts:177

Number of forest tiles to place.

harborKind?

Section titled “harborKind?”

optional harborKind?: HarborKind

Defined in: src/rules/rules.ts:173

Harbor composition variant to place on the coast.

hillTiles?

Section titled “hillTiles?”

optional hillTiles?: number

Defined in: src/rules/rules.ts:179

Number of hill tiles to place.

layoutArchetypes?

Section titled “layoutArchetypes?”

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

Defined in: src/rules/rules.ts:187

Additional archetypes available to generated layout fill rules.

layoutDensity?

Section titled “layoutDensity?”

optional layoutDensity?: SeededGameboardLayoutDensityOptions

Defined in: src/rules/rules.ts:185

Built-in density preset overrides for layout fill.

layoutFills?

Section titled “layoutFills?”

optional layoutFills?: readonly GameboardLayoutFillRule[]

Defined in: src/rules/rules.ts:191

Additional layout fill rules to run after built-in density and piece rules.

layoutFillSeed?

Section titled “layoutFillSeed?”

optional layoutFillSeed?: string | number

Defined in: src/rules/rules.ts:189

Seed used for the layout fill pass.

mountainStacks?

Section titled “mountainStacks?”

optional mountainStacks?: number

Defined in: src/rules/rules.ts:175

Number of mountain stacks to place.

pieceFills?

Section titled “pieceFills?”

optional pieceFills?: readonly SeededGameboardPieceFillOptions[]

Defined in: src/rules/rules.ts:195

Piece fill rules that spawn registered external or custom pieces.

pieceRegistry?

Section titled “pieceRegistry?”

optional pieceRegistry?: GameboardPieceRegistry

Defined in: src/rules/rules.ts:193

Piece registry used by seeded piece fill rules.

scatterProps?

Section titled “scatterProps?”

optional scatterProps?: number

Defined in: src/rules/rules.ts:183

Number of loose prop decorations to scatter.

seed?

Section titled “seed?”

optional seed?: string | number

Defined in: src/gameboard/gameboard.ts:140

Deterministic seed for generation.

Inherited from

Section titled “Inherited from”

GameboardPlanOptions.seed

settlements?

Section titled “settlements?”

optional settlements?: number

Defined in: src/rules/rules.ts:181

Number of faction settlements to place.

shape?

Section titled “shape?”

optional shape?: GameboardShape

Defined in: src/rules/rules.ts:169

Board shape to generate.

Overrides

Section titled “Overrides”

GameboardPlanOptions.shape

textureSet?

Section titled “textureSet?”

optional textureSet?: "default" | "fall" | "summer" | "winter"

Defined in: src/gameboard/gameboard.ts:144

Texture set applied to generated terrain.

Inherited from

Section titled “Inherited from”

GameboardPlanOptions.textureSet