Skip to content

HarborOptions

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:388

Options for adding a harbor structure and optional water props.

at: HexCoordinates

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:390

Coast tile where the harbor is anchored.


facing: HexEdgeIndex

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:392

Edge facing adjacent water.


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

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:394

Faction color for the harbor.


optional includeProps?: boolean

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:398

Whether to add adjacent boat/anchor props.


optional kind?: HarborKind

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:396

Harbor structure variant.


optional rotationSteps?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/plan.ts:400

Clockwise 60-degree rotation steps. Defaults to facing.