资源系统，负责整个场景的资源管理。
一般不需要手动管理，而是利用AssetLoad、registerGeometry之类的使用。
Hierarchy
-
↳
AssetsSystem
Table of contents
Constructors
Events
Properties
Accessors
Methods
Constructors
constructor
• new AssetsSystem()
Inherited from
Events
onAdd
▸ onAdd(parent, data): void
所挂载的element被挂载到场景时触发的回调。
Parameters
| Name | Type |
|---|---|
parent |
Element |
data |
IAssetsSystemData |
Returns
void
Inherited from
onRelease
▸ onRelease(data): void
从被挂载的element上被移除，或是element被销毁时，触发的回调。
一般用于释放持有的资源。
Parameters
| Name | Type |
|---|---|
data |
IAssetsSystemData |
Returns
void
Inherited from
onRemove
▸ onRemove(parent, data): void
所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。
一般用于消除功能的运作。
如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。
Parameters
| Name | Type |
|---|---|
parent |
Element |
data |
IAssetsSystemData |
Returns
void
Inherited from
onTick
▸ onTick(deltaTime, data): void
渲染每帧触发的回调。
Parameters
| Name | Type | Description |
|---|---|---|
deltaTime |
number |
单位为毫秒(ms)。 |
data |
IAssetsSystemData |
- |
Returns
void
Inherited from
onUpdate
▸ onUpdate(data, preData): void
数据更新时触发的回调。
Parameters
| Name | Type |
|---|---|
data |
IAssetsSystemData |
preData |
IAssetsSystemData |
Returns
void
Inherited from
Properties
priority
• Readonly priority: number = 10
自定义组件的更新优先级。
Overrides
schema
• Readonly schema: IComponentSchema = {}
自定义组件的schema。
Inherited from
EVENTS
▪ Static EVENTS: string[] = []
Inherited from
Accessors
el
• get el(): Element
挂载的元素。
Returns
scene
• get scene(): Scene
当前场景。
Returns
version
• get version(): number
当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。
Returns
number
Methods
addAsset
▸ addAsset<T>(type, id, asset): void
手动添加一个资源。
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
type |
string |
id |
string |
asset |
T |
Returns
void
cancelAsset
▸ cancelAsset(type, id): void
取消加载一个资源。
Parameters
| Name | Type |
|---|---|
type |
string |
id |
string |
Returns
void
getAsset
▸ getAsset<T>(type, id, fallback?): T
获取一个资源，如果尚未加载完成，也会返回undefined。
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
type |
string |
id |
string |
fallback? |
string |
Returns
T
getAssetWithState
▸ getAssetWithState<T>(type, id, fallback?): IAssetWithState<T>
获取一个资源以及加载状态。
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
type |
string |
id |
string |
fallback? |
string |
Returns
IAssetWithState<T>
getData
▸ getData<T>(key): IAssetsSystemData[T]
获取一个当前值。
Type parameters
| Name | Type |
|---|---|
T |
extends never |
Parameters
| Name | Type |
|---|---|
key |
T |
Returns
Inherited from
loadAsset
▸ loadAsset(params, parent?): Promise<IAssetWithState<any>>
手动加载一个资源。
Parameters
| Name | Type |
|---|---|
params |
IAssetLoadData<any> |
parent? |
Element |
Returns
Promise<IAssetWithState<any>>
releaseAsset
▸ releaseAsset(type, id): void
手动释放一个资源。
注意在xml里加载的资源不要手动释放。
Parameters
| Name | Type |
|---|---|
type |
string |
id |
string |
Returns
void
setData
▸ setData(data): void
不通过xml而是直接设置data，注意值的类型需要和schema中一致。
Parameters
| Name | Type |
|---|---|
data |
Partial<IAssetsSystemData> |
Returns
void
Inherited from
setDataOne
▸ setDataOne<T>(key, value): void
设置一个数据。
Type parameters
| Name | Type |
|---|---|
T |
extends never |
Parameters
| Name | Type |
|---|---|
key |
T |
value |
IAssetsSystemData[T] |
Returns
void