Unity Addressable on Wenrong Nexus

Unity Addressable Load Assets

Wed, 04 May 2022 00:00:00 +0000

前言

介紹我使用 Addressable 的讀取、生成、釋放方式。

詳細設定還是可以先觀看官方文件。

Event Viewer

可以利用 Event Viewer 在 Editor Runtime 時，隨時監控記憶體使用情況。就可以很明顯的發現，那些東西是忘記釋放掉的，或者不需要釋放的。

Load Asset

IEnumerator InstantiateAsset(string asset)
{
    AsyncOperationHandle<GameObject> async = asset.LoadAssetAsync<GameObject>();
    yield return async;
    GameObject go = Instantiate(async.Result);
}

IEnumerator InstantiateAssets(string label)
{
    AsyncOperationHandle<IList<GameObject>> async = Addressables.LoadAssetsAsync<GameObject>(label, null);
    yield return async;
    for (int i = 0; i < async.Result.Count; i++)
        GameObject go = Instantiate(async.Result[i]);
}

IEnumerator InstantiateAsset(AssetReference asset)
{
    AsyncOperationHandle<GameObject> async = asset.LoadAssetAsync<GameObject>();
    yield return async;
    GameObject go = Instantiate(async.Result);
}

可以利用這三種方式讀取 Asset，並且把物件生成出來，當然我還是最推薦使用 AssetReference，除非有什麼特殊需求要使用字串，不然我不會換成其他方式。

Release Asset

釋放掉 Asset 也記得要把物件刪除，不然場上會遺留破圖的物件。

private void ReleaseAsset(AsyncOperationHandle<T> async)
{
    Addressables.Release(async);
}

private void ReleaseAsset(T asset)
{
    Addressables.Release(asset);
}

private void ReleaseAsset(AssetReference asset)
{
    asset.ReleaseAsset();
}

可以利用生成的物件或者 Load asset 的 Async 釋放，假如是使用 AssetReference Load Asset，也可以使用這個方式釋放。

Unity Addressable Download Assets

Mon, 14 Mar 2022 00:00:00 +0000

前言

在前一篇 Unity Addressable 介紹了簡易使用的方式，此篇是介紹下載 Asset 方法。

目前我個人使用過的方式有 Name、Label、AssetReference、Array AssetReference 的方式。

Addressables.LoadAssetAsync

官方範例提供的下載方式 Addressables.LoadAsset(s)Async，雖然這個是要把 Asset 讀取出來，其實他也有下載功能

    Addressables.LoadAssetAsync<GameObject>(asset);

我是很少使用這種方式下載或更新 Asset，主因是我個人認為 Addressables.LoadAssetAsync 是讀取物件而不是更新物件的功能，所以我在需要更新時不會使用它。

Update Addressable Name/ Addressable Label

IEnumerator UpdateAsset(string asset)
{
    var downloadAsync = Addressables.DownloadDependenciesAsync(asset, false);
    yield return downloadAsync;
    Addressables.Release(downloadAsync);
}

這個是下載 Addressable Name 或 Label的方法，可以利用 Label 下載多個不同 Group 的 Asset。

Addressable Name、Label 是無法利用 Hotfix 的方式產生，所以是要先創好需要的。若假如需要新的 Addressable Name、Label 是必須要重新輸出 App 才會更新。

Update Asset Reference

IEnumerator UpdateAsset(AssetReference asset)
{
    var downloadAsync = Addressables.DownloadDependenciesAsync(asset, false);
    yield return downloadAsync;
    Addressables.Release(downloadAsync);
}

AssetReference 的用法是我最推薦的下載方式，可以很明顯的知道更新物件，不會因為打錯文字導致更新失敗，而且也可以利用這個方式組合物件，讓更新的內容比較簡單方式處理。

例如用一個物件或場景夾帶了多個不同的需要更新的物件，缺點就是這包 pack 輸出會過大，可能需要把每個物件獨立分成多個 AssetReference，利用系統特性夾帶物件變小。不過要是不喜歡這種方式可以看 Update Multiple Asset References。

不過 AssetReference 最方便還是使用它來生成、釋放、等等，才是最好用的方式。

Update Multiple Asset References

IEnumerator DonwloadMultipleAssets(AssetReference[] assets)
{
    var assetKeys = assets.Cast<AssetReference>();
    var downloadAsync = Addressables.DownloadDependenciesAsync(assetKeys, Addressables.MergeMode.Union);
    yield return downloadAsync;
    Addressables.Release(downloadAsync);
}

多個 AssetReference 更新的方式，然後可以一起更新。可以完成一個簡單的多個物件更新，不用利用 Label、整合包、等方式更新。

取得下載容量大小方法

IEnumerator CheckSizeAsync(string asset)
{
    var async = Addressables.GetDownloadSizeAsync(asset);
    yield return async;
    if (async.Status == AsyncOperationStatus.Succeeded)
    {
        float size = Mathf.Round((float)async.Result / 1024 / 1024 * 1000) / 1000;
        Debug.Log($"Total {size} MB");
    }
    Addressables.Release(async);
}

更新進度條寫法

IEnumerator UpdateAsset(AssetReference asset)
{
    var downloadAsync = Addressables.DownloadDependenciesAsync(asset, false);
    while (!downloadAsync.IsDone)
    {
        float percent = downloadAsync.PercentComplete;
        Debug.Log($"{asset}: {downloadAsync.PercentComplete * 100} %");
        yield return new WaitForEndOfFrame();
    }
    Addressables.Release(downloadAsync);
}

