Class ReadRS

可读资源系统

Hierarchy

ReadRS
- ReadWriteRS

Constructors

constructor

new ReadRS(fs?: ReadFS): ReadRS
构建可读资源系统
Parameters
- Optional fs: ReadFS
  
  可读文件系统
Returns ReadRS
- Defined in src/assets/rs/ReadRS.ts:63

Properties

`Private` _fs

`Protected` _idMap

_idMap: {
[id: string]: FileAsset;
} = {}

资源编号映射

Type declaration

[id: string]: FileAsset

`Protected` _pathMap

_pathMap: {
[path: string]: FileAsset;
} = {}

资源路径映射

Type declaration

[path: string]: FileAsset

`Private` _rootPath

_rootPath: string = 'Assets'

`Protected` resources

resources: string = 'resource.json'

资源树保存路径

`Static` rs

rs: ReadRS = ...

默认资源系统

Accessors

fs

get fs(): ReadFS
文件系统

Returns ReadFS
- Defined in src/assets/rs/ReadRS.ts:29

root

get root(): FolderAsset
根资源

Returns FolderAsset
- Defined in src/assets/rs/ReadRS.ts:41

rootPath

get rootPath(): string
根资源路径

Returns string
- Defined in src/assets/rs/ReadRS.ts:35

Methods

addAsset

addAsset(asset: FileAsset): void
新增资源
Parameters
- asset: FileAsset
  
  资源
Returns void
- Defined in src/assets/rs/ReadRS.ts:299

createAsset

createAsset<T>(Cls: (new () => T), fileName?: string, value?: gPartial<T>, parent?: FolderAsset): Promise<FileAsset>
新建资源
Type Parameters
- T extends FileAsset<T>
Parameters
- Cls: (new () => T)
  
  资源类定义
  - - new (): T
    - Returns T
- Optional fileName: string
  
  文件名称
- Optional value: gPartial<T>
  
  初始数据
- Optional parent: FolderAsset
  
  所在文件夹，如果值为null时默认添加到根文件夹中
Returns Promise<FileAsset>
- Defined in src/assets/rs/ReadRS.ts:107

deleteAsset0

deleteAsset0(asset: FileAsset): void
删除资源
Parameters
- asset: FileAsset
  
  资源
Returns void
- Defined in src/assets/rs/ReadRS.ts:356

deleteAssetById

deleteAssetById(id: string): void
删除指定编号的资源
Parameters
- id: string
  
  资源编号
Returns void
- Defined in src/assets/rs/ReadRS.ts:336

deleteAssetByPath

deleteAssetByPath(path: string): void
删除指定路径的资源
Parameters
- path: string
  
  资源路径
Returns void
- Defined in src/assets/rs/ReadRS.ts:346

deserializeWithAssets

deserializeWithAssets(object: any): Promise<any>
反序列化包含资源的对象
Parameters
- object: any
  
  反序列化的对象
Returns Promise<any>
- Defined in src/assets/rs/ReadRS.ts:388

getAllAssets

getAllAssets(): FileAsset[]
获取所有资源

Returns FileAsset[]
- Defined in src/assets/rs/ReadRS.ts:324

getAllIds

getAllIds(): string[]
获取所有资源编号列表

Returns string[]
- Defined in src/assets/rs/ReadRS.ts:308

getAllPaths

getAllPaths(): string[]
获取所有资源路径列表

Returns string[]
- Defined in src/assets/rs/ReadRS.ts:316

getAssetById

getAssetById(id: string): FileAsset
获取指定编号资源
Parameters
- id: string
  
  资源编号
Returns FileAsset
- Defined in src/assets/rs/ReadRS.ts:251

getAssetByPath

getAssetByPath(path: string): FileAsset
获取指定路径资源
Parameters
- path: string
  
  资源路径
Returns FileAsset
- Defined in src/assets/rs/ReadRS.ts:261

getAssetsByType

getAssetsByType<T>(type: Constructor<T>): T[]
获取指定类型资源
Type Parameters
- T extends FileAsset<T>
Parameters
- type: Constructor<T>
  
  资源类型
Returns T[]
- Defined in src/assets/rs/ReadRS.ts:227

getAssetsWithObject

getAssetsWithObject(object: any, assetids?: string[]): string[]
获取需要反序列化对象中的资源id列表
Parameters
- object: any
- assetids: string[] = []
Returns string[]
- Defined in src/assets/rs/ReadRS.ts:365

getChildrenAssetByPath

getChildrenAssetByPath(path: string): FileAsset[]
获取文件夹内子文件列表
Parameters
- path: string
  
  文件夹路径
Returns FileAsset[]
- Defined in src/assets/rs/ReadRS.ts:285

getChildrenPathsByPath

getChildrenPathsByPath(path: string): string[]
获取文件夹内子文件路径列表
Parameters
- path: string
  
  路径
Returns string[]
- Defined in src/assets/rs/ReadRS.ts:271

getLoadedAssetDatasByType

getLoadedAssetDatasByType<T>(type: Constructor<T>): T[]
获取指定类型资源数据
Type Parameters
- T
Parameters
- type: Constructor<T>
  
  资源类型
Returns T[]
- Defined in src/assets/rs/ReadRS.ts:239

getValidChildName

getValidChildName(parent: FolderAsset, fileName: string): string
获取有效子文件名称
Parameters
- parent: FolderAsset
  
  父文件夹
- fileName: string
  
  文件名称
Returns string
- Defined in src/assets/rs/ReadRS.ts:158

init

init(): Promise<void>
初始化

Returns Promise<void>
- Defined in src/assets/rs/ReadRS.ts:71

readAsset

readAsset(id: string): Promise<FileAsset>
读取文件为资源对象
Parameters
- id: string
  
  资源编号
Returns Promise<FileAsset>
- Defined in src/assets/rs/ReadRS.ts:176

readAssetData

readAssetData(id: string): Promise<any>
读取资源数据
Parameters
- id: string
  
  资源编号
Returns Promise<any>
- Defined in src/assets/rs/ReadRS.ts:196

readAssetDatas

readAssetDatas(assetids: string[]): Promise<AssetData[]>
读取资源数据列表
Parameters
- assetids: string[]
  
  资源编号列表
Returns Promise<AssetData[]>
- Defined in src/assets/rs/ReadRS.ts:215

Generated using TypeDoc