GameboardLayoutFillRule

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:460

Rule for seeded layout fill across one or more assets.

Extends

• Omit<GameboardLayoutPlacementOptions, "assetId" | "count" | "seed" | "idPrefix">

Properties

archetype?

optional archetype?: GameboardLayoutArchetypeInput

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:430

Archetype id or inline archetype.

Inherited from

GameboardLayoutPlacementOptions.archetype

---

archetypes?

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

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:432

Registry used to resolve archetype.

Inherited from

GameboardLayoutPlacementOptions.archetypes

---

assetId?

optional assetId?: string

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:465

Single asset id used by the rule.

---

assets?

optional assets?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:467

Asset ids cycled deterministically across selected sites.

---

count?

optional count?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:469

Explicit placement count.

---

criteria?

optional criteria?: GameboardLayoutCriteria

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:446

Criteria merged over archetype defaults.

Inherited from

GameboardLayoutPlacementOptions.criteria

---

elevationOffset?

optional elevationOffset?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:310

Extra vertical offset above the tile elevation.

Inherited from

SpawnGameboardPlacementOptions.elevationOffset

---

fill?

optional fill?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:471

Fraction of candidate sites to fill.

---

id?

optional id?: string

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:463

Stable rule id used in diagnostics and generated ids.

---

idPrefix?

optional idPrefix?: string

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:477

Prefix used when assigning deterministic placement ids.

---

kind?

optional kind?: GameboardPlacementKind

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:434

Placement kind override.

Inherited from

GameboardLayoutPlacementOptions.kind

---

layer?

optional layer?: GameboardPlacementLayer

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:436

Placement layer override.

Inherited from

GameboardLayoutPlacementOptions.layer

---

maxCount?

optional maxCount?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:475

Maximum placement count after fill/count calculation.

---

metadata?

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

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:324

Serializable placement metadata for rules, ECS interop, and render hints.

Inherited from

SpawnGameboardPlacementOptions.metadata

---

minCount?

optional minCount?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:473

Minimum placement count after fill/count calculation.

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:326

Optional occupancy validation before spawning.

Inherited from

SpawnGameboardPlacementOptions.occupancyGuard

---

onDiagnostics?

optional onDiagnostics?: (diagnostics) => void

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:454

Called when the selected site count is less than the requested count (including zero). Reports the resolved criteria and a rejection histogram so an empty result is distinguishable from “board is full”. Never called when selectedCount >= requestedCount. No-op by default — absent option means zero behavior change.

Parameters

diagnostics

GameboardLayoutPlacementDiagnostics

Returns

void

Inherited from

Omit.onDiagnostics

---

order?

optional order?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:318

Stable sort order used by renderers and snapshots.

Inherited from

SpawnGameboardPlacementOptions.order

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:312

Local world-space offset after tile/elevation anchoring.

Inherited from

SpawnGameboardPlacementOptions.positionOffset

---

requiresExtra?

optional requiresExtra?: boolean

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:322

Whether the placement depends on local-only EXTRA assets.

Inherited from

SpawnGameboardPlacementOptions.requiresExtra

---

rotationSteps?

optional rotationSteps?: number | "random"

Defined in: packages/declarative-hex-worlds/src/coordinates/layout.ts:444

Rotation steps or deterministic random rotation.

Inherited from

Omit.rotationSteps

---

scale?

optional scale?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:316

Uniform render scale.

Inherited from

SpawnGameboardPlacementOptions.scale

---

stackIndex?

optional stackIndex?: number

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:320

Optional stack index for layered terrain and vertical props.

Inherited from

SpawnGameboardPlacementOptions.stackIndex

---

textureSet?

optional textureSet?: "default" | "fall" | "summer" | "winter"

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:308

Texture set override. Defaults to the origin tile texture set.

Inherited from

SpawnGameboardPlacementOptions.textureSet