# Class: AssetsSystem

资源系统，负责整个场景的资源管理。

一般不需要手动管理，而是利用[AssetLoad](AssetLoad)、[registerGeometry](../modules#registerGeometry)之类的使用。

## Hierarchy

- [`Component`](Component)

  ↳ **`AssetsSystem`**

## Table of contents

### Constructors

- constructor

### Events

- onAdd
- onRelease
- onRemove
- onTick
- onUpdate

### Properties

- priority
- schema
- EVENTS

### Accessors

- el
- scene
- version

### Methods

- addAsset
- cancelAsset
- getAsset
- getAssetWithState
- getData
- loadAsset
- releaseAsset
- setData
- setDataOne

## Constructors

### constructor

• **new AssetsSystem**()

#### Inherited from

[Component](Component).[constructor](Component#constructor)

## Events

### onAdd

▸ **onAdd**(`parent`, `data`): `void`

所挂载的`element`被挂载到场景时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onAdd](Component#onAdd)

___

### onRelease

▸ **onRelease**(`data`): `void`

从被挂载的`element`上被移除，或是`element`被销毁时，触发的回调。
一般用于释放持有的资源。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRelease](Component#onRelease)

___

### onRemove

▸ **onRemove**(`parent`, `data`): `void`

所挂载的`element`从父节点`parent`被移除时，或者自己从`element`上被移除时，触发的回调。
一般用于消除功能的运作。
**如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。**

#### Parameters

| Name | Type |
| :------ | :------ |
| `parent` | [`Element`](Element) |
| `data` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onRemove](Component#onRemove)

___

### onTick

▸ **onTick**(`deltaTime`, `data`): `void`

渲染每帧触发的回调。

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `deltaTime` | `number` | 单位为毫秒(ms)。 |
| `data` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) | - |

#### Returns

`void`

#### Inherited from

[Component](Component).[onTick](Component#onTick)

___

### onUpdate

▸ **onUpdate**(`data`, `preData`): `void`

数据更新时触发的回调。

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) |
| `preData` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData) |

#### Returns

`void`

#### Inherited from

[Component](Component).[onUpdate](Component#onUpdate)

## Properties

### priority

• `Readonly` **priority**: `number` = `10`

自定义组件的更新优先级。

#### Overrides

[Component](Component).[priority](Component#priority)

___

### schema

• `Readonly` **schema**: [`IComponentSchema`](/miniprogram/dev/reference/xr-frame/api/interfaces/IComponentSchema) = `{}`

自定义组件的`schema`。

#### Inherited from

[Component](Component).[schema](Component#schema)

___

### EVENTS

▪ `Static` **EVENTS**: `string`[] = `[]`

#### Inherited from

[Component](Component).[EVENTS](Component#EVENTS)

## Accessors

### el

• `get` **el**(): [`Element`](Element)

挂载的元素。

#### Returns

[`Element`](Element)

___

### scene

• `get` **scene**(): [`Scene`](Scene)

当前场景。

#### Returns

[`Scene`](Scene)

___

### version

• `get` **version**(): `number`

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

#### Returns

`number`

## Methods

### addAsset

▸ **addAsset**(`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**(`type`, `id`, `fallback?`): `T`

获取一个资源，如果尚未加载完成，也会返回`undefined`。

#### Type parameters

| Name |
| :------ |
| `T` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `type` | `string` |
| `id` | `string` |
| `fallback?` | `string` |

#### Returns

`T`

___

### getAssetWithState

▸ **getAssetWithState**(`type`, `id`, `fallback?`): `IAssetWithState`

获取一个资源以及加载状态。

#### Type parameters

| Name |
| :------ |
| `T` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `type` | `string` |
| `id` | `string` |
| `fallback?` | `string` |

#### Returns

`IAssetWithState`

___

### getData

▸ **getData**(`key`): [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData)[`T`]

获取一个当前值。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends `never` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |

#### Returns

[`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData)[`T`]

#### Inherited from

[Component](Component).[getData](Component#getData)

___

### loadAsset

▸ **loadAsset**(`params`, `parent?`): `Promise`\>

手动加载一个资源。

#### Parameters

| Name | Type |
| :------ | :------ |
| `params` | `IAssetLoadData` |
| `parent?` | [`Element`](Element) |

#### Returns

`Promise`\>

___

### 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` |

#### Returns

`void`

#### Inherited from

[Component](Component).[setData](Component#setData)

___

### setDataOne

▸ **setDataOne**(`key`, `value`): `void`

设置一个数据。

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends `never` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `T` |
| `value` | [`IAssetsSystemData`](/miniprogram/dev/reference/xr-frame/api/interfaces/IAssetsSystemData)[`T`] |

#### Returns

`void`

#### Inherited from

[Component](Component).[setDataOne](Component#setDataOne)
