UpdateGameboardPlacementOptions

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

Options for mutating an existing runtime placement.

Properties

assetId?

optional assetId?: string

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

New manifest or external registry asset id.

at?

optional at?: string | HexCoordinates

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

New origin tile or tile key.

elevationOffset?

optional elevationOffset?: number

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

New vertical offset above the tile elevation.

kind?

optional kind?: GameboardPlacementKind

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

New gameplay category.

layer?

optional layer?: GameboardPlacementLayer

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

New render and occupancy layer.

metadata?

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

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

Replacement serializable placement metadata.

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before applying the mutation.

order?

optional order?: number

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

New stable sort order.

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

New local world-space offset after tile/elevation anchoring.

requiresExtra?

optional requiresExtra?: boolean

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

New local-only EXTRA requirement flag.

rotationSteps?

optional rotationSteps?: number

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

New clockwise 60-degree rotation steps.

scale?

optional scale?: number

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

New uniform render scale.

stackIndex?

optional stackIndex?: number

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

New stack index.

textureSet?

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

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

New texture set.