KayKitGuideScenarioAssetRenderRequestOptions

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

Options for creating renderer-facing guide asset requests.

Extends

• KayKitGuideScenarioAssetUsageOptions

Properties

assetBaseUrl?

optional assetBaseUrl?: string

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

Base URL/path prepended to each source-relative GLTF path.

---

assetIds?

optional assetIds?: readonly string[]

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

Limit usages to exact asset ids.

Inherited from

KayKitGuideScenarioAssetUsageOptions.assetIds

---

categories?

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

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

Limit usages by top-level manifest categories.

Inherited from

KayKitGuideScenarioAssetUsageOptions.categories

---

editionScope?

optional editionScope?: KayKitGuideScenarioEdition | readonly KayKitGuideScenarioEdition[]

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

Limit usages by the guide scenario edition scope.

Inherited from

KayKitGuideScenarioAssetUsageOptions.editionScope

---

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.

Inherited from

KayKitGuideScenarioAssetUsageOptions.minimumEdition

---

pages?

optional pages?: readonly number[]

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

Limit usages to one-based guide pages.

Inherited from

KayKitGuideScenarioAssetUsageOptions.pages

---

publicApis?

optional publicApis?: readonly string[]

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

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

Inherited from

KayKitGuideScenarioAssetUsageOptions.publicApis

---

roles?

optional roles?: readonly KayKitAssetPublicRole[]

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

Limit usages by public treatment roles.

Inherited from

KayKitGuideScenarioAssetUsageOptions.roles

---

scenarioIds?

optional scenarioIds?: readonly string[]

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

Limit usages to exact scenario ids.

Inherited from

KayKitGuideScenarioAssetUsageOptions.scenarioIds

---

urlResolver?

optional urlResolver?: KayKitGuideScenarioAssetUrlResolver

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

Custom URL resolver, used before assetBaseUrl when provided.