KayKitAssetPublicTreatment
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:412
Public API treatment for one asset id. This is the contract that keeps assets from becoming a passive catalog entry with no builder, selector, or layout path.
Properties
Section titled “Properties”assetId
Section titled “assetId”assetId:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:414
Stable manifest asset id used by plans and placement records.
category
Section titled “category”category:
"tiles"|"buildings"|"decoration"|"units"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:418
Top-level manifest category.
minimumEdition
Section titled “minimumEdition”minimumEdition:
"free"|"extra"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:416
Lowest edition that exposes this asset id.
placementKind
Section titled “placementKind”placementKind:
"coast"|"road"|"river"|"unit"|"decoration"|"prop"|"terrain"|"transition"|"structure"
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:426
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:437
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:439
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:445
Whether this asset should be treated as local-only/EXTRA in apps.
role:
KayKitAssetPublicRole
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:424
Intent-level role used by docs, selectors, and gameplay placement helpers.
scenario
Section titled “scenario”scenario:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:443
Human-readable scenario group for visual contact sheets and docs.
sourceImages
Section titled “sourceImages”sourceImages: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:441
Extracted guide images that motivate this treatment.
sourcePath
Section titled “sourcePath”sourcePath:
string
Defined in: packages/declarative-hex-worlds/src/scenario/catalog.ts:422
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:420
Manifest subcategory or source folder.