SpawnGameboardPlacementOptions

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

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

Extended by

SpawnGameboardActorOptions

Properties

assetId

assetId: string

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

Manifest or external registry asset id to render.

at

at: string | HexCoordinates

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

Origin tile or tile key where the placement should spawn.

elevationOffset?

optional elevationOffset?: number

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

Extra vertical offset above the tile elevation.

id?

optional id?: string

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

Explicit placement id. Defaults to a deterministic runtime id.

kind

kind: GameboardPlacementKind

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

Gameplay category for rules, selectors, and rendering.

layer?

optional layer?: GameboardPlacementLayer

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

Render and occupancy layer. Defaults from kind.

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.

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before spawning.

order?

optional order?: number

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

Stable sort order used by renderers and snapshots.

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

Local world-space offset after tile/elevation anchoring.

requiresExtra?

optional requiresExtra?: boolean

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

Whether the placement depends on local-only EXTRA assets.

rotationSteps?

optional rotationSteps?: number

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

Clockwise 60-degree rotation steps.

scale?

optional scale?: number

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

Uniform render scale.

stackIndex?

optional stackIndex?: number

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

Optional stack index for layered terrain and vertical props.

textureSet?

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

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

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