ambrにAddressable Assetsを導入してアイテムを外部からロードしてみた

はじめに

ambrにおいて、Addressable Assetsを導入する試みを行いました。
今回の記事ではざっくりとAddressable Assetsの設定の手順に関してご説明していこうと思います！

ambrとは

ambrとは新しい仮想世界の実現を目指すVRソーシャルサービスです。
誰でも手軽に好きなアバターに変身してコミュニケーションを楽しむことができます。
対応プラットフォームは現在のところOculus Goのみですが、将来的にはVRデバイス全てに対応したマルチプラットフォームアプリを目指しています！
近々リリース予定ですのでよろしくお願いします！
Twitterで情報発信しておりますのでよろしければフォローをお願いします！

I'm tweeting from #ambr pic.twitter.com/V3EUR7IWc5

— tanaco VR | ambr VPoE (@tanacooo) 2018年12月21日

環境

• Unity 2018.2.12f1
• Addressables 0.4.6-preview

ambrにおけるアイテムとは

ambrにはアイテムを使用する機能があります。イベント等で取得したアイテムを好きなときに使用し楽しむことができます。
こんなふうに

これは水鉄砲をアバターが装備するアイテムですね。ベータ版ではPvEイベントの際にこの水鉄砲を使って敵にダメージを与えました。
このアイテムのモデルデータを外部サーバからAddressable Assetsを使って読み込んでいます。

なぜAddressable Assetsを採択したのか

今後、アイテムのモデルデータ等が格段に大きくなることが予想されるため、AssetBundleで外部データ化することは決定していました。
最近Unityに追加されたAddressable Assetsがアセット間の依存解決やバージョン管理、キャッシュなど
AssetBundleでハイコストな問題へのサポートが強力だったため、まだPreview版ですが採用することにしました。

Addressable Assets設定の手順

Package Managerの設定

Addressable AssetsはUnity Package Managerを使用して導入することができます。
Packages/manifest.jsonに以下のように追記します。

Packages/manifest.json

{
  "dependencies": {
    "com.unity.addressables": "0.4.6-preview"
    }
}

こうすることでPackge ManagerにAddressable Assetsが表示され、使用することができます。

アセット登録 ＆ ビルド

Window -> Asset Management -> Addressable Assetsで管理用のWindowを開き、Create Addressables SettingsをクリックするとAssets/AddressableAssetsData以下に設定ファイルが作成されます。
その後、Addressable Windowに登録したいアセットまたはPrefabをD&Dし、ビルドすることで、Addressableインスペクタから設定できるBuild Pathにアセットバンドルが生成されます。
このときAsset Address欄がコードから呼び出すAsset名になりますが、デフォルトでフルパスが設定されて非常に長くなりますので
右クリック→Simplify Entry Namesするとファイル名まで短縮されるので使い勝手が良くなると思います。
この時Asset名の重複を起こしてはいけないので気をつけましょう。

ロード

生成したアセットバンドルファイル群を自前で用意したサーバにアップロードします。
ambrではAWSのS3を使用しています。
最後に、サーバの格納パスをAddressable インスペクタのLoad Pathに設定すれば設定完了です。

コード側は、LoadAssetに読み込みたいAssetのパスの文字列を渡すことでロードできます。

Addressables.LoadAsset<GameObject>("Asset/xxxx")

アセット名をハードコーディングしたくない場合は、AssetReferenceをインスペクタに露出させて、Addressable WindowからD&Dでアタッチすると
LoadAsset()の引数に渡すことができます。

AddressableがPrefabである場合、以下のように実体化することができます。

public AssetReference hogePrefabRef;

Addressables.LoadAsset<GameObject>(hogePrefabRef)
.Completed += (op) =>
{
   GameObject go = Instantiate(op.Result);
   HogeClass hoge = go.GetComponent<HogeClass>();

   //初期化処理
};

※注意
[AssetReferenceTypeRestriction(typeof(HogeClass))]
public AssetReference hogePrefabRef;
AssetReferenceのインスペクタ露出時に、上記のように属性をつけると型指定ができる…はずですが、0.4.6環境下ではうまく動きませんでした。

Prefabの場合、LoadAssetの型指定でPrefabにアタッチされているクラスの型が指定できそうですが、
0.4.6環境下ではエラーが出てしまいますので、生成後にGetComponentしています。
今後のAddressableのアップデートで解消されるかも？

最後に

ambrでは可能な限り新しい技術に取り組み、エンジニアチームの技術力向上にチャレンジしています。
しかし、よりよいサービス開発を行っていくためにはまだまだ人手や知識が不足しています。
そんなambrに手を貸していただけるエンジニアの方を絶賛募集中です！
もし、興味のある方がいらっしゃれば、下記のBosyuや、TwitterのDMでご連絡ください！

リリース版の開発に向け、本格的にUnityエンジニアの募集を開始します！
これからのambrを支える重要なポジションを担当してもらうことになりますので、チャレンジングなお仕事になると思います！

新しい仮想世界"ambr"を一緒に創ってくれるUnityエンジニア募集！
https://t.co/Udp32olg6R #bosyu

— tanaco VR | ambr VPoE (@tanacooo) 2018年12月10日