Class ResLoader

游戏资管理

Hierarchy

ResLoader

Index

Constructors

Methods

dump get load loadBundle loadByArgs loadByBundleAndArgs loadDir loadRemote parseLoadResArgs release releaseDir releasePrefabtDepsRecursively

Constructors

constructor

new ResLoader(): ResLoader
Returns ResLoader

Methods

dump

dump(): void
打印缓存中所有资源信息

Returns void
- Defined in assets/core/common/loader/ResLoader.ts:202

get

get<T>(path: string, type?: null | _cocos_core_asset_manager_shared__AssetType<T>, bundleName?: string): null | T
获取资源
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- path: string
  
  资源路径
- Optional type: null | _cocos_core_asset_manager_shared__AssetType<T>
  
  资源类型
- bundleName: string = "resources"
  
  远程资源包名
Returns null | T
- Defined in assets/core/common/loader/ResLoader.ts:196

load

load<T>(bundleName: string, paths: string | string[], type: null | AssetType<T>, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T>): void
加载一个资源

Example
```
oops.res.load("spine_path", sp.SkeletonData, (err: Error | null, sd: sp.SkeletonData) => {

});
```
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
  
  远程包名
- paths: string | string[]
  
  资源路径
- type: null | AssetType<T>
  
  资源类型
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
  
  加载进度回调
