xr-frame / Exports / AssetLoader
# Class: AssetLoader<T, ILoadOptions>
资源加载器的基类,配合AssetsSystem使用。 在基础库版本v2.29.2以上导出。
# Type parameters
| Name | Description |
|---|---|
T | 加载资源的类型。 |
ILoadOptions | 可接受额外配置的类型。 |
# Hierarchy
AssetLoader
# Table of contents
# Constructors
# Properties
# Accessors
# Methods
# Constructors
# constructor
• new AssetLoader<T, ILoadOptions>(_scene, type)
# Type parameters
| Name |
|---|
T |
ILoadOptions |
# Parameters
| Name | Type |
|---|---|
_scene | Scene |
type | string |
# Properties
# schema
• Readonly schema: ILoaderOptionsSchema = {}
和Component.schema类似,指定解析Options的实际schema,对应于ILoadOptions。
# Accessors
# scene
• get scene(): Scene
当前资源所属场景的实例。
# Returns
# Methods
# cancel
▸ cancel(params): void
取消加载特定资源。一般不需要自己编写逻辑,而是使用entity.canceled在加载终点丢弃。
注意entity.canceled是在这里赋值的,所以一般继承请务必先执行super.cancel()!
# Parameters
| Name | Type |
|---|---|
params | IAssetLoadData<ILoadOptions> |
# Returns
void
# getBuiltin
▸ getBuiltin(): { assetId: string ; options: ILoadOptions ; src: string }[]
返回默认资源列表。 所有默认资源都是惰性加载的。
# Returns
{ assetId: string ; options: ILoadOptions ; src: string }[]
# load
▸ load(data, callbacks): void
加载一个资源,并根据情况执行callbacks中的回调。
理论上必须要实现!
# Parameters
| Name | Type | Description |
|---|---|---|
data | IAssetLoadData<ILoadOptions> | - |
callbacks | Object | 开发者需要在加载进度更新时执行onLoading,在加载完成时执行onLoaded,在加载出错是执行onError |
callbacks.onError | (error: Error) => void | - |
callbacks.onLoaded | (result: T, localPath?: string) => void | - |
callbacks.onLoading | (progress: number) => void | - |
# Returns
void
# release
▸ release(params, value): void
释放资源时将会调用,用于自定义释放逻辑。
# Parameters
| Name | Type |
|---|---|
params | IAssetLoadData<ILoadOptions> |
value | T |
# Returns
void