【Unity】RPGを作るチュートリアルその25 Addressablesの導入

シンプルなRPGをUnityで作るチュートリアルシリーズの25回目です。

第24回ではキャラクターの定義データを作成しました。

今回は各定義データを管理する仕組みの準備として、Addressablesを導入して、定義データをグループごとに分けていきたいと思います。

制作環境

MacBook Pro 2023 Apple M2 Max

Unity6 (6000.0.30f1) Silicon

作業内容と順序

シンプルなRPGを作る上でどんな作業が必要か、どんな順番で作っていくと良さそうか、別ページで検討しました。基本的にこの流れに沿って進めていきます。

エクスプラボ

【Unity】簡単なRPGを作る場合に必要な作業を考えてみよう

https://ekulabo.com/simple-rpg-ready

UnityでRPGを作るときに必要になるであろう作業をリストアップしてみました。抜け漏れがない形ではなく、さっと思いついた部分をまとめているので、実際に作業してみて追加を行う部分もあるかもしれません。

エクスプラボ

UnityでRPGを作る時にスムーズにいきそうな作業順序を考えてみる

https://ekulabo.com/unity-rpg-work-flow

シンプルなRPGを作ることを想定して、スムーズに進みそうな作業順序を考えてみました。個人個人でやりやすい進め方も異なるかと思いますので、ひとつのサンプルとして捉えていただければと思います。

チュートリアルの一覧

このシリーズ全体の一覧は以下のページにまとめています。

エクスプラボ

 

1 User

1 Pocket

【Unity】シンプルなRPGを作るチュートリアルの一覧まとめ

https://ekulabo.com/rpg-tutorial-list

UnityでシンプルなRPGを作るチュートリアルシリーズのまとめページです。もし個別のページからご覧いただいた場合は、こちらのまとめページもご参照ください。

前回の内容

前回はキャラクターの定義データを作成しました。

エクスプラボ

 

1 Pocket

【Unity】RPGを作るチュートリアルその24 キャラクターの定義データを作成

https://ekulabo.com/rpg-tutorial-character-data

UnityでシンプルなRPGを作るチュートリアルシリーズの第24回です。この回はキャラクターの定義データを追加します。キャラクターのIDや名前、覚える魔法を定義できるクラスを作成していきます。作成するゲームによってはキャラクターに紐づく情報も増えていくので、必要な情報を付加できるように定義クラスを作成することにしました。

Addressablesとは

Addressablesとは、Unityのアセットを管理するためのパッケージで、実行時にアセットをロードしたり、使っていない時にリリースしたりしてくれます。アドレスを使ってアセットを読み込むことができて、アプリ本体に同梱されていても、サーバにアセットを配置していても見つけてロードしてくれます。(配置先がどこなのかの設定などは必要)

UnityのチュートリアルだとResources.Loadなどを使うことが多かったりしますが、Unity公式では本番環境でResourcesはあまり使わないでね、と言っていたりするので、Addressablesを使って実装するのが無難です。Resourcesはプロトタイプなら有用、とも書かれています。

docs.unity3d.com

Resources フォルダー - Unity マニュアル

https://docs.unity3d.com/ja/2023.2/Manual/BestPracticeUnderstandingPerformanceInUnity6.html

Resources フォルダーは、しばしば Unity プロジェクトで発生する各種問題の原因となります。Resources フォルダーの不適切な使用が原因で、プロジェクトのビルドサイズの膨張やメモリの極端な過剰使用の原因となり、アプリケーションの起動時間が著しく長くなってしまうことがあります。

Resourcesフォルダに配置したアセット類はゲーム起動時に全部読み込まれるので、簡単にアクセスできるメリットがある反面、本番のアプリケーションだと量が多くなりがちで、起動時間がとても長くなってしまいます。そのため、必要な時にロードする仕組みのAddressablesが推奨されています。

今回のチュートリアルでは本番リリースを見越してAddressablesで実装していきます。具体的にはこれまで作成した定義データや、この後導入するであろうオーディオ類などをロードできるようにしたいと思います。

Addressablesのインポート

プロジェクトにAddressablesのパッケージをインポートしていきましょう。画面上部のメニューバーから [Window] -> [Package Manager] を選択してPackageManagerを開きます。

PackageManagerウィンドウでは左側のタブから「Unity Registry」を選択し、パッケージ名の中から「Addressables」を選択します。画面右側の領域で表示される [Install] をクリックしてインストールします。

インストールが完了するとパッケージ名の右側にチェックマークが付きます。

Addressablesの設定

続いてAddressablesの設定を行なっていきます。画面上部のメニューバーから [Window] -> [Asset Management] -> [Addressables] -> [Groups] を選択してAddressablesのウィンドウを開きます。

Projectウィンドウからアセットファイルをドラッグ&ドロップして使うことを考えているので、Projectウィンドウがあるエリア以外の部分に「Addressables Groups」のタブをドラッグ&ドロップしておきます。私はGameウィンドウの右側に配置してみました。Inspectorウィンドウと同じエリアに配置したり、Hierarchyウィンドウと同じエリアに配置したりと、普段のご自身の使い方に合わせて、使いやすい場所に配置するのが良いかと思います。