- onComplete: null | CompleteCallback<T>
  
  加载完成回调
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:86
load<T>(bundleName: string, paths: string | string[], onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- paths: string | string[]
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:87
load<T>(bundleName: string, paths: string | string[], onComplete?: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- paths: string | string[]
- Optional onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:88
load<T>(bundleName: string, paths: string | string[], type: null | AssetType<T>, onComplete?: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- paths: string | string[]
- type: null | AssetType<T>
- Optional onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:89
load<T>(paths: string | string[], type: null | AssetType<T>, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- paths: string | string[]
- type: null | AssetType<T>
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:90
load<T>(paths: string | string[], onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- paths: string | string[]
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:91
load<T>(paths: string | string[], onComplete?: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- paths: string | string[]
- Optional onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:92
load<T>(paths: string | string[], type: null | AssetType<T>, onComplete?: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- paths: string | string[]
- type: null | AssetType<T>
- Optional onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:93

loadBundle

loadBundle(url: string, v?: string): Promise<Bundle>

加载资源包

Example

var serverUrl = "http://192.168.1.8:8080/";         // 服务器地址
var md5 = "8e5c0";                                  // Cocos Creator 构建后的MD5字符
await oops.res.loadBundle(serverUrl,md5);

Parameters

url: string

资源地址
Optional v: string

资源MD5版本号

Returns Promise<Bundle>

`Private` loadByArgs

loadByArgs<T>(args: ILoadResArgs<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- args: ILoadResArgs<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:254

`Private` loadByBundleAndArgs

loadByBundleAndArgs<T>(bundle: Bundle, args: ILoadResArgs<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundle: Bundle
- args: ILoadResArgs<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:240

loadDir

loadDir<T>(bundleName: string, dir: string, type: null | AssetType<T>, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T[]>): void
加载文件夹中的资源

Example
```
// 加载进度事件
var onProgressCallback = (finished: number, total: number, item: any) => {
console.log("资源加载进度", finished, total);
}

// 加载完成事件
var onCompleteCallback = () => {
console.log("资源加载完成");
}
oops.res.loadDir("game", onProgressCallback, onCompleteCallback);
```
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
  
  远程包名
- dir: string
  
  文件夹名
- type: null | AssetType<T>
  
  资源类型
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
  
  加载进度回调
- onComplete: null | CompleteCallback<T[]>
  
  加载完成回调
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:131
loadDir<T>(bundleName: string, dir: string, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- dir: string
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:132
loadDir<T>(bundleName: string, dir: string, onComplete?: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- dir: string
- Optional onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:133
loadDir<T>(bundleName: string, dir: string, type: null | AssetType<T>, onComplete?: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- bundleName: string
- dir: string
- type: null | AssetType<T>
- Optional onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:134
loadDir<T>(dir: string, type: null | AssetType<T>, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- dir: string
- type: null | AssetType<T>
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:135
loadDir<T>(dir: string, onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback, onComplete: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- dir: string
- onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback
- onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:136
loadDir<T>(dir: string, onComplete?: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- dir: string
- Optional onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:137
loadDir<T>(dir: string, type: null | AssetType<T>, onComplete?: null | CompleteCallback<T[]>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- dir: string
- type: null | AssetType<T>
- Optional onComplete: null | CompleteCallback<T[]>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:138

loadRemote

loadRemote<T>(url: string, options: null | _cocos_core_asset_manager_shared__IRemoteOptions, onComplete?: null | CompleteCallback<T>): void

加载远程资源

Example

var opt: IRemoteOptions = { ext: ".png" };
var onComplete = (err: Error | null, data: ImageAsset) => {
const texture = new Texture2D();
texture.image = data;

const spriteFrame = new SpriteFrame();
spriteFrame.texture = texture;

var sprite = this.sprite.addComponent(Sprite);
sprite.spriteFrame = spriteFrame;
}
oops.res.loadRemote<ImageAsset>(this.url, opt, onComplete);

Type Parameters

T extends Asset<T>

Parameters

url: string

资源地址
options: null | _cocos_core_asset_manager_shared__IRemoteOptions

资源参数，例：{ ext: ".png" }
Optional onComplete: null | CompleteCallback<T>

加载完成回调

Returns void

loadRemote<T>(url: string, onComplete?: null | CompleteCallback<T>): void
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- url: string
- Optional onComplete: null | CompleteCallback<T>
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:39

`Private` parseLoadResArgs

parseLoadResArgs<T>(paths: string | string[], type?: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any> | AssetType<T>, onProgress?: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any> | AssetType<T>, onComplete?: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any>): { onComplete: any; onProgress: any; paths: any; type: any }
Type Parameters
Type Parameters
- T extends Asset<T>
Parameters
- paths: string | string[]
- Optional type: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any> | AssetType<T>
- Optional onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any> | AssetType<T>
- Optional onComplete: null | _cocos_core_asset_manager_shared__ProgressCallback | CompleteCallback<any>
Returns { onComplete: any; onProgress: any; paths: any; type: any }
- onComplete: any
- onProgress: any
- paths: any
- type: any
- Defined in assets/core/common/loader/ResLoader.ts:209

release

release(path: string, bundleName?: string): void
通过资源相对路径释放资源
Parameters
- path: string
  
  资源路径
- bundleName: string = "resources"
  
  远程资源包名
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:163

releaseDir

releaseDir(path: string, bundleName?: string): void
通过相对文件夹路径删除所有文件夹中资源
Parameters
- path: string
  
  资源文件夹路径
- bundleName: string = "resources"
  
  远程资源包名
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:178

`Private` releasePrefabtDepsRecursively

releasePrefabtDepsRecursively(uuid: string): void
释放预制依赖资源
Parameters
- uuid: string
Returns void
- Defined in assets/core/common/loader/ResLoader.ts:275

Class ResLoader

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns ResLoader

Methods

dump

Returns void

get

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

path: string

Optional type: null | _cocos_core_asset_manager_shared__AssetType<T>

bundleName: string = "resources"

Returns null | T

load

Example

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

bundleName: string

paths: string | string[]

type: null | AssetType<T>

onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback

onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

bundleName: string

paths: string | string[]

onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback

onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

bundleName: string

paths: string | string[]

Optional onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

bundleName: string

paths: string | string[]

type: null | AssetType<T>

Optional onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

paths: string | string[]

type: null | AssetType<T>

onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback

onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

paths: string | string[]

onProgress: null | _cocos_core_asset_manager_shared__ProgressCallback

onComplete: null | CompleteCallback<T>

Returns void

Type Parameters

Type Parameters

T extends Asset<T>

Parameters

paths: string | string[]

`Optional` type: null | _cocos_core_asset_manager_shared__AssetType<T>

`Optional` onComplete: null | CompleteCallback<T>

`Optional` onComplete: null | CompleteCallback<T>

`Optional` onComplete: null | CompleteCallback<T>

`Optional` onComplete: null | CompleteCallback<T>

`Optional` v: string

`Private` loadByArgs

`Private` loadByBundleAndArgs

`Optional` onComplete: null | CompleteCallback<T[]>

`Optional` onComplete: null | CompleteCallback<T[]>