UpdateGameboardPlacementOptions

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

Options for mutating an existing runtime placement.

Properties

assetId?

optional assetId?: string

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

New manifest or external registry asset id.

---

at?

optional at?: string | HexCoordinates

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

New origin tile or tile key.

---

elevationOffset?

optional elevationOffset?: number

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

New vertical offset above the tile elevation.

---

kind?

optional kind?: GameboardPlacementKind

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

New gameplay category.

---

layer?

optional layer?: GameboardPlacementLayer

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

New render and occupancy layer.

---

metadata?

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

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

Replacement serializable placement metadata.

---

occupancyGuard?

optional occupancyGuard?: GameboardPlacementOccupancyGuard

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

Optional occupancy validation before applying the mutation.

---

order?

optional order?: number

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

New stable sort order.

---

positionOffset?

optional positionOffset?: GameboardPlacementPositionOffset

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

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

---

requiresExtra?

optional requiresExtra?: boolean

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

New local-only EXTRA requirement flag.

---

rotationSteps?

optional rotationSteps?: number

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

New clockwise 60-degree rotation steps.

---

scale?

optional scale?: number

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

New uniform render scale.

---

stackIndex?

optional stackIndex?: number

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

New stack index.

---

textureSet?

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

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

New texture set.