GameboardBuilder
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:101
Fluent builder for deterministic gameboard plans using KayKit guide variants, stacked terrain, roads, rivers, harbors, settlements, props, and EXTRA units.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GameboardBuilder(
options):GameboardBuilder
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:117
Create a builder and initialize all tiles in the requested shape.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”GameboardBuilder
Properties
Section titled “Properties”
readonlyseed:string
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:103
Seed used by deterministic builder helpers.
readonlyshape:GameboardShape
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:105
Shape populated by this builder.
textureSet
Section titled “textureSet”
readonlytextureSet:"default"|"fall"|"summer"|"winter"
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:107
Texture set applied to generated terrain.
Methods
Section titled “Methods”addBridge()
Section titled “addBridge()”addBridge(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:365
Add a bridge structure with bridge-specific metadata instead of requiring callers to know the raw neutral-structure asset ids.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addConstructionSite()
Section titled “addConstructionSite()”addConstructionSite(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:411
Add a construction, ruin, or worksite structure with construction metadata.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addElevationRamp()
Section titled “addElevationRamp()”addElevationRamp(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:455
Add a sloped grass ramp with ramp-specific metadata instead of requiring
callers to place hex_grass_sloped_high or hex_grass_sloped_low directly.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addFactionBuilding()
Section titled “addFactionBuilding()”addFactionBuilding(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:331
Add a faction building structure placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addFlag()
Section titled “addFlag()”addFlag(
at,faction,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:518
Add a faction flag prop placement.
Parameters
Section titled “Parameters”faction
Section titled “faction”"blue" | "green" | "red" | "yellow"
options?
Section titled “options?”rotationSteps?
Section titled “rotationSteps?”number
scale?
Section titled “scale?”number
Returns
Section titled “Returns”this
addForest()
Section titled “addForest()”addForest(
coordinates,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:300
Add a forest decoration and mark the tile as forest terrain.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”options?
Section titled “options?”boolean
"small" | "medium" | "large"
species?
Section titled “species?”"A" | "B"
Returns
Section titled “Returns”this
addFortification()
Section titled “addFortification()”addFortification(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:386
Add a wall or fence segment with fortification metadata.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addHarbor()
Section titled “addHarbor()”addHarbor(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:673
Add a harbor structure, mark the coast/water relationship, and optionally place adjacent water props.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addHill()
Section titled “addHill()”addHill(
coordinates,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:275
Add a hill decoration and mark the tile as hill terrain.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”options?
Section titled “options?”rotationSteps?
Section titled “rotationSteps?”number
single?
Section titled “single?”boolean
variant?
Section titled “variant?”withTrees?
Section titled “withTrees?”boolean
Returns
Section titled “Returns”this
addMountainStack()
Section titled “addMountainStack()”addMountainStack(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:247
Add an elevated mountain tile plus a visible mountain-stack placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addNature()
Section titled “addNature()”addNature(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:486
Add a nature decoration placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addNeutralStructure()
Section titled “addNeutralStructure()”addNeutralStructure(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:348
Add a neutral structure placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addPlacement()
Section titled “addPlacement()”addPlacement(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:746
Add a custom placement to the plan.
Parameters
Section titled “Parameters”options
Section titled “options”assetId
Section titled “assetId”string
elevationOffset?
Section titled “elevationOffset?”number
metadata?
Section titled “metadata?”Readonly<Record<string, string | number | boolean | null>>
requiresExtra?
Section titled “requiresExtra?”boolean
rotationSteps?
Section titled “rotationSteps?”number
scale?
Section titled “scale?”number
stackIndex?
Section titled “stackIndex?”number
Returns
Section titled “Returns”this
addProp()
Section titled “addProp()”addProp(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:502
Add a prop placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addPropCluster()
Section titled “addPropCluster()”addPropCluster(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:530
Add a semantic prop cluster such as a camp, worksite, stable yard, or cache.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addRiverPath()
Section titled “addRiverPath()”addRiverPath(
path,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:227
Add river connectivity along a coordinate path.
Parameters
Section titled “Parameters”readonly HexCoordinates[]
options?
Section titled “options?”crossing?
Section titled “crossing?”"A" | "B"
curvy?
Section titled “curvy?”boolean
waterless?
Section titled “waterless?”boolean
Returns
Section titled “Returns”this
addRoadPath()
Section titled “addRoadPath()”addRoadPath(
path,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:209
Add road connectivity along a coordinate path.
Parameters
Section titled “Parameters”readonly HexCoordinates[]
options?
Section titled “options?”slope?
Section titled “slope?”"high" | "low"
Returns
Section titled “Returns”this
addSettlement()
Section titled “addSettlement()”addSettlement(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:324
Add a settlement building. Alias for addFactionBuilding.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addSiegeProjectile()
Section titled “addSiegeProjectile()”addSiegeProjectile(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:432
Add a neutral siege projectile with projectile-specific metadata.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addTransition()
Section titled “addTransition()”addTransition(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:577
Add an EXTRA texture transition placement.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addUnit()
Section titled “addUnit()”addUnit(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:594
Add one unit part placement from the EXTRA unit library.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
addUnitPreset()
Section titled “addUnitPreset()”addUnitPreset(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:622
Add a predefined multi-part unit composition.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
build()
Section titled “build()”build():
GameboardPlan
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:787
Build an immutable gameboard plan from current builder state.
Returns
Section titled “Returns”scatterDecorations()
Section titled “scatterDecorations()”scatterDecorations(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:708
Scatter random decoration placements across matching terrain.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this
setCoastEdges()
Section titled “setCoastEdges()”setCoastEdges(
coordinates,waterEdges,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:190
Mark a tile as coast and set the edges that face water.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”waterEdges
Section titled “waterEdges”number | readonly HexEdgeIndex[]
options?
Section titled “options?”waterless?
Section titled “waterless?”boolean
Returns
Section titled “Returns”this
setElevation()
Section titled “setElevation()”setElevation(
coordinates,elevation):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:180
Set the elevation for an existing tile.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”elevation
Section titled “elevation”number
Returns
Section titled “Returns”this
setTerrain()
Section titled “setTerrain()”setTerrain(
coordinates,terrain,options?):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:132
Set a base grass or water terrain tile.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”terrain
Section titled “terrain”"grass" | "water"
options?
Section titled “options?”baseAssetId?
Section titled “baseAssetId?”string
elevation?
Section titled “elevation?”number
textureSet?
Section titled “textureSet?”"default" | "fall" | "summer" | "winter"
Returns
Section titled “Returns”this
setTextureSet()
Section titled “setTextureSet()”setTextureSet(
coordinates,textureSet):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:171
Set the texture set for an existing tile without changing its terrain.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”textureSet
Section titled “textureSet”"default" | "fall" | "summer" | "winter"
Returns
Section titled “Returns”this
setTileAsset()
Section titled “setTileAsset()”setTileAsset(
options):this
Defined in: packages/declarative-hex-worlds/src/gameboard/gameboard.ts:149
Override a tile’s base asset, terrain, elevation, connectivity, and tags.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”this