SpawnGameboardPlacementOptions

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

Options for spawning a runtime placement into an existing gameboard world.

Extended by

• SpawnGameboardActorOptions

Properties

assetId

assetId: string

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

Manifest or external registry asset id to render.

---

at

at: string | HexCoordinates

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

Origin tile or tile key where the placement should spawn.

---

elevationOffset?

optional elevationOffset?: number

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

Extra vertical offset above the tile elevation.

---

id?

optional id?: string

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

Explicit placement id. Defaults to a deterministic runtime id.

---

kind

kind: GameboardPlacementKind

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

Gameplay category for rules, selectors, and rendering.

---

layer?

optional layer?: GameboardPlacementLayer

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

Render and occupancy layer. Defaults from kind.

---

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.

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before spawning.

---

order?

optional order?: number

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

Stable sort order used by renderers and snapshots.

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

Local world-space offset after tile/elevation anchoring.

---

requiresExtra?

optional requiresExtra?: boolean

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

Whether the placement depends on local-only EXTRA assets.

---

rotationSteps?

optional rotationSteps?: number

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

Clockwise 60-degree rotation steps.

---

scale?

optional scale?: number

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

Uniform render 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.

---

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.