YooAsset/Docs/CodeTutorial3.md

175 lines
4.5 KiB
Markdown
Raw Normal View History

2022-03-03 18:08:32 +08:00
# 资源加载
2022-06-28 17:18:43 +08:00
**加载方法**
2022-03-03 18:08:32 +08:00
2023-03-30 17:41:42 +08:00
- LoadSceneAsync() 异步加载场景
2022-10-22 10:51:14 +08:00
- LoadAssetSync() 同步加载资源对象
- LoadAssetAsync() 异步加载资源对象
- LoadSubAssetsSync() 同步加载子资源对象
- LoadSubAssetsAsync() 异步加载子资源对象
2023-02-23 12:15:41 +08:00
- LoadRawFileSync() 同步获取原生文件
2022-11-21 09:52:18 +08:00
- LoadRawFileAsync() 异步获取原生文件
2022-03-03 18:08:32 +08:00
2022-06-25 11:41:13 +08:00
**统一约定**
2022-06-28 17:18:43 +08:00
**Location**为资源的定位地址,也是加载资源对象的唯一标识符。
2022-06-25 11:41:13 +08:00
2022-10-22 10:51:14 +08:00
- 在未开启可寻址模式下location代表的是资源对象的完整路径。
2022-06-25 11:41:13 +08:00
2022-06-28 17:18:43 +08:00
```c#
// 以工程内的音频文件为例:"Assets/GameRes/Audio/bgMusic.mp3"
2022-10-22 10:51:14 +08:00
package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic");
2022-06-28 17:18:43 +08:00
```
2022-04-14 12:38:20 +08:00
2022-10-22 10:51:14 +08:00
- 在开启可寻址模式下location代表的是资源对象可寻址地址。
2022-05-04 00:12:06 +08:00
2022-06-28 17:18:43 +08:00
````c#
// 以工程内的音频文件为例:"Assets/GameRes/Audio/bgMusic.mp3"
// 需要在资源配置界面启用可寻址功能Enable Addressable
// 配置界面的可寻址规则为AddressByFileName那么资源定位地址填写文件名称"bgMusic"
2022-10-22 10:51:14 +08:00
package.LoadAssetAsync<AudioClip>("bgMusic");
2022-06-28 17:18:43 +08:00
````
2022-05-04 00:12:06 +08:00
2022-03-03 18:08:32 +08:00
**加载路径的匹配方式**
````C#
// 不带扩展名的模糊匹配
2022-10-22 10:51:14 +08:00
package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic");
2022-03-03 18:08:32 +08:00
// 带扩展名的精准匹配
2022-10-22 10:51:14 +08:00
package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic.mp3");
2022-03-03 18:08:32 +08:00
````
**异步加载范例**
````C#
// 委托加载方式
void Start()
{
2022-10-22 10:51:14 +08:00
AssetOperationHandle handle = package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic.mp3");
2022-03-03 19:13:07 +08:00
handle.Completed += Handle_Completed;
2022-03-03 18:08:32 +08:00
}
void Handle_Completed(AssetOperationHandle handle)
{
2022-03-03 19:13:07 +08:00
AudioClip audioClip = handle.AssetObject as AudioClip;
2022-03-03 18:08:32 +08:00
}
````
````C#
// 协程加载方式
2022-03-24 21:34:34 +08:00
IEnumerator Start()
2022-03-03 18:08:32 +08:00
{
2022-10-22 10:51:14 +08:00
AssetOperationHandle handle = package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic.mp3");
2022-03-03 19:13:07 +08:00
yield return handle;
AudioClip audioClip = handle.AssetObject as AudioClip;
2022-03-03 18:08:32 +08:00
}
````
````C#
// Task加载方式
async void Start()
{
2022-10-22 10:51:14 +08:00
AssetOperationHandle handle = package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic.mp3");
2022-03-03 19:13:07 +08:00
await handle.Task;
AudioClip audioClip = handle.AssetObject as AudioClip;
2022-03-03 18:08:32 +08:00
}
````
**资源卸载范例**
````C#
2022-03-23 14:58:24 +08:00
IEnumerator Start()
2022-03-03 18:08:32 +08:00
{
2022-10-22 10:51:14 +08:00
AssetOperationHandle handle = package.LoadAssetAsync<AudioClip>("Assets/GameRes/Audio/bgMusic.mp3");
2022-03-23 14:58:24 +08:00
yield return handle;
2022-03-03 19:13:07 +08:00
...
handle.Release();
2022-03-03 18:08:32 +08:00
}
````
2022-04-28 19:25:14 +08:00
**资源释放范例**
2022-05-04 00:12:06 +08:00
可以在切换场景之后调用资源释放方法或者写定时器间隔时间去释放。
注意:只有调用资源释放方法,资源对象才会在内存里被移除。
2022-04-28 19:25:14 +08:00
````c#
private void UnloadAssets()
{
2022-10-18 19:27:47 +08:00
var package = YooAssets.GetAssetsPackage("DefaultPackage");
package.UnloadUnusedAssets();
2022-04-28 19:25:14 +08:00
}
````
2022-03-23 14:58:24 +08:00
**预制体加载范例**
2022-03-03 18:08:32 +08:00
````C#
2022-03-23 14:58:24 +08:00
IEnumerator Start()
{
2022-10-22 10:51:14 +08:00
AssetOperationHandle handle = package.LoadAssetAsync<GameObject>("Assets/GameRes/Panel/login.prefab");
2022-03-23 14:58:24 +08:00
yield return handle;
GameObject go = handle.InstantiateSync();
Debug.Log($"Prefab name is {go.name}");
}
2022-03-03 18:08:32 +08:00
````
2022-03-23 14:58:24 +08:00
**子对象加载范例**
2022-03-03 18:08:32 +08:00
例如通过TexturePacker创建的图集如果需要访问图集的精灵对象可以通过子对象加载接口。
````c#
2022-03-23 14:58:24 +08:00
IEnumerator Start()
2022-03-03 18:08:32 +08:00
{
2022-10-22 10:51:14 +08:00
SubAssetsOperationHandle handle = package.LoadSubAssetsAsync<Sprite>(location);
2022-03-23 14:58:24 +08:00
yield return handle;
var sprite = handle.GetSubAssetObject<Sprite>("spriteName");
Debug.Log($"Sprite name is {sprite.name}");
2022-03-03 18:08:32 +08:00
}
````
**场景异步加载范例**
2022-04-28 19:25:14 +08:00
注意:当加载新的主场景的时候,会自动释放之前加载的主场景以及附加场景。
2022-03-03 18:08:32 +08:00
````c#
2022-03-23 14:58:24 +08:00
IEnumerator Start()
2022-03-03 18:08:32 +08:00
{
2022-10-22 10:51:14 +08:00
string location = "Assets/GameRes/Scene/Login";
2022-03-21 23:49:50 +08:00
var sceneMode = UnityEngine.SceneManagement.LoadSceneMode.Single;
bool activateOnLoad = true;
2022-10-22 10:51:14 +08:00
SceneOperationHandle handle = package.LoadSceneAsync(location, sceneMode, activateOnLoad);
2022-03-23 14:58:24 +08:00
yield return handle;
Debug.Log($"Scene name is {handle.Scene.name}");
2022-03-03 18:08:32 +08:00
}
````
2022-03-10 16:55:12 +08:00
**原生文件加载范例**
例如wwise的初始化文件
````c#
2022-03-23 14:58:24 +08:00
IEnumerator Start()
2022-03-10 16:55:12 +08:00
{
2022-10-22 10:51:14 +08:00
string location = "Assets/GameRes/wwise/init.bnk";
2022-11-21 09:52:18 +08:00
RawFileOperationHandle handle = package.LoadRawFileAsync(location);
yield return handle;
byte[] fileData = handle.GetRawFileData();
string fileText = handle.GetRawFileText();
2023-02-23 12:15:41 +08:00
string filePath = handle.GetRawFilePath();
2022-03-10 16:55:12 +08:00
}
````
2022-05-12 12:37:48 +08:00
**获取资源信息列表**
通过资源标签来获取资源信息列表。
````c#
2023-02-23 12:15:41 +08:00
void GetAssetInfosByTag(string tag)
2022-05-12 12:37:48 +08:00
{
2022-10-22 10:51:14 +08:00
AssetInfo[] assetInfos = package.GetAssetInfos(tag);
2022-05-12 12:37:48 +08:00
foreach (var assetInfo in assetInfos)
{
Debug.Log(assetInfo.AssetPath);
}
}
````