AssetsAPI
Defined in: packages/threeplay/src/plugins/assets/types.ts:76
API of the assets plugin. Every load* call delays the first scene until done.
Methods
Section titled “Methods”defineModel()
Section titled “defineModel()”defineModel(
name,scene,animations?):ModelData
Defined in: packages/threeplay/src/plugins/assets/types.ts:92
Registers a procedurally built or already parsed model under a name, so
model(name) can instance it. Useful without network (tests) or with a
custom loader.
Parameters
Section titled “Parameters”string
Object3D
animations?
Section titled “animations?”AnimationClip[]
Returns
Section titled “Returns”getModel()
Section titled “getModel()”getModel(
name):ModelData|undefined
Defined in: packages/threeplay/src/plugins/assets/types.ts:94
A loaded model, if any.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ModelData | undefined
getTexture()
Section titled “getTexture()”getTexture(
name):Texture<unknown,TextureEventMap> |undefined
Defined in: packages/threeplay/src/plugins/assets/types.ts:96
A loaded texture, if any.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Texture<unknown, TextureEventMap> | undefined
loadModel()
Section titled “loadModel()”loadModel(
name,url):Promise<ModelData>
Defined in: packages/threeplay/src/plugins/assets/types.ts:84
Loads a glTF/GLB model under a name.
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<ModelData>
loadRoot()
Section titled “loadRoot()”loadRoot(
path?):string
Defined in: packages/threeplay/src/plugins/assets/types.ts:82
Sets the prefix for relative asset URLs (loadRoot("assets/")) and
returns the current one. Absolute URLs (http:, /, data:, blob:)
are never prefixed.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
loadTexture()
Section titled “loadTexture()”loadTexture(
name,url):Promise<Texture<unknown,TextureEventMap>>
Defined in: packages/threeplay/src/plugins/assets/types.ts:86
Loads a texture under a name (sRGB, repeat wrapping).
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<Texture<unknown, TextureEventMap>>
model()
Section titled “model()”model(
name,opts?):ModelComp
Defined in: packages/threeplay/src/plugins/assets/types.ts:98
Component: an instance of a loaded model. Throws if the name is not loaded.
Parameters
Section titled “Parameters”string