AddPropClusterRecipeStep

Defined in: src/scenario/recipe.ts:289

Recipe step that places a semantic prop cluster.

Extends

• PropClusterOptions

Properties

action

action: "addPropCluster"

Defined in: src/scenario/recipe.ts:291

Discriminator for prop-cluster placement.

---

at

at: HexCoordinates

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

Anchor tile for the cluster.

Inherited from

PropClusterOptions.at

---

clusterId?

optional clusterId?: string

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

Optional stable id shared by all placements in the cluster.

Inherited from

PropClusterOptions.clusterId

---

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.

Inherited from

PropClusterOptions.density

---

facing?

optional facing?: HexEdgeIndex

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

Edge used to orient adjacent spread patterns.

Inherited from

PropClusterOptions.facing

---

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.

Inherited from

PropClusterOptions.includeExtra

---

kind

kind: PropClusterKind

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

Cluster purpose. Determines the default asset list.

Inherited from

PropClusterOptions.kind

---

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.

Inherited from

PropClusterOptions.placement

---

rotationSteps?

optional rotationSteps?: number

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

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

Inherited from

PropClusterOptions.rotationSteps

---

scale?

optional scale?: number

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

Uniform render scale.

Inherited from

PropClusterOptions.scale