Skip to content
declarative-hex-worlds

KayKitGuideScenarioAssetUsageOptions

Defined in: src/scenario/catalog.ts:685

Filters for page-level KayKit guide asset usages.

Extended by

Section titled “Extended by”

Properties

Section titled “Properties”

assetIds?

Section titled “assetIds?”

optional assetIds?: readonly string[]

Defined in: src/scenario/catalog.ts:695

Limit usages to exact asset ids.

categories?

Section titled “categories?”

optional categories?: readonly ("tiles" | "buildings" | "decoration" | "units")[]

Defined in: src/scenario/catalog.ts:699

Limit usages by top-level manifest categories.

editionScope?

Section titled “editionScope?”

optional editionScope?: KayKitGuideScenarioEdition | readonly KayKitGuideScenarioEdition[]

Defined in: src/scenario/catalog.ts:691

Limit usages by the guide scenario edition scope.

minimumEdition?

Section titled “minimumEdition?”

optional minimumEdition?: "free" | "extra" | "all"

Defined in: src/scenario/catalog.ts:693

Limit usages by the asset’s lowest available edition; defaults to all.

pages?

Section titled “pages?”

optional pages?: readonly number[]

Defined in: src/scenario/catalog.ts:689

Limit usages to one-based guide pages.

publicApis?

Section titled “publicApis?”

optional publicApis?: readonly string[]

Defined in: src/scenario/catalog.ts:701

Limit usages by public helper/API entries attached to the asset treatment.

roles?

Section titled “roles?”

optional roles?: readonly KayKitAssetPublicRole[]

Defined in: src/scenario/catalog.ts:697

Limit usages by public treatment roles.

scenarioIds?

Section titled “scenarioIds?”

optional scenarioIds?: readonly string[]

Defined in: src/scenario/catalog.ts:687

Limit usages to exact scenario ids.