GameboardLayoutPlacementOptions

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

Options for creating placement specs from selected layout sites.

Extends

• Omit<SpawnGameboardPlacementOptions, "at" | "id" | "kind" | "layer" | "rotationSteps">

Properties

archetype?

optional archetype?: GameboardLayoutArchetypeInput

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

Archetype id or inline archetype.

---

archetypes?

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

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

Registry used to resolve archetype.

---

assetId

assetId: string

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

Manifest or external registry asset id to render.

Inherited from

SpawnGameboardPlacementOptions.assetId

---

count?

optional count?: number

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

Number of placements to create.

---

criteria?

optional criteria?: GameboardLayoutCriteria

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

Criteria merged over archetype defaults.

---

elevationOffset?

optional elevationOffset?: number

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

Extra vertical offset above the tile elevation.

Inherited from

SpawnGameboardPlacementOptions.elevationOffset

---

idPrefix?

optional idPrefix?: string

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

Prefix used when assigning deterministic placement ids.

---

kind?

optional kind?: GameboardPlacementKind

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

Placement kind override.

---

layer?

optional layer?: GameboardPlacementLayer

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

Placement layer override.

---

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

SpawnGameboardPlacementOptions.metadata

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before spawning.

Inherited from

SpawnGameboardPlacementOptions.occupancyGuard

---

order?

optional order?: number

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

Stable sort order used by renderers and snapshots.

Inherited from

SpawnGameboardPlacementOptions.order

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

Local world-space offset after tile/elevation anchoring.

Inherited from

SpawnGameboardPlacementOptions.positionOffset

---

requiresExtra?

optional requiresExtra?: boolean

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

Whether the placement depends on local-only EXTRA assets.

Inherited from

SpawnGameboardPlacementOptions.requiresExtra

---

rotationSteps?

optional rotationSteps?: number | "random"

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

Rotation steps or deterministic random rotation.

---

scale?

optional scale?: number

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

Uniform render scale.

Inherited from

SpawnGameboardPlacementOptions.scale

---

seed?

optional seed?: string | number

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

Seed used for site selection and random rotation.

---

stackIndex?

optional stackIndex?: number

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

Optional stack index for layered terrain and vertical props.

Inherited from

SpawnGameboardPlacementOptions.stackIndex

---

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

SpawnGameboardPlacementOptions.textureSet