Unity Addressable

Thu, 27 May 2021 00:00:00 +0000

前言

主要是實作 Addressable hotfix 的寫法。

基本 Unity-Addressable 安裝及 Remote 設定可以參考這篇 Unity 筆記 Addressable Asset System。

詳細解說可以參考

Unity Addressables 深入浅出(一)、(二)、(三)

Unity Addressable 獨立資源包

實例

Initialization

Initial Addressable System 是必要的假如不初始化會造成一些使用上的問題。

在 Start 上可直接初始化 Addressable System

IEnumerator Start()
{
    var InitAddressablesAsync = Addressables.InitializeAsync();
    yield return InitAddressablesAsync;
}

Update Catalog

Catalog 是所有檔案的紀錄檔(log)，不更新 Catalog 也是能下載 Asset，可是會造成無法 hotfix，所以需要再下載前更一次 Catalog。

Catalog Path

依 Window 為例，Catalog 更新後會放自動放置在

C:\Users\[PC Name]\AppData\LocalLow\[Company Name]\[Product Name]\com.unity.addressables

名稱	解釋
[PC Name]	系統使用者名稱
[Company Name]	Unity 專案 Company Name
[Product Name]	Unity 專案 Product Name

IEnumerator UpdateCatalogCoro()
{
    List<string> catalogsToUpdate = new List<string>();
    var checkCatalogHandle = Addressables.CheckForCatalogUpdates(false);
    yield return checkCatalogHandle;

    if (checkCatalogHandle.Status == AsyncOperationStatus.Succeeded)
        catalogsToUpdate = checkCatalogHandle.Result;

    if (catalogsToUpdate.Count > 0)
    {
        var updateCatalogHandle = Addressables.UpdateCatalogs(catalogsToUpdate, false);
        yield return updateCatalogHandle;
    }
}

Update Asset

下載好的 Asset，在測試時不清除是會造成無法測試下載流程，可是可以手動清除下載 Asset。

Asset Path

依 Window 為例，下載好的 Asset 更新後會放自動放置在

C:\Users\[PC Name]\AppData\LocalLow\Unity\[Company Name]_[Product Name]

名稱	解釋
[PC Name]	系統使用者名稱
[Company Name]	Unity 專案 Company Name
[Product Name]	Unity 專案 Product Name

Update All Asset

這個方式是使用 AA 系統紀錄 Catalog 取得出來的位置（Locator），在使用 GetDownloadSizeAsync 來確認檔案有無更新，來達成更新所有檔案。

IEnumerator UpdateAllGroupsCoro()
{
    foreach (var loc in Addressables.ResourceLocators)
    {
        foreach (var key in loc.Keys)
        {
            var sizeAsync = Addressables.GetDownloadSizeAsync(key);
            yield return sizeAsync;
            long totalDownloadSize = sizeAsync.Result;

            if (sizeAsync.Result > 0)
            {
                var downloadAsync = Addressables.DownloadDependenciesAsync(key);
                while (!downloadAsync.IsDone)
                {
                    float percent = downloadAsync.PercentComplete;
                    Debug.Log($"{key} = percent {(int)(totalDownloadSize * percent)}/{totalDownloadSize}");
                    yield return new WaitForEndOfFrame();
                }
                Addressables.Release(downloadAsync);
            }
            Addressables.Release(sizeAsync);
        }
    }
}

Update label Asset

這個方式是使用 Label 下載特定資源。

IEnumerator UpdateLabelAsset(string label)
{
    long updateLabelSize = 0;
    var async = Addressables.GetDownloadSizeAsync(label);
    yield return async;
    if (async.Status == AsyncOperationStatus.Succeeded)
        updateLabelSize = async.Result;
    Addressables.Release(async);
    if (updateLabelSize == 0)
    {
        Debug.Log($"{label} last version");
        yield break;
    }
    yield return DownloadLabelAsset(label);
}

IEnumerator DownloadLabelAsset(string label)
{
    var downloadAsync = Addressables.DownloadDependenciesAsync(label, false);

    while (!downloadAsync.IsDone)
    {
        float percent = downloadAsync.PercentComplete;
        Debug.Log($"{label}: {downloadAsync.PercentComplete * 100} %");
        yield return new WaitForEndOfFrame();
    }
    Addressables.Release(downloadAsync);

    Debug.Log($"{label} UpdateAssets finish");
}

Clear Asset

刪除 Asset Path 路徑下載的檔案。

Clear All Asset

Caching.ClearCache() 是能夠完整的清除下載的所有檔案，但是不能單獨使用，還要搭配 Addressables.ClearDependencyCacheAsync 才能清除 Catalog 紀錄的下載資訊。

IEnumerator ClearAllAssetCoro()
{
    foreach (var locats in Addressables.ResourceLocators)
    {
        var async = Addressables.ClearDependencyCacheAsync(locats.Keys, false);
        yield return async;
        Addressables.Release(async);
    }
    Caching.ClearCache();
}

Clear Label Asset

IEnumerator ClearAssetCoro(string label)
{
    var async = Addressables.LoadResourceLocationsAsync(label);
    yield return async;
    var locats = async.Result;
    foreach (var locat in locats)
        Addressables.ClearDependencyCacheAsync(locat.PrimaryKey);
}

Github

小結

write something cool…