BLOGブログ

2019.12.25UE4/C++

[UE4] 独自に用意したデータアセットをより便利に活用する方法

執筆バージョン: Unreal Engine 4.24

はじめに

以前、弊社ブログにてユーザー定義のオブジェクトをアセット化する方法をご紹介したと思います。
こちらの記事では、CSVファイルからインポートしてきたデータテーブルの内容をC++で定義した型(構造体の配列やMap)に格納してデータアセット化するというものでした。今回は、その内容をより詳しく解説し、かつワークフローをより最適化させるための方法をご紹介したいと思います。


 

何故データアセット化するのか

その前に、改めて何故データアセットを利用するのかというメリットから簡単にご説明したいと思います。

●CSVファイルが複数に分かれている時に便利
例えばイベントデータのデータテーブルが、1話と2話でCSVファイルが分かれていた場合、その話数ごとに参照するデータテーブルを切り替えるより、一つのデータアセットから取得するようにした方が便利な場合もあります。

●1つのデータに対して、関連するCSVファイルが複数ある場合にデータをまとめられる
例えばキャラクターの攻撃関係のCSVファイルと防御関連のCSVファイルが分かれていた時、同じキャラクターであれば一つのデータにまとめたいですよね。そんな時に便利です。

●データの取得方法がデータテーブルだと少し面倒
データテーブルの型であるFTableRowBaseは、あるデータの内容を取得したい場合にちょっと面倒です。それはC++でもブループリントでも同じことが言えます。やはり普段から操作に慣れているTArrayだったりTMapの方がアクセスしやすいではないでしょうか。

軽く挙げるとこのような感じになります。逆に言うとこれら上記のメリットをさほど感じないというデータは、そのままデータテーブルから直接参照しても差し支えないとも言えます。取り扱うデータに合わせて、必要ならばデータアセット化していくようにしましょう。
 

データアセットの準備

さて、データアセット化するメリットが分かった所で、早速データアセット化するための準備を行います。
まずは手始めにデータテーブル用の構造体と、実際にゲーム内で使うデータ用の構造体をそれぞれ作成します。


ここでポイントは以下の2点です。
●データテーブル用構造体FCharacterData_TableRowの基底クラスがFTableRowBase
●実際にゲーム側で使うキャラクターデータの構造体FCharacterDataはブループリントでも使えるようにUSTRUCTがBlueprintTypeだったり、各UPROPERTYがBlueprintReadOnlyである(必要に応じて)

ちなみにデータテーブル用構造体の各UPROPERTYがEditAnywhereなのはデータテーブルアセットを直接編集できるようにするためですが、インポート元であるCSVファイルの内容をそのまま使うだけであれば編集不可にした方が安全です。

次にデータアセット用のクラスを作成します。

ここでポイントなのは、以下の通りです。
●データアセット用のクラスUCharacterDataAssetは基底クラスがUDataAsset
●UCharacterDataAssetが保持するデータテーブルはエディタ上でしか参照する必要がないのでWITH_EDITORONLY_DATAで囲う
●データ作成用の関数はエディタ上で使えるようにCallInEditor=”true”
これで完了です。
 

目指す所

次にデータテーブルからデータアセット化する部分を実装していきますが、この処理のついでにワークフローを最適化させたいと思います。今回のこの記事の醍醐味と言っていいでしょう。
まず基本的にデータテーブルはCSVからインポートされたデータという前提で話を進めます。
そのまま実装するとワークフローは以下の通りになるはずです。

手順① CSVファイルのデータを更新する
手順② UE4エディタ上でコンテンツブラウザからデータテーブルを右クリックして、リインポートを行う
手順③ データアセットでデータテーブルのインポートを行う
手順④ データテーブルとデータアセットをそれぞれ保存する

以下の作業、手順2から4まではUE4エディタ上での作業になるため、できればこれらの作業は一つにまとめたい所です。
そこで、インポート用のボタン操作でデータテーブルのリインポートと各アセットの保存も一緒にやることにします。
つまりボタン1つ押すだけで全てが完了するようにしよう!というのが今回の目指す所です。

    
 

実装方法

では実際の実装方法を紹介していきます。

