【Unity】AddressableAssetSystemのAssetReferenceで、一覧表示するアセットを任意の型に制限したい

AddressableでのAssetReferenceで、任意のアセットを指定する方法についてです。

参照するアセットを絞り込んでおきたい

Addressableでアセットの遅延ロードを行いたい時、AssetReferenceでアセットを指定するというアイディアがあります。ただし、この時に登録しているアセットの数が膨大だと非常に面倒な事になります。

特にキャラクター名等、非常によく使うアドレスはテクスチャやオーディオ、その他諸々で複数登録されている事もありえるので、これを一覧から正しく選択しろというのはヒューマンエラーの元です。

登録してる中から一つを探し出すのは面倒くさい

これに対応する理にかなったAPIとして [AssetReferenceTypeRestriction( type )]というAttributeがありましたが、何故かコレをver 0.6.6で廃止してくださいやがりましたので、他のアプローチを紹介します。

AssetReferenceTを使用する

解決法としては、AssetReferenceT<T>を継承したクラスを定義します。ジェネリックを使用したクラスはシリアライズ出来ないので、一々AssetReferenceT<T>を継承したクラスを定義する必要があります。

例えば下のような、ゲーム内でHPパラメーターを共有するScriptableObject：GameDataクラスがあったとして…

[CreateAssetMenu]
public class GameData : ScriptableObject
{
    [SerializeField] private int originalHP;
    public int HP { get; set; }

    private void OnEnable() => HP = originalHP; // 起動時にHPを初期化
    public bool IsDead() => HP < 0; // HPが0以下だったら死亡判定
    public void Damage(int value) => HP -= value; // ダメージを受けたらHPを減らす
}

GameDataインスタンスはアセットとして複数のPrefabやSceneで共有可能にしてある状態

GameDataのみを使用可能なAssetReferenceTを用意します。

[System.Serializable] // Serializable属性が必ず必要
public class AssetReferenceGameData : AssetReferenceT<GameData> { }

あとは AssetReferenceの代わりにAssetReferenceGameData をAddressableの呼び出し元コードに設定します。

指定したアセットしか表示されない

public class PlayerSpawn : MonoBehaviour
{
    // AssetReferenceではなくAssetReferenceGameData
    [SerializeField] AssetReferenceGameData gameData; 

    private void Awake()
    {
        enabled = false;
        gameData.LoadAsset().Completed += (data) =>  enabled = true;
    }

    private void OnDestroy()
    {
        gameData.ReleaseAsset();
    }

    private void Update()
    {
        // 取得済みのアセットを使用するが、こちらはキャストが必要
        ((GameData)gameData.Asset).Damage(1); 
    }
}

補足

ちなみにAssetReferenceTで指定出来る型は、UnityEngine.Objectのみみたいです。正確にはUnityEngine.Objectのアセットのみっぽく、Componentは指定出来ませんでした。ここにInterfaceが指定出来れば、色々な面で非常に楽になるんですが… ふっきゅんきゅんきゅん！

ついでにAssetReferenceLabelRestriction属性も廃止になり、ラベルを取得するAssetReferenceUILabelRestrictionクラスになりました。こちらは悪くないです。

【Unity】AddressableAssetSystemで「PackedPlayMode」と「FastもしくはVirtual Mode」で挙動が違う場合

Addressable Asset Systemで、とりあえず Fast / Virtual Mode ではちゃんと動くのに Packed Play Mode では上手く動かないという場合の、経験則的な対策についてです。

Packed Play Mode と Virtual mode / Fast Modeの違い

Packed Play Mode と Virtual Mode や Fast Mode、この2つは非常に大きく異なります。

用途としてVirtualとFastはコンテンツの開発にフォーカスされており、動作の確認と修正を速やかに繰り返しやすい設計になっています。 VirtualはFastの高速性に加えて、コンテンツのロード・アンロードの動きを追跡しやすい設定です。アセットやAssetBundle開放のタイミングを把握することでメモリ管理に役立てようという発想です。FastやVirtualはAssetDatabaseから直接取得するタイプのロードを採用しており、AssetBundleをビルドし展開して使用する Packed とはロード方式が異なります。

一方、Packedは実際の動作と完全に同じ動きを行うことが期待されており、エディターでと言うよりは、実機での動作を確認することを期待するものです。実機で発生した不具合をエディターでも確認出来たら良いな程度に考えるのが良さそうです。

この２つ、ロード方式の違いから、Fast/VirtaulをPackedに上げると予想外の動きを起こす事があります。正確には 正しくない設定でも何となく動いてしまっていたものが、設定をちゃんとしないと動かなくなる なのですが、サクッと試すと結構混乱するので色々とメモします。

