tanaka's Programming Memo

プログラミングについてのメモ。

Addressableアセットシステムを使ってみる

Addressableアセットシステムは、テキストなどのデータファイルをそれを指定する文字列などのアドレスで読み込む仕組みです。手軽にコンテンツのデータの作成や配布をするのに役立ちます。

Addressableアセットシステムは、依存関係(Dependencies)の一覧を使って、様々な場所から非同期にデータを読み込むことができます。直接参照したり、これまでのAsset Bundleを使ったり、リソースフォルダーを使うこともできます。

以下の公式ドキュメントをざっくり読んで、Addressableアセットの設定、作成、スクリプトからの読み込みをしてみます。

docs.unity3d.com

目次

使う上での注意点

  • 対応するのは、Unity2018.2以降
  • Addressables System 0.5.3で動作確認
  • 2019/4/25の時点ではまだreview版なので、仕様変更や不具合が発生する場合があります。正規のプロジェクトで使うかどうかは慎重に
  • 一通りの設定を終えるまではエラーが発生する場合があります。とりあえずエラーが出ても、アセットを読み込むところまで進めてください

Addressableアセットの設定と作成

インストール

Addressableアセットパッケージは、Package Managerからインストールできます。Package ManagerからAddressables Systemをインストールします。

アセットをAddressableに設定する

2通りの方法があります。Package ManagerでAddressables Systemをインストールしたら、Addressableにしたいアセットを選択してInspectorAddressにチェックを入れるか、Addressablesウィンドウを表示して、そこにドラッグ&ドロップします。

Addressableウィンドウは、WindowメニューからAsset Management > Addressable Assetsを選択して開きます。AddressableにしたいアセットをProjectウィンドウからドラッグして、AddressablesウィンドウのAssetタブにドロップします。

設定したアセットのデフォルトアドレスはプロジェクトのAssetパスです。例えばAssets/images/myImage.pngのようになります。これはInspectorウィンドウや、Addressablesウィンドウでユニークな他の文字列に変更することができます。

Addressableアセットをはじめて設定した時は、プロジェクトフォルダーにAssets/AddressableAssetsDataフォルダーが作成されて、必要なデータが作成されるので、バージョン管理システムを利用している場合は管理に加えてください。

読み込みやAddressからのゲームオブジェクト生成

実行中に読み込みやアセットから生成ができます。Loadingアセットでは、アセットバンドルのデータも含む読み込みに必要なすべてのアセットをメモリーに読み込みます。必要になった時にアセットを読み込んで使うことができます。Instantiating loads the Asset(アセットの読み込みと生成)の場合は読み込んだと同時にシーンにアセットが生成されます。

Addressableアセットにアクセスするスクリプトでは、冒頭で以下を追加しておきます。

using UnityEngine.AddressableAssets;

データの読み込み、および、読み込みとInstantiateは以下のメソッドで実行します。

LoadAsset

Addressables.LoadAsset<GameObject>("AssetAddress");

InstantiateAsset

Addressables.Instantiate<GameObject>("AssetAddress");

上記のいずれも非同期なので、読み込み完了時に処理する場合は以下のようにコールバックを設定します。特に、LoadAssetの場合は、読み込み後にデータを利用することになるので、以下の仕組みが必要になるはずです。以下、testdata.csvというテキストアセットを読み込んで、完了したらログ表示する例です。テキストアセットのエンコードUTF8Nです。

using UnityEngine;
using UnityEngine.AddressableAssets;

public class AddressableLoader : MonoBehaviour {

    void Start () {
        Addressables.LoadAsset<TextAsset>("testdata.csv").Completed += onLoadDone;
    }

    void onLoadDone(UnityEngine.ResourceManagement.IAsyncOperation<TextAsset> obj)
    {
        Debug.Log(obj);
    }
}

以上で、Addressableアセットを作成して、スクリプトから利用することができます。

これ以降、以下の項目を必要に応じて進めるとよいでしょう。

参考URL