ここでのポイントは以下になります。
●データテーブルのリインポートはFReimportManagerのReimport関数を使用
●データテーブルの全行取得はGetRowNames関数で、Row名の配列を返す
●FindRowで特定の1行分のデータを取得できる
●アセットを編集した場合はMarkPackageDirtyを呼んで編集マークをつける
●FEditorFileUtils::PromptForCheckoutAndSaveを使うことでソースコントロール(Perforceなどのバージョン管理ソフト)で管理されているアセットも普段通りのアセット保存のフローで保存できる

最後に、このままではビルドが通らないのでプロジェクト用のBuild.csにUnrealEdのモジュールを追加する必要があります。

これで実装は完了です。
 

実際にデータアセットを作ってみる

さて、次に実際にエディタ上でデータテーブルとデータアセットを作ってみたいと思います。

手順① まずCSVファイルをコンテンツブラウザにドラッグ&ドロップします。

手順② データテーブルの構造体にはCharacterData_TableRowを指定します。

手順③ 次に新規でデータアセットを作成し、クラスにはCharacterDataAssetを指定します。
  
手順④ データアセットを開いてDataTableに先程作成したデータテーブルを入れます。

手順⑤ データアセットのBuildボタンを押せば完了です。

 

実際にデータアセットを使ってみる

せっかく作ったデータアセットなので、今回はその利用方法の一例も紹介したいと思います。
まず、静的なデータアセットをまとめて管理する用のStaticDataManagerを用意します。このManagerクラスが色んなデータアセットを保持するような想定です。
もちろん各アセットへの参照はFSoftObjectPathを使って、直にアセット参照を持たないようにします。そうすることでアセットの読み込みタイミングを任意に扱う事ができ、ロードやメモリの管理が楽になります。
ではStaticDataManagerクラスを作成していきましょう。

ポイントとなる点は以下の通りです。
●プロジェクト設定でアセットのファイルパスが設定できるようにUCLASSにconfigを指定
●データアセットのファイルパスも同じくUPROPERTYにConfigを指定
●上記に述べた理由でデータアセットはFSoftObjectPath型を使用
●FSoftObjectPath型のUPROPERTYはmetaデータでAllowedClassesにデータアセットの型を指定(理由は後述)

プロジェクト設定からファイルパスを設定できるようにする方法は弊社ブログのこちらに記載しています。
UMyEditorSettingに該当する部分が今回だとStaticDataManagerになるというわけです。また、今回はエディタ設定ではなくプロジェクト設定にしているので記事を参考にする際に注意が必要です。

きちんと設定ができたら下記画像のようにプロジェクト設定からアセットのパスが指定できるようになります。

さきほどAllowedClassesにCharacterDataAssetを設定した事で、画像のようにアセット一覧に出てくるアセットが限定されるようになりました。間違った型のアセットを指定してしまうなどの作業ミスがこれで防げるわけです。

そして今回は使いやすいようにアセットデータの取得関数をStatic関数にしました。また、本来ならこのクラスに書くべきではありませんが、省略して任意のキャラクターデータを取得する関数も用意しました。
それとロードのタイミングを厳密に行いたい場合は、StaticDataManager内にLoad専用のメソッドを用意するとよいでしょう。

では続いて中身の実装です。
と、その前にStaticDataManagerのインスタンスを生成しないといけないので、この処理をとりあえずGameInstanceを派生させたTestGameInstanceで行います。

Cppファイル側は以下になります。

GameInstaceクラスを派生した場合は、忘れずにプロジェクト設定でクラス指定を行いましょう。

では準備が完了したのでStaticDataManager側の実装に戻ります。

データアセットの取得時に、読み込まれていなかったらStaticLoadObjectでアセットをロードするようにしています。本来ならここはきちんと事前にアセットを非同期読み込みを行うようにして、読み込まれてなかったらエラーを返すようにするなどした方がよいでしょう。今回はとりあえずの処理なのでこれでよしとします。
任意のキャラクターデータを取得している関数に関しては、実際のデータアセットの使い方の例として参考にして下さい。

では最後にブループリントを使って呼び出してみましょう。

余談ですが、以前ご紹介したこちらの記事の内容を参考にしていただければ、データテーブルから参照している部分を改造することで、引数のInCharacterIDはデータアセットを参照して、キャラクターID一覧から選択して指定する事も可能です。存在しないキャラクターIDを指定しないためにも、是非活用してみて下さい。

ちょっと長くなってしまいましたが、いかがでしたでしょうか?
是非データ管理周りの参考にしてみて下さい。