まぁ、Addressableさんのエラーメッセージが不親切の上に追いにくいというのもあるんですが…

ゲームの再生が出来ない

Packedに変更すると、ゲームの再生が出来なくなります。これはコンテンツ（AssetBundle）を作成していないためです。下のエラーメッセージを解決してやればビルドが可能になります。

Player content must be built before entering play mode with packed data. This can be done from the Addressable Assets window in the Build->Build Player Content menu command.

要するにBuild > Build Player Contentを押せば良いです。

これはBuild for content updateでコンテンツの更新を生成した場合も同様になります。

コンテンツや設定の更新が反映されない

コンテンツや設定の更新が反映されるのは、Build Player Contentでビルドした後からです。これは Addressable Asset Settings等での設定も含まれます つまり、RemoteLoad等の参照先を切り替えた場合、Build Player Contentの更新が必要です。

Catalog等の設定については案外StreamingAssets/aa/settings.jsonを書き換えれば良いかもしれませんが、グループやプロバイダーについては再ビルドが必要です。

まぁ再ビルドといってもキャッシュが結構効くので、ファイル数が膨大でなければ（それこそ１Asset１AssetBundleとかしてなければ）割とサクっと終わる印象です。

UnknownResourceProviderException や Unable to read header from archive file:が出る

これはBuild Asset Group Schemaのプロバイダーの設定が間違っています。

このプロバイダーの設定は、現状１択で、異なる値を設定するとエラーが出ます。将来的にAddressableがAssetBundle以外のバイナリフォーマットに対応すれば話は代わりますが、現状のBuild ScriptはPack Mode１択なので、この２つが変化することはありません。

Unable to read header from archive file:が出た場合はBundled Asset Provider Type（AssetBundleをどうやってロードするか）が間違っています。Bundled Asset Providerを設定します。

UnknownResourceProviderExceptionが出た場合はAssetBundle Provider Type（どうやってAssetBundleの中身を取得するか）が間違っています。Asset Bundle Providerを設定します。

なお変更が反映されるのは上に書いたとおり、Content Build Playerでビルドした後です。

Exception thrown in DynamicInvokeが出る

RemoteLoadPathを使用している状態で、ホスティングサービスやURL等を特に指定してない時に起こります。

Exception thrown in DynamicInvoke: System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.UriFormatException: Invalid URI: Invalid port specified.

ホスティングサービスを設定するなり、任意のサーバー上にファイルを設定すれば使えるようになります。

Schemaで確認したとき、RemoteLoadPathのアドレスがちゃんとなっていればOKです。

Exception: RemoteAssetBundleProvider

RemoteLoadPathを使用している状態で、ホスティングサービスが動作していない、もしくはアクセス出来ない（アドレスが間違ってる等）の状態です。

特にホスティングサービスを使用した時、初期設定はRemoteLoadPathの設定が明確に間違っているので、ちゃんと設定してやる必要があります。例えば http://[PrivateIpAddress_3]:[HostingServicePort]等。　少なくともLoadPathには[BuildTarget]は使用しません。

tsubakit1.hateblo.jp

404が出る

Hosting Serviceがちゃんと起動してないです。ホスティングサービスをUnityエディター起動後に初めて起動した時に出ます。

ホスティングサービスを再起動します。ポートが塞がってる訳でもないんですが、何ででしょう

複数のPrefabでScriptableObjectを共有してるとき、ScriptableObjectの変更しても反映されない

ScriptableObject等で値を共有している場合、共有用のScriptableObjectをAddressableに登録しないと、オブジェクトがPrefab毎に複製されて値が共有出来ないという事があります。例えばアドベンチャーサンプルゲームではシーン間の設定をSOで管理しているので起こります。

SO経由のデータ共有（いっそSO自体をマネージャーにする）はSingletonを使わず全体で動作にアクセス出来て楽で良いのですが、こういった事もあります。

tsubakit1.hateblo.jp

これはScriptableObjectにアドレスを割り振り、複数のAssetBundleで共通のインスタンスを使わせれば良いです。Analyzeでも検出されました。

またResourcesとAddressableでScriptableObjectの共有は出来ません（どちらかがインスタンスの参照ではなく明示的な設定が必要になります）

複数のSceneでScriptableObjectを共有してるとき、ScriptableObjectを変更しても反映されない

上の設定に追加で、Sceneで使用する場合に注意が必要なのが、ゲーム開始時に開いているSceneが参照するリソースはAssetDatabaseから取得しているという点です。

これは基本的にAddressableに登録しているシーンは一旦Addressableシーンから起動してもらう事で回避が可能です。Packedは動作確認用なので、最初から確認してくださいということで。

