KayKitGuideScenarioAssetUsage
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:643
Page-level asset occurrence from the decomposed KayKit guide matrix. Unlike asset coverage rows, this keeps repeated scenario uses so renderers, screenshots, docs, and audits can reproduce the exact guide treatment set.
Properties
Section titled “Properties”assetId
Section titled “assetId”assetId:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:655
Stable manifest asset id used by plans and placement records.
caption
Section titled “caption”caption:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:683
Stable short caption for contact sheets and renderer previews.
category
Section titled “category”category:
"tiles"|"buildings"|"decoration"|"units"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:659
Top-level manifest category.
docs: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:673
Documentation pages linked by the matching guide scenario.
label:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:681
Stable short label for contact sheets and renderer previews.
minimumEdition
Section titled “minimumEdition”minimumEdition:
"free"|"extra"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:657
Lowest edition that exposes this asset id.
page:
number
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:647
One-based extracted guide page number.
placementKind
Section titled “placementKind”placementKind:
"coast"|"road"|"river"|"unit"|"decoration"|"prop"|"terrain"|"transition"|"structure"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:667
Placement kind produced by the public board/runtime APIs.
placementLayer
Section titled “placementLayer”placementLayer:
"unit"|"terrain"|"structure"|"surface"|"feature"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:669
Placement layer produced by the public board/runtime APIs.
publicApi
Section titled “publicApi”publicApi: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:671
Public helpers or selectors that intentionally exercise this asset.
requiresExtra
Section titled “requiresExtra”requiresExtra:
boolean
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:679
Whether this asset should be treated as local-only/EXTRA in apps.
role:
KayKitAssetPublicRole
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:665
Intent-level role used by docs, selectors, and gameplay placement helpers.
scenarioEdition
Section titled “scenarioEdition”scenarioEdition:
KayKitGuideScenarioEdition
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:653
Edition scope for the source guide scenario.
scenarioId
Section titled “scenarioId”scenarioId:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:645
Stable scenario id that introduced this asset occurrence.
sourceImage
Section titled “sourceImage”sourceImage:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:651
Extracted PNG page used as source material.
sourcePath
Section titled “sourcePath”sourcePath:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:663
Source-relative GLTF path for FREE packaging or local EXTRA ingest.
subcategory
Section titled “subcategory”subcategory:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:661
Manifest subcategory or source folder.
title:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:649
Human-readable guide page title.
treatment
Section titled “treatment”treatment:
KayKitAssetPublicTreatment
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:677
Full public treatment record for this asset id.
visualArtifacts
Section titled “visualArtifacts”visualArtifacts: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:675
Screenshot or docs artifacts linked by the matching guide scenario.