GameboardPieceLayoutRuleOptions

Defined in: src/pieces/pieces.ts:237

Overrides used when turning a piece into a layout fill rule.

Properties

archetypes?

optional archetypes?: Readonly<Record<string, GameboardLayoutArchetype>>

Defined in: src/pieces/pieces.ts:261

Archetype registry used by layout.

---

assetId?

optional assetId?: string

Defined in: src/pieces/pieces.ts:241

Asset id override.

---

count?

optional count?: number

Defined in: src/pieces/pieces.ts:243

Explicit placement count.

---

criteria?

optional criteria?: GameboardLayoutCriteria

Defined in: src/pieces/pieces.ts:253

Criteria merged over piece defaults.

---

elevationOffset?

optional elevationOffset?: number

Defined in: src/pieces/pieces.ts:259

Vertical offset override.

---

fill?

optional fill?: number

Defined in: src/pieces/pieces.ts:245

Fraction of candidate sites to fill.

---

id?

optional id?: string

Defined in: src/pieces/pieces.ts:239

Fill rule id.

---

idPrefix?

optional idPrefix?: string

Defined in: src/pieces/pieces.ts:251

Prefix used for generated placement ids.

---

maxCount?

optional maxCount?: number

Defined in: src/pieces/pieces.ts:249

Maximum placement count.

---

metadata?

optional metadata?: Readonly<Record<string, string | number | boolean | null>>

Defined in: src/pieces/pieces.ts:267

Metadata merged over piece metadata.

---

minCount?

optional minCount?: number

Defined in: src/pieces/pieces.ts:247

Minimum placement count.

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

Defined in: src/pieces/pieces.ts:265

Optional occupancy guard for spawned placements.

---

requiresExtra?

optional requiresExtra?: boolean

Defined in: src/pieces/pieces.ts:263

Local-only asset override.

---

rotationSteps?

optional rotationSteps?: number | "random"

Defined in: src/pieces/pieces.ts:257

Rotation override.

---

scale?

optional scale?: number

Defined in: src/pieces/pieces.ts:255

Uniform render scale override.