# Class: Assets
资源加载组组件,会统计作为其子节点的AssetLoad组件的加载状态,派发事件。 一般被代理到XRAssets元素。
事件progress会在资源加载进度更新时触发,值为{progress: number, asset: IAssetLoadData}。
事件loaded会在所有资源加载完成是触发,值为{assets: {[key: string]: IAssetLoadData}, errors: {[key: string]: Error}}。
详见{@link IAssetLoadData}。
# Hierarchy
-
↳
Assets
# Table of contents
# Constructors
# Events
# Properties
# Accessors
# Methods
# Constructors
# constructor
• new Assets()
# Inherited from
# Events
# onAdd
▸ onAdd(parent, data): void
所挂载的element被挂载到场景时触发的回调。
# Parameters
| Name | Type |
|---|---|
parent | Element |
data | IAssetsData |
# Returns
void
# Inherited from
# onRelease
▸ onRelease(data): void
从被挂载的element上被移除,或是element被销毁时,触发的回调。
一般用于释放持有的资源。
# Parameters
| Name | Type |
|---|---|
data | IAssetsData |
# Returns
void
# Inherited from
# onRemove
▸ onRemove(parent, data): void
所挂载的element从父节点parent被移除时,或者自己从element上被移除时,触发的回调。
一般用于消除功能的运作。
如果一个组件的元素直接被销毁了,那这个组件就不会经历onRemove而是直接进入onRelease。
# Parameters
| Name | Type |
|---|---|
parent | Element |
data | IAssetsData |
# Returns
void
# Inherited from
# onTick
▸ onTick(deltaTime, data): void
渲染每帧触发的回调。
# Parameters
| Name | Type | Description |
|---|---|---|
deltaTime | number | 单位为毫秒(ms)。 |
data | IAssetsData | - |
# Returns
void
# Inherited from
# onUpdate
▸ onUpdate(data, preData): void
数据更新时触发的回调。
# Parameters
| Name | Type |
|---|---|
data | IAssetsData |
preData | IAssetsData |
# Returns
void
# Inherited from
# Properties
# priority
• Readonly priority: number
自定义组件的更新优先级。
# Inherited from
# schema
• Readonly schema: IComponentSchema
自定义组件的schema。
# Overrides
# EVENTS
▪ Static EVENTS: string[]
# Overrides
# Accessors
# el
• get el(): Element
挂载的元素。
# Returns
# scene
• get scene(): Scene
当前场景。
# Returns
# version
• get version(): number
当前版本,每次有数据更新都会增加,可以用作和其他组件合作的依据。
# Returns
number
# Methods
# getData
▸ getData<T>(key): IAssetsData[T]
获取一个当前值。
# Type parameters
| Name | Type |
|---|---|
T | extends never |
# Parameters
| Name | Type |
|---|---|
key | T |
# Returns
IAssetsData[T]
# Inherited from
# setData
▸ setData(data): void
不通过xml而是直接设置data,注意值的类型需要和schema中一致。
# Parameters
| Name | Type |
|---|---|
data | Partial<IAssetsData> |
# Returns
void
# Inherited from
# setDataOne
▸ setDataOne<T>(key, value): void
设置一个数据。
# Type parameters
| Name | Type |
|---|---|
T | extends never |
# Parameters
| Name | Type |
|---|---|
key | T |
value | IAssetsData[T] |
# Returns
void