Skip to content
declarative-hex-worlds

PropClusterOptions

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

Options for adding a semantic cluster of props.

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

at

Section titled “at”

at: HexCoordinates

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

Anchor tile for the cluster.

clusterId?

Section titled “clusterId?”

optional clusterId?: string

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

Optional stable id shared by all placements in the cluster.

density?

Section titled “density?”

optional density?: number

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

Percentage of the cluster’s available asset list to place, from 0 to 1. Defaults to 1.

facing?

Section titled “facing?”

optional facing?: HexEdgeIndex

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

Edge used to orient adjacent spread patterns.

includeExtra?

Section titled “includeExtra?”

optional includeExtra?: boolean

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

Include local-only EXTRA prop assets when the cluster kind has them. Defaults to false.

kind

Section titled “kind”

kind: PropClusterKind

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

Cluster purpose. Determines the default asset list.

placement?

Section titled “placement?”

optional placement?: PropClusterPlacement

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

Whether assets stack on one tile or spread to neighboring tiles. Defaults to adjacent.

rotationSteps?

Section titled “rotationSteps?”

optional rotationSteps?: number

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

Base clockwise 60-degree rotation steps. Defaults to facing.

scale?

Section titled “scale?”

optional scale?: number

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

Uniform render scale.