Skip to content
declarative-hex-worlds

SeededGameboardDensityRuleOptions

Defined in: src/rules/rules.ts:67

Overrides for one built-in seeded density preset.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

archetype?

Section titled “archetype?”

optional archetype?: GameboardLayoutArchetypeInput

Defined in: src/rules/rules.ts:80

Archetype id or inline archetype to use for placement constraints.

archetypes?

Section titled “archetypes?”

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

Defined in: src/coordinates/layout.ts:406

Registry used to resolve archetype.

Inherited from

Section titled “Inherited from”

GameboardLayoutPlacementOptions.archetypes

assetId?

Section titled “assetId?”

optional assetId?: string

Defined in: src/rules/rules.ts:72

Single asset id to spawn for the preset.

assets?

Section titled “assets?”

optional assets?: readonly string[]

Defined in: src/rules/rules.ts:74

Asset pool to choose from for the preset.

count?

Section titled “count?”

optional count?: number

Defined in: src/rules/rules.ts:76

Exact placement count for the preset.

criteria?

Section titled “criteria?”

optional criteria?: GameboardLayoutCriteria

Defined in: src/coordinates/layout.ts:420

Criteria merged over archetype defaults.

Inherited from

Section titled “Inherited from”

GameboardLayoutPlacementOptions.criteria

elevationOffset?

Section titled “elevationOffset?”

optional elevationOffset?: number

Defined in: src/koota/koota.ts:311

Extra vertical offset above the tile elevation.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.elevationOffset

fill?

Section titled “fill?”

optional fill?: number

Defined in: src/rules/rules.ts:78

Fraction of eligible tiles to fill for the preset.

id?

Section titled “id?”

optional id?: string

Defined in: src/rules/rules.ts:70

Explicit fill rule id.

idPrefix?

Section titled “idPrefix?”

optional idPrefix?: string

Defined in: src/coordinates/layout.ts:443

Prefix used when assigning deterministic placement ids.

Inherited from

Section titled “Inherited from”

GameboardLayoutFillRule.idPrefix

kind?

Section titled “kind?”

optional kind?: GameboardPlacementKind

Defined in: src/coordinates/layout.ts:408

Placement kind override.

Inherited from

Section titled “Inherited from”

GameboardLayoutPlacementOptions.kind

layer?

Section titled “layer?”

optional layer?: GameboardPlacementLayer

Defined in: src/coordinates/layout.ts:410

Placement layer override.

Inherited from

Section titled “Inherited from”

GameboardLayoutPlacementOptions.layer

maxCount?

Section titled “maxCount?”

optional maxCount?: number

Defined in: src/coordinates/layout.ts:441

Maximum placement count after fill/count calculation.

Inherited from

Section titled “Inherited from”

GameboardLayoutFillRule.maxCount

metadata?

Section titled “metadata?”

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

Defined in: src/koota/koota.ts:325

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

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.metadata

minCount?

Section titled “minCount?”

optional minCount?: number

Defined in: src/coordinates/layout.ts:439

Minimum placement count after fill/count calculation.

Inherited from

Section titled “Inherited from”

GameboardLayoutFillRule.minCount

occupancyGuard?

Section titled “occupancyGuard?”

optional occupancyGuard?: GameboardPlacementOccupancyGuard

Defined in: src/koota/koota.ts:327

Optional occupancy validation before spawning.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.occupancyGuard

order?

Section titled “order?”

optional order?: number

Defined in: src/koota/koota.ts:319

Stable sort order used by renderers and snapshots.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.order

positionOffset?

Section titled “positionOffset?”

optional positionOffset?: GameboardPlacementPositionOffset

Defined in: src/koota/koota.ts:313

Local world-space offset after tile/elevation anchoring.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.positionOffset

requiresExtra?

Section titled “requiresExtra?”

optional requiresExtra?: boolean

Defined in: src/koota/koota.ts:323

Whether the placement depends on local-only EXTRA assets.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.requiresExtra

rotationSteps?

Section titled “rotationSteps?”

optional rotationSteps?: number | "random"

Defined in: src/coordinates/layout.ts:418

Rotation steps or deterministic random rotation.

Inherited from

Section titled “Inherited from”

Omit.rotationSteps

scale?

Section titled “scale?”

optional scale?: number

Defined in: src/koota/koota.ts:317

Uniform render scale.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.scale

stackIndex?

Section titled “stackIndex?”

optional stackIndex?: number

Defined in: src/koota/koota.ts:321

Optional stack index for layered terrain and vertical props.

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.stackIndex

textureSet?

Section titled “textureSet?”

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

Defined in: src/koota/koota.ts:309

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

Inherited from

Section titled “Inherited from”

SpawnGameboardPlacementOptions.textureSet