Skip to content

AddPropClusterRecipeStep

Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:286

Recipe step that places a semantic prop cluster.

action: "addPropCluster"

Defined in: packages/declarative-hex-worlds/src/scenario/recipe.ts:288

Discriminator for prop-cluster placement.


at: HexCoordinates

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

Anchor tile for the cluster.

PropClusterOptions.at


optional clusterId?: string

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

Optional stable id shared by all placements in the cluster.

PropClusterOptions.clusterId


optional density?: number

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

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

PropClusterOptions.density


optional facing?: HexEdgeIndex

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

Edge used to orient adjacent spread patterns.

PropClusterOptions.facing


optional includeExtra?: boolean

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

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

PropClusterOptions.includeExtra


kind: PropClusterKind

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

Cluster purpose. Determines the default asset list.

PropClusterOptions.kind


optional placement?: PropClusterPlacement

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

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

PropClusterOptions.placement


optional rotationSteps?: number

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

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

PropClusterOptions.rotationSteps


optional scale?: number

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

Uniform render scale.

PropClusterOptions.scale