Addressables Groupsのウィンドウでは [Create Addressables Settings] のボタンをクリックして設定ファイルを作成します。保存先は自動的に選択されます。

設定ファイルを作成すると以下のようにグループが表示されるようになります。デフォルトのグループとして「Default Local Group (Default)」が存在していますが、今回はカテゴリに合わせてグループを作っていきたいと思います。コンテキストメニューを開き、[Create New Group] -> [Packed Assets] からグループを作成します。

作成したグループの上でコンテキストメニューを開くと [Rename] のメニューがあるので、ここから名前を変更していきましょう。ゆっくり2回クリックするか、エンターキーを押しても変更できます。(Macの場合)

作成するグループは4つで、以下の表のように名前をつけました。

グループを作成したら、グループの中にアセットをドラッグ&ドロップしていきます。まずはキャラクターに関連するアセットをグループに入れていきます。Projectウィンドウの「Assets/Data」フォルダに移動して、「CharacterData」、「ExpTable」、「ParameterTable」の3つの定義データをグループにドラッグ&ドロップします。

ドラッグ&ドロップした後は、アドレス名をシンプルにするため、グループ内のアセットを選択した状態でコンテキストメニューを開き、[Simplify Addressable Names] を選択します。複数選択で一括で適用することもできます。これによってパスではなくデータ名で表示されるようになります。今回のフォルダ構成だとシンプルにしてあるのでパスが短いのですが、ゲームの規模が大きくなるとフォルダが深くなってパスが長くなり、ファイル名まで表示されないケースもあるため、個人的に扱いやすいデータ名だけで表示するようにしています。

続いて、アセットにラベルを設定していきます。Addressablesで登録したアセットは、アドレスで読み込んだり、ラベル単位で読み込んだりと複数の読み込み方でロードできます。今回は敵キャラの一覧、アイテムの一覧、という形で同じカテゴリのデータをまとめて読み込みたいので、ラベルを使ってロードするようにしましょう。

ラベルを作るには、グループ内のアセットの右側にあるラベルのプルダウンをクリックして、[Manage Labels…] を選択します。

ラベル追加のウィンドウでは、[+] ボタンをクリックするとラベルを追加できます。「Label Name」の項目に追加したいラベル名を入れ、[Save] ボタンをクリックすることで追加されます。

今回追加したいラベル名は以下の表の通りです。

追加が完了したらラベル管理のウィンドウを閉じて、再びアセットのプルダウンをクリックします。すると追加したラベルが表示されるので、データに対応するラベルを選択します。画像ではキャラクターの定義データである「CharacterData」を選択していて、[Character] のラベルを選択しました。

他のグループに関してもデータをドラッグ&ドロップしていきましょう。以下の画像では敵キャラクターの定義データをグループに含めました。アドレス名をシンプルにするときと同様に、ラベルの設定も複数選択で一括で設定できます。

アイテム、魔法に関しても同様にグループへのドラッグ&ドロップと、ラベルの設定を行います。以下の画像は設定が完了した後の様子です。

ラベル名をコード内で定義

コード内でラベルを使ってアセットをロードしていくにあたって、ラベル名も定義値のクラスで定義しておきたいと思います。若干原始的な気もしますが、ラベルという大きな括りなら変更もそんなに発生しない想定なので、文字列で定義しておきます。

Projectウィンドウの「Assets/Scripts/Consts」のフォルダにて、空のスクリプトファイルを作成します。名前は [AddressablesLabels] にしました。

作成した「AddressablesLabels」の中身は以下のように記載しました。

コード内ではこの定義値を使ってラベル単位でロード予定です。もしラベル名が変わったとしても、このクラスの値を変えればOKなので多少は影響も減らせます。

今回はまだ動作確認はできないので、スクリプトを保存してコンパイルエラーなどがなければ完了です。

今回のブランチ

GitHub

GitHub - todorok1/SimpleRPGTutorial at tutorial-25

https://github.com/todorok1/SimpleRPGTutorial/tree/tutorial-25

シンプルなRPGを作るチュートリアル向けリポジトリです。. Contribute to todorok1/SimpleRPGTutorial development by creating an account on GitHub.

まとめ

今回は作成した定義データを管理する仕組みとしてUnityのAddressablesを導入しました。また、定義データをグループ分けし、ラベルでロードできるように準備を行いました。各カテゴリのデータをロードする際には今回の設定を使っていきます。

次回はキャラクターの実行中の状態を保持するクラスを作成していきます。定義データでは最大HPや最大MPを定義していますが、現在のHPやMPがいくつになっているか保持する仕組みを作っていきましょう。

エクスプラボ

 

1 Pocket

【Unity】RPGを作るチュートリアルその26 実行時のキャラクターの状態を保持

https://ekulabo.com/rpg-tutorial-character-status

UnityでシンプルなRPGを作るチュートリアルシリーズの第26回です。この回は実行中のキャラクター個別の状態を保持するクラスを作成します。このクラスは、後の回でキャラクター全体の情報を保持するクラスの中から参照させる予定です。