GameboardPlacementObjectSyncOptions
Defined in: src/three/three.ts:152
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: src/three/three.ts:64
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: src/three/three.ts:62
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: src/three/three.ts:47
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: 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: 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
catalog?
Section titled “catalog?”
optionalcatalog?:ManifestAssetCatalog
Defined in: src/three/three.ts:45
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: src/three/three.ts:94
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: src/three/three.ts:163
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: src/three/three.ts:161
Optional animation delta to advance during this sync pass.
editionBaseUrls?
Section titled “editionBaseUrls?”
optionaleditionBaseUrls?:Partial<Record<"free"|"extra",string|URL>>
Defined in: 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: src/three/three.ts:49
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”loader:
GameboardGltfLoader
Defined in: src/three/three.ts:92
GLTF-compatible async loader.
Inherited from
Section titled “Inherited from”LoadGameboardPlacementObjectOptions.loader
parent?
Section titled “parent?”
optionalparent?:Object3D<Object3DEventMap>
Defined in: src/three/three.ts:155
Parent object to receive loaded placement objects.
playAnimation?
Section titled “playAnimation?”
optionalplayAnimation?:boolean
Defined in: src/three/three.ts:96
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: src/three/three.ts:157
Mutable cache keyed by placement id.
removeStale?
Section titled “removeStale?”
optionalremoveStale?:boolean
Defined in: src/three/three.ts:159
Remove cached objects that no longer appear in the placement list.
throwOnError?
Section titled “throwOnError?”
optionalthrowOnError?:boolean
Defined in: src/three/three.ts:165
Rethrow load errors instead of collecting them in the result.