xr-frame / Exports / EnvDataLoader

# Class: EnvDataLoader

环境数据资源EnvData的加载器。

拥有内置资源xr-frame-team-workspace-dayxr-frame-team-workspace-night以及xr-frame-team-workspace-day2。 加载的资源一般由xr-frame-cli生成。

# Hierarchy

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

new EnvDataLoader(_scene, type)

# Parameters

Name Type
_scene Scene
type string

# Inherited from

AssetLoader.constructor

# Properties

# schema

Readonly schema: ILoaderOptionsSchema = {}

Component.schema类似,指定解析Options的实际schema,对应于ILoadOptions

# Overrides

AssetLoader.schema

# Accessors

# scene

get scene(): Scene

当前资源所属场景的实例。

# Returns

Scene

# Methods

# cancel

cancel(params): void

取消加载特定资源。一般不需要自己编写逻辑,而是使用entity.canceled在加载终点丢弃。 注意entity.canceled是在这里赋值的,所以一般继承请务必先执行super.cancel()

# Parameters

Name Type
params IAssetLoadData<IEnvDataLoaderOptions>

# Returns

void

# Inherited from

AssetLoader.cancel


# getBuiltin

getBuiltin(): { assetId: string ; options: IEnvDataLoaderOptions ; src: string }[]

返回默认资源列表。 所有默认资源都是惰性加载的。

# Returns

{ assetId: string ; options: IEnvDataLoaderOptions ; src: string }[]

# Overrides

AssetLoader.getBuiltin


# load

load(params, callbacks): Promise<void>

加载一个资源,并根据情况执行callbacks中的回调。 理论上必须要实现!

# Parameters

Name Type
params IEnvDataLoadData
callbacks Object
callbacks.onError (error: Error) => void
callbacks.onLoaded (value: EnvData) => void
callbacks.onLoading (progress: number) => void

# Returns

Promise<void>

# Overrides

AssetLoader.load


# release

release(params, value): void

释放资源时将会调用,用于自定义释放逻辑。

# Parameters

Name Type
params IEnvDataLoadData
value EnvData

# Returns

void

# Overrides

AssetLoader.release