感想

URLなど最初から明確に間違ってるのがありますが、ちゃんと設定すれば割とちゃんと動きます。逆に、ちゃんと設定してない箇所があると、ちゃんと動いてくれないです。

今回は基本的にPlaymodeがFastやVirtual Modeのときにちゃんと動くことが前提です。動かない場合は、多分アドレスが間違っているとかです。

関連

誰もAddressableについて語らないなら、自分が語るしかない…ッッッッ from Tatsuhiko Yamamura

www.slideshare.net

後半に出てきたScriptableObjectによるデータ共有。テストとかやりやすい

tsubakit1.hateblo.jp

【Unity】AddressableAssetSystemでSpriteAtlasを使用する

Addressableを使用した場合も、SpriteAtlasの利用手順はそれ程代わりません。

AddressableでSpriteAtlasを使用したスプライトを利用する

Addressableは所属するグループやAssetBundleをそれ程意識しなくても利用できるシステムです。ただし暗黙的な参照によるアセットの重複はやはり存在するので、特に何も気にせずアセットを利用すると、アセットが重複する事があります。

例えば下の様に複数のAssetBundleから一つのSpriteAtlasにパックしたアセットへアクセスする場合、複数のAssetBundleにパックしたテクスチャが格納することになり、メモリ効率・データサイズ・描画性能的にペナルティがあります。

実際、AssetBundleの中身を確認してみると、各AnimationClipの他にパックされたテクスチャ、そして全てのSpriteが含まれてしまっていることが確認出来ます。

対策

Analyzeを使う

Addressableは有り難い事に、重複するアセット*1を個別のAssetBundleへ退避する機能があります。コレを使用すると、スプライトの重複を回避してくれます。

1. Analyzeボタンを押す
2. Run Testsボタンを押す
   重複するアセット一覧が表示される。
3. Fix Allボタンを押す
   新しいグループが出力される

あとはBuild Content Playerを実行すると、SpriteAtlasの重複部が一つのAssetBundleに格納され、他のAssetBundleからSpriteやパックしたAssetBundleの情報が剥がされます。

また各pngファイルを指定しているのでパック前のTextureも含まれる事を懸念していましたが、以前に確認したとおり現状でも問題なくパックしたテクスチャのみが含まれました。

手動でスプライトを配置を使う場合…

一応補足しておくと、Analyze経由でスプライトを配置しなくても「SpriteAtlasに含めたスプライトを全て同じグループ（同じAssetBundle）に所属する」だけでOKです。これはAddressableにフォルダを突っ込む（フォルダ以下のアセットを全登録する）という形でも達成出来ます。

なんか上手くSpriteAtlasが更新されない場合…

SpriteAtlas内のSprite群を足したり引いたり色々していると、Addressableでビルドした時にSpriteAtlasが更新されていないという現象を見かけました。これはAddressableの Build > Clean を実行すれば回避出来ました。

感想

割と素直に使えました。

Analyzeが無かった時は割とどうしようか感はありましたが、Analyzeでルールに従って重複を排除してくれるのは楽でいいです。このルールは現状一つですが、今後自作で追加したり色々出来るそうなので、そうすると割と良いんじゃないかなと。

関連

今回主に使用した機能

tsubakit1.hateblo.jp

問題の本質

tsubakit1.hateblo.jp

一応、今回のケースでもInclude in buildを外すアプローチは使えます。無駄なデータと余計な処理が追加されるのも同様です。

tsubakit1.hateblo.jp

*1:正確には少し異なるルールのように見えます。単純に重複したというより、大本が重複している物のみを選んで抽出しているように見えます

【Unity】AssetBundleに実際に含まれるアセット一覧を確認する

AssetBundleに含めたアセットやシリアライズしたデータ一覧を確認出来る機能を作ってみました。

AssetBundleに自動で含まれるアセット

AssetBundleは、AssetBundle NameやAddressを設定したアセットが参照するアセット…例えばキャラクターにおけるAnimationやMaterialにおけるTexturerを自動的に含みます。これにより開発者側はPrefabを展開する上で必要なアセット群を全て把握する必要なく、Prefabが使えます。

ただし、意図通りではないアセットも含まれる可能性があり、それがAssetBundleの利用面で色々と問題を起こしやすい部分でもあります。

AssetBundle.LoadAsset(...) や Manifest に記載されているアセットは、コンテナとして登録されているアセットで、こういった暗黙的に参照され含まれるAssetBundleを確認出来ません。

AssetBundleに含まれるアセットを全て確認する

コンテンツの中身を全て確認します。

下のコードをEditorフォルダ以下に格納した後、 AssetBundleを右クリック→AB/Content Checker でABの中身を確認出来ます。

テクスチャの中身等やモデル等も確認が可能です。

using System.Collections.Generic;
using UnityEditor;
using System.Linq;
using UnityEngine;

public class Checker : EditorWindow
{
    List<Object> allObjects = new List<Object>();
    Vector2 pos;

    private void OnGUI()
    {
        using (var scroll = new EditorGUILayout.ScrollViewScope(pos))
        {
            pos = scroll.scrollPosition;
            foreach (var obj in allObjects)
            {
                EditorGUILayout.ObjectField(obj, obj.GetType(), false);
            }
        }
    }

    [MenuItem("Assets/AB/Content Checker")]
    static void Open()
    {
        var window = CreateInstance<Checker>();
        window.ReadContent();
        window.Show();
    }

    void ReadContent()
    {
        AssetBundle bundle = null;
        try
        {
            bundle = AssetBundle.LoadFromFile(Application.dataPath + AssetDatabase.GetAssetPath(Selection.activeObject).Remove(0, 6));

            if (bundle != null)
            {
                SerializedObject so = new SerializedObject(bundle);

                foreach (SerializedProperty content in so.FindProperty("m_PreloadTable"))
                {
                    allObjects.Add(content.objectReferenceValue);
                }

                allObjects = allObjects
                    .Where(c => c != null)
                    .Where(c => c is Component == false )
                    .Where(c => c is GameObject == false)
                    .Distinct().OrderBy(c => c.name).ToList();
                bundle.Unload(false);
            }
            else
            {
                Debug.LogWarning("this is not assetbundle?");
                Close();
            }
        }
        finally
        {
            if( bundle != null)
                bundle.Unload(false);
        }
    }
}

例

例えば下のように、アドレスとしてはPrefabとAnimatorControllerのみを設定しています。

これをチェッカーで見ると、Prefabが暗黙的に参照している内で、同じAssetBundleに格納されている全てのアセットを確認出来ます。

またSprite Atlasでの動き等もココで確認しやすいです。下の画像を見ると、Sprite AtlasとAssetBundleを組み合わせる場合、SpriteAtlasに登録したAssetBundleを全て同じAssetBundleに登録している場合、含まれるアセットはパック済みTextureのみである事が確認出来ます。

現状の問題

• シェーダーが上手く取れません。

• 他のAssetBundleをLoadしていると、開いているAssetBundleに含まれるアセットも表示されるかもしれません。

CSVで出力もついてでに作ってみる

複数のAssetBundleの中身を一気に比較する用でCSV出力もつけてみました。

Default-SpriteがAssetBundleに複製格納されているせいで、バッチが破壊されるの図

using System.Collections.Generic;
using System.Text;
using UnityEditor;
using UnityEngine;
using System.Linq;

public class ExportCSV : MonoBehaviour
{
    [MenuItem("Assets/AB/ExportCSV")]
    static void Export()
    {
        var valuePairs = new Dictionary<string, string>();
        StringBuilder builder = new StringBuilder();

        foreach (var t in Selection.objects)
        {
            AssetBundle bundle = null;
            try
            {
                bundle = AssetBundle.LoadFromFile(Application.dataPath + AssetDatabase.GetAssetPath(t).Remove(0, 6));
                if (bundle != null)
                {
                    builder.Append($"{bundle.name}, ");
                    SerializedObject so = new SerializedObject(bundle);

                    List<Object> objs = new List<Object>();
                    foreach (SerializedProperty content in so.FindProperty("m_PreloadTable"))
                    {
                        objs.Add(content.objectReferenceValue);
                    }

                    objs = objs
                       .Where(c => c != null)
                       .Where(c => c is Component == false)
                       .Distinct().OrderBy(c => c.name).ToList();

                    foreach (var obj in objs)
                    {
                        builder.Append($"{obj.name}({obj.GetType()}), ");
                    }
                    builder.AppendLine();
                }
            }
            finally
            {
                if (bundle != null) bundle.Unload(true);
            }
        }

        System.IO.File.WriteAllText("ab content.csv", builder.ToString());
    }
}

感想

エディター基本機能を少し拡張しましたが、案外悪くないかも？　ABに含まれるテクスチャの確認が楽で良いです。

AssetBundleに含まれるコンテンツ一覧を確認する #unitytips pic.twitter.com/7iY8RrOtQz

— 椿 (@tsubaki_t1) 2019年3月26日

それとFBXにAssetBundle Nameを含めることでどんだけ無駄なゴミが増えるのかを確認出来ます。

関連

tsubakit1.hateblo.jp

tsubakit1.hateblo.jp