GameboardPlacementObjectSyncOptions
Defined in: packages/declarative-hex-worlds/src/three/three.ts:281
Options for reconciling a Three.js scene with a placement list.
Extends
Section titled “Extends”Properties
Section titled “Properties”animationUrlResolver?
Section titled “animationUrlResolver?”
optionalanimationUrlResolver?: (placement) =>string|undefined
Defined in: packages/declarative-hex-worlds/src/asset-source/placement-resolution.ts:47
App-specific animation URL resolver.
Parameters
Section titled “Parameters”placement
Section titled “placement”Returns
Section titled “Returns”string | undefined
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.animationUrlResolver
animationUrls?
Section titled “animationUrls?”
optionalanimationUrls?:Readonly<Record<string,string>>
Defined in: packages/declarative-hex-worlds/src/asset-source/placement-resolution.ts:45
Explicit asset-id-to-animation-URL map.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.animationUrls
assetUrls?
Section titled “assetUrls?”
optionalassetUrls?:Readonly<Record<string,string>>
Defined in: packages/declarative-hex-worlds/src/asset-source/placement-resolution.ts:32
Explicit asset-id-to-URL overrides, useful for local-only Vite @fs assets.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.assetUrls
baseUrl?
Section titled “baseUrl?”
optionalbaseUrl?:string|URL
Defined in: packages/declarative-hex-worlds/src/manifest/schema.ts:147
Base URL applied to every model path when no edition-specific base exists.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.baseUrl
bootstrapAssetRoot?
Section titled “bootstrapAssetRoot?”
optionalbootstrapAssetRoot?:string|URL
Defined in: packages/declarative-hex-worlds/src/manifest/schema.ts:160
Consumer’s bootstrap asset root (per PRD RB3).
When set, manifest sourcePath values (e.g. buildings/blue/foo.gltf)
are joined with this root to produce the resolved URL —
<bootstrapAssetRoot>/<sourcePath> (flat layout, no subdirectory prefix).
Honored only when neither baseUrl nor a matching editionBaseUrls entry is set; explicit base URLs always win.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.bootstrapAssetRoot
cacheLoads?
Section titled “cacheLoads?”
optionalcacheLoads?:boolean
Defined in: packages/declarative-hex-worlds/src/three/three.ts:225
Deduplicates loader calls by URL so multiple placements sharing an asset
trigger exactly one loadAsync invocation. The cached GLTF source is
never mutated directly — each placement still receives its own cloned
Object3D scene instance. Defaults to true.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.cacheLoads
catalog?
Section titled “catalog?”
optionalcatalog?:ManifestAssetCatalog
Defined in: packages/declarative-hex-worlds/src/asset-source/placement-resolution.ts:30
Manifest or manifest bundle used for packaged FREE/EXTRA asset ids.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.catalog
clipName?
Section titled “clipName?”
optionalclipName?:string
Defined in: packages/declarative-hex-worlds/src/three/three.ts:216
Optional clip name override. Defaults to placement metadata when present.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.clipName
clipNameResolver?
Section titled “clipNameResolver?”
optionalclipNameResolver?: (placement) =>string|undefined
Defined in: packages/declarative-hex-worlds/src/three/three.ts:291
Per-placement clip-name resolver.
Parameters
Section titled “Parameters”placement
Section titled “placement”Returns
Section titled “Returns”string | undefined
deltaSeconds?
Section titled “deltaSeconds?”
optionaldeltaSeconds?:number
Defined in: packages/declarative-hex-worlds/src/three/three.ts:289
Optional animation delta to advance during this sync pass.
editionBaseUrls?
Section titled “editionBaseUrls?”
optionaleditionBaseUrls?:Partial<Record<"free"|"extra",string|URL>>
Defined in: packages/declarative-hex-worlds/src/manifest/schema.ts:149
Per-edition base URLs, useful when FREE is packaged and EXTRA is local.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.editionBaseUrls
fallback?
Section titled “fallback?”
optionalfallback?: (placement) =>string|undefined
Defined in: packages/declarative-hex-worlds/src/asset-source/placement-resolution.ts:34
Last-chance resolver for app-specific asset stores.
Parameters
Section titled “Parameters”placement
Section titled “placement”Returns
Section titled “Returns”string | undefined
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.fallback
loader?
Section titled “loader?”
optionalloader?:GameboardGltfLoader
Defined in: packages/declarative-hex-worlds/src/three/three.ts:206
GLTF-compatible async loader. OPTIONAL: only required when a placement
actually resolves to a gltf request. A tileset-ONLY board (every placement
resolves to a tileset-cell) needs no GLTF loader — supply only textureLoader.
A gltf request with no loader throws a clear error at load time.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.loader
parent?
Section titled “parent?”
optionalparent?:Object3D<Object3DEventMap>
Defined in: packages/declarative-hex-worlds/src/three/three.ts:283
Parent object to receive loaded placement objects.
playAnimation?
Section titled “playAnimation?”
optionalplayAnimation?:boolean
Defined in: packages/declarative-hex-worlds/src/three/three.ts:218
Whether to start the selected animation immediately. Defaults to true.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.playAnimation
records?
Section titled “records?”
optionalrecords?:Map<string,LoadedGameboardPlacementObject>
Defined in: packages/declarative-hex-worlds/src/three/three.ts:285
Mutable cache keyed by placement id.
removeStale?
Section titled “removeStale?”
optionalremoveStale?:boolean
Defined in: packages/declarative-hex-worlds/src/three/three.ts:287
Remove cached objects that no longer appear in the placement list.
source?
Section titled “source?”
optionalsource?:AssetSource
Defined in: packages/declarative-hex-worlds/src/three/three.ts:212
Optional asset source (RFC0-7). When provided, a placement resolving to a
tileset-cell request is rendered as a textured-hex mesh instead of a GLTF;
a gltf request (or no resolution) falls through to the GLTF loader path.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.source
textureLoader?
Section titled “textureLoader?”
optionaltextureLoader?:GameboardSheetTextureLoader
Defined in: packages/declarative-hex-worlds/src/three/three.ts:214
Sheet-texture loader, required when source can emit tileset-cell requests.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.textureLoader
throwOnError?
Section titled “throwOnError?”
optionalthrowOnError?:boolean
Defined in: packages/declarative-hex-worlds/src/three/three.ts:293
Rethrow load errors instead of collecting them in the result.