【Unity】【Addressables】ダウンロード時のエラーをハンドリングする

Unity の Addressable アセットシステムでダウンロード時のエラーをハンドリングする方法についてまとめました。

はじめに
ダウンロードエラーをハンドリングするスクリプト
エラー文字列一覧
参考

はじめに

比較的最近のマニュアルで、Addressables でダウンロードエラーをハンドリングする方法がまとめられていたので紹介します。

docs.unity3d.com

Addressable の基礎知識についてはこの記事では触れませんが、以下の記事などにまとめていますので必要に応じて参照してください。

light11.hatenadiary.com

ダウンロードエラーをハンドリングするスクリプト

Addressable におけるダウンロード時のエラーは以下のようなスクリプトによりハンドリングします。

using System.Threading.Tasks;
using UnityEngine;
using UnityEngine.AddressableAssets;
using UnityEngine.ResourceManagement.AsyncOperations;
using UnityEngine.ResourceManagement.Exceptions;

internal class HandleDownloadError : MonoBehaviour
{
    public async Task LoadAsset()
    {
        var handle = Addressables.LoadAssetAsync<GameObject>("foo");
        await handle.Task;

        var downloadError = GetDownloadError(handle);
        if (!string.IsNullOrEmpty(downloadError))
        {
            // 必要に応じてハンドリング
        }
    }

    /// <summary>
    /// ダウンロードエラーがの内容を返却する
    /// </summary>
    /// <param name="handle"></param>
    /// <returns>
    /// ダウンロードエラー内容を表す文字列（https://docs.unity.cn/Packages/com.unity.addressables@1.20/manual/LoadingAssetBundles.html）を返す。
    /// エラーが存在しない場合はnullを返却する。
    /// </returns>
    private static string GetDownloadError(AsyncOperationHandle handle)
    {
        if (handle.Status != AsyncOperationStatus.Failed)
            return null;

        // AsyncOperationHandle.OperationException か InnerException に
        // RemoteProviderException 型があった場合はダウンロードエラー
        var exception = handle.OperationException;
        while (exception != null)
        {
            if (exception is RemoteProviderException remoteException)
                return remoteException.WebRequestResult.Error;

            exception = exception.InnerException;
        }

        return null;
    }
}