Asset Management | Unreal Engine 4.27 ドキュメンテーション

Unreal Engine 4 ではアセットのロードとアンロードを自動的に処理します。これにより、各アセットがまさに必要になるタイミングでエンジンがロードするように、デベロッパーがシステムをコーディングする苦労から解放されます。ただし、アセットを検出、ロード、監査する時期と方法について、デベロッパーが細かくコントロールしたい場合もあります。このような場合は、アセットマネージャー が役に立ちます。アセットマネージャーとは、エディタやパッケージ化ゲームにある唯一のグローバルオブジェクトです。これはどのプロジェクトにもオーバーライドしカスタマイズできます。コンテンツをチャンクに分割できるアセットを管理するためのフレームワークを提供します。チャンクはプロジェクトのそれぞれの状況で意味があるもので、Unreal Engine 4 の緩やかなパッケージアーキテクチャのメリットが失われません。さらにディスクやメモリ使用状況を監査できるツールセットも用意されています。これにより、ゲームをデプロイするときのクック処理とチャンク化向けにアセットの編成を最適化するために必要な情報が得られます。

プライマリアセットとセカンダリアセット

理論的に、Unreal Engine 4 のアセット管理システムではすべてのアセットを次の 2 つのタイプ、プライマリアセット と セカンダリアセット に分けます。プライマリアセットはアセットマネージャーで直接操作できます。このとき GetPrimaryAssetId を呼び出して取得する プライマリアセット ID を使用します。特定の UObject クラスから作成されたアセットをプライマリアセットとして指定するには、GetPrimaryAssetId をオーバーライドして、有効な FPrimaryAssetId 構造体を返します。セカンダリアセットはアセットマネージャーで直接操作できませんが、プライマリアセットが参照または使用されると、それに応じてエンジンにより自動的にロードされます。デフォルトでは、UWorld アセット (レベル) のみがプライマリで、他のすべてのアセットはセカンダリです。セカンダリアセットをプライマリアセットに変えるには、対応クラスの GetPrimaryAssetId 関数をオーバーライドして、有効な FPrimaryAssetId 構造体を返す必要があります。プライマリアセット ID は次の 2 つの部分で構成されます。アセットのグループを識別する固有のプライマリアセットタイプ、および コンテンツブラウザ に表示されるアセット名のデフォルトになる、個別のプライマリアセットの名前です。

ブループリントクラスアセットおよびデータアセット

アセットマネージャーでは次の異なる 2 つのタイプのアセット、ブループリントクラスおよびレベルおよびデータアセットなどブループリント以外のアセット (UDataAsset クラスのアセットインスタンス) を扱います。それぞれのプライマリアセットタイプは特定の基本クラスに関連付けられ、ブループリントクラスを格納するかどうかを、次に説明するコンフィギュレーションに指定します。

ブループリントクラス

新規ブループリントプライマリアセットを作成するには、コンテンツブラウザ でブループリントクラスを新規作成します。このクラスは GetPrimaryAssetId 関数をオーバーライドするクラスの子孫です。この基本クラスはプライマリデータアセットまたはその子、あるいは GetPrimaryAssetId をオーバーライドするアクタサブクラスです。ブループリントプライマリアセットにアクセスするには、C++ コードから GetPrimaryAssetObjectClass などの関数を呼び出す、またはその名前に「Class」を含むブループリントアセットマネージャー関数を使用します。クラスがある場合、他のブループリントクラスと同様に扱い、新しいインスタンスをスポーンするために使用できます。あるいは Get Defaults 関数を使用して、ブループリントに関連付けられたクラスデフォルトオブジェクトから読み取り専用データにアクセスできます。

インスタンス化がまったく必要ないブループリントクラスでは、データをデータ専用ブループリント (UPrimaryDataAsset から継承) に格納できます。使用する基本クラスから、ブループリントベースの子を含め、子クラスを派生させることもできます。たとえば、C++ で UPrimaryDataAsset を拡張した UMyShape のような基本クラスを作成でき、親が UMyShape である BP_MyRectangle というブループリントベースのサブクラス、さらに BP_MySquare という、ブループリントベースの BP_MyRectangle の子を作成できます。デフォルト設定では、作成した最後のクラスの PrimaryAssetId は MyShape:BP_MySquare になります。

非ブループリントアセット

プライマリアセットタイプでブループリントデータを格納する必要がない場合、非ブループリントアセットを使用できます。非ブループリントアセットはコードで簡単にアクセスでき、メモリ効率が高くなっています。エディタで非ブループリントプライマリアセットを新規作成するには、コンテンツブラウザの詳細ウィンドウからデータアセットを新規作成する、または新規レベルなどを作成するときのカスタム UI を使用します。このようにアセットを作成することは、ブループリントクラスの作成と同じではありません。作成するアセットは、クラス自体ではなく、クラスのインスタンスです。このクラスにアクセスするには、GetPrimaryAssetObject などの C++ 関数、または名前に Class がないブループリント関数でロードします。ロードされたら、直接アクセスして、そのデータを読み取ることができます。

これらのアセットはクラスではなくインスタンスなので、これらからクラスや他のアセットを継承できません。継承が必要な場合、たとえば、明示的にオーバーライドしたものを除き、親の値を継承する子アセットを作成する場合、代わりにブループリントクラスを使用する必要があります。

アセットマネージャーおよびストリーミング可能マネージャー

アセットマネージャーオブジェクトはシングルトンで、プライマリアセットの検出とロードを管理します。エンジンに含まれるアセットマネージャーの基本クラスには、管理の基本機能が用意されていますが、プロジェクト固有のニーズを満たすように拡張できます。ストリーミング可能マネージャー 構造体 (アセットマネージャー内に含まれる) はオブジェクトの非同期ロードに関わる処理を実行します。さらに、必要なくなり、アンロードできるまで ストリーミング可能ハンドル (Streamable Handle) を使用して、メモリにオブジェクトを維持します。シングルトンのアセットマネージャーと異なり、エンジンの各部や異なるユースケースで利用できる、複数のストリーミング可能マネージャーがあります。

アセットバンドル

アセットバンドル は、プライマリアセットに関連付けられた特定アセットの名前付きリストです。アセットバンドルを作成するには、UObject の TSoftObjectPtr または FStringAssetReference メンバーの UPROPERTY セクションに「AssetBundles」メタタグを付けます。タグの値は、セカンダリアセットを格納するバンドルの名前を示します。たとえば、次のスタティックメッシュアセット (MeshPtr というメンバー変数に格納) は、UObject が保存されるときに「TestBundle」というアセットバンドルに追加されます。

	/** Mesh */
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Display, AssetRegistrySearchable, meta = (AssetBundles = "TestBundle"))
	TSoftObjectPtr<UStaticMesh> MeshPtr;

アセットバンドルを使用する 2 番目の方法は、ランタイム時にプロジェクトのアセットマネージャークラスとともに登録することです。この場合、プログラマーは、FAssetBundleData 構造体にすべてデータが入ったコードを記述し、この構造体をアセットマネージャーに渡します。これを実行するには、UpdateAssetBundleData 関数をオーバーライドする、または、バンドルのセカンダリアセットに関連付けるプライマリアセット ID で AddDynamicAsset を呼び出します。

プライマリアセットを登録する、およびディスクからロードする

多くのプライマリアセットは コンテンツブラウザ に表示され、ディスクに格納されたアセットファイルとして存在します。これによりアーティストまたはデザイナーが編集できます。このように使用できるクラスをプログラマーが作成する最も簡単な方法は、UDataAsset 子クラス、UPrimaryDataAsset から継承することです。これにはアセットバンドルデータをロードおよび保存するためのビルトイン機能があります。別の基本クラス (APawn など) を使用する場合、UPrimaryDataAsset を調べることが便利です。自分のクラスに対してアセットバンドルを機能させるために実装する必要がある機能を最小限揃えたサンプルだからです。次のクラスは、想定されるゲームのゾーンのタイプを指定する方法の一例です。

	このゾーン タイプはゲーム全体のマップ画面でワールドのビジュアル表現を構築するとき、使用するアート アセットの種類をゲームに伝えます。
	UCLASS(Blueprintable)
	class MYGAME_API UMyGameZoneTheme : public UPrimaryDataAsset
	{
		GENERATED_BODY()

		/** Name of the zone */
		UPROPERTY(EditDefaultsOnly, Category=Zone)
		FText ZoneName;

		/** The Level that will be loaded when entering this zone */
		UPROPERTY(EditDefaultsOnly, Category=Zone)
		TSoftObjectPtr<UWorld> LevelToLoad;

		/** The Blueprint class used to represent this zone on the map */
		UPROPERTY(EditDefaultsOnly, Category=Visual, meta=(AssetBundles = "Menu"))
		TSoftClassPtr<class AGameMapTile> MapTileClass;
	};

このクラスは UPrimaryDataAsset から継承されるので、アセットの短い名前とネイティブクラスを使用する GetPrimaryAssetId の作業バージョンがあります。たとえば、「Forest」の名前で保存された UMyGameZoneTheme には、「MyGameZoneTheme:Forest」のプライマリアセット ID があります。UMyGameZoneTheme アセットがエディタで保存されるときは常に、PrimaryDataAsset の AssetBundleData メンバーはセカンダリアセットとしてそれを含めるように更新されます。

プライマリアセットの登録とロードには、次の操作が必要です。

エンジンに、プロジェクトのカスタムアセットマネージャークラスが存在する場合はそれを認識させます。デフォルトのアセットマネージャークラス UAssetManager をオーバーライドするだけです (プロジェクトで特別な機能が必要な場合)。プロジェクトで特別な機能が必要ない場合、このステップをスキップできます。オーバーライドするには、プロジェクトの DefaultEngine.ini ファイルを変更し、AssetManagerClassName 変数を [/Script/Engine.Engine] セクションに設定します。最終値は次の形式になります。
```
         [/Script/Engine.Engine]
         AssetManagerClassName=/Script/Module.UClassName
```
[/Script/Engine.Engine] AssetManagerClassName=/Script/Module.UClassName

ここで「Module」はプロジェクトのモジュール名、「UClassName」は使用する UClass の名前です。例として、プロジェクトのモジュール名は「MyGame」、使用するクラスは UFortAssetManager (つまり UClass 名は FortAssetManager) とすると、2 行目は次のとおりになります。 AssetManagerClassName=/Script/FortniteGame.FortAssetManager

使用するプライマリアセットをアセットマネージャーで登録します。 これを実行するには、[Project Settings (プロジェクト設定)] メニューで構成する、または起動時にプライマリアセットを登録するようにアセットマネージャークラスをプログラムします。
- [Project Settings] (Game / Asset Manager セクション) での構成は次のようになります。

プライマリアセットをスキャンするパスを設定できます。

設定	機能
Primary Asset Types to Scan (スキャンするプライマリアセットタイプ)	検出して登録するプライマリアセットのタイプ、さらに検索場所、実行内容をリストします。
Directories to Exclude (除外するディレクトリ)	プライマリアセットを明示的にスキャンしないディレクトリ。これはテストアセットを除外する場合に便利です。
Primary Asset Rules (プライマリアセットルール)	アセットの処理方法を指定する特定のルールオーバーライドをリスト。詳細については、「クック処理とチャンク化｣を参照してください。
Only Cook Production Assets (プロダクションアセットのみをクック)	DevelopmentCook と指定されたアセットは、これがオンの場合に、クックプロセス中にエラーを発生します。最終のシッピングビルドにテストアセットが含まれないことを確認するのに最適です。
Primary Asset ID Redirects (プライマリアセットIDリダイレクト)	アセットマネージャーがこのリストにある ID のプライマリアセットに関するデータを検索するとき、その ID が指定した別の ID で置き換えられます。
Primary Asset Type Redirects (プライマリアセットタイプリダイレクト)	アセットマネージャーがプライマリアセットに関するデータを検索するとき、このリストにあるタイプ名がネイティブタイプの代わりに使われます。
Primary Asset Name Redirects (プライマリアセット名リダイレクト)	アセットマネージャーがプライマリアセットに関するデータを検索するとき、このリストにあるアセット名がネイティブ名の代わりに使われます。

* コードでプライマリアセットを直接登録する場合は、StartInitialLoading 関数をアセットマネージャークラスでオーバーライドし、そこから ScanPathsForPrimaryAssets を呼び出します。この場合、単一のサブフォルダに同じタイプのすべてのプライマリアセットを配置することを推奨します。これにより検出と登録が速くなります。

アセットをロードします。アセットマネージャーの各関数 LoadPrimaryAssets、LoadPrimaryAsset、LoadPrimaryAssetsWithType を使用して、適切なタイミングでプライマリアセットをロードします。その後、UnloadPrimaryAssets、UnloadPrimaryAsset、UnloadPrimaryAssetsWithType でアセットをアンロードします。これらのロード関数を使用するとき、アセットバンドルのリストを指定できます。このようにロードすると、前に説明したとおり、アセットバンドルが参照しているセカンダリアセットをアセットマネージャーがロードします。

動的に作成されたプライマリアセットを登録しロードする

プライマリアセットバンドルは、ランタイム時に動的に登録しロードできます。実行を理解するのに役に立つ 2 つのアセットマネージャー関数があります。

ExtractSoftObjectPaths では、指定された UScriptStruct のすべての UPROPERTY メンバーを調べ、アセット参照を特定します。続いてこれらがアセット名の配列に格納されます。この配列は、アセットバンドルを作成するときに使用できます。 ExtractSoftObjectPaths パラメータ：

パラメータ	目的
`Struct`	アセット参照を検索するための UStruct。
`StructValue`	構造体への `void pointer`
`FoundAssetReferences`	構造体に見つかったアセット参照を返すために使用する配列。
`PropertiesToSkip`	返される配列から除外されるプロパティ名の配列。

RecursivelyExpandBundleData はプライマリアセットのすべての参照を検索します。アセットバンドルのすべての依存関係を見つけるために再帰的に展開します。この場合、上の ZoneTheme で参照される TheaterMapTileClass は AssetBundleData に追加されるということです。それから、名前付きダイナミックアセットを登録し、そのロードを開始します。 RecursivelyExpandBundleData のパラメータ

パラメータ	目的
`BundleData`	アセットの参照を含むバンドルデータ。再帰的に展開されます。関連アセット一式をロードするときに便利です。

たとえば、「MyGame」プロジェクトは、カスタムアセットマネージャークラスで次のコードを使用して、ゲーム中にダウンロードされた「theater」データに基づいて、アセットを構築し、ロードします。

	// Construct the name from the theater ID
	UMyGameAssetManager& AssetManager = UMyGameAssetManager::Get();
	FPrimaryAssetId WorldMapAssetId = FPrimaryAssetId(UMyGameAssetManager::WorldMapInfoType, FName(*WorldMapData.UniqueId));

	TArray<FSoftObjectPath> AssetReferences;
	AssetManager.ExtractSoftObjectPaths(FMyGameWorldMapData::StaticStruct(), &WorldMapData, AssetReferences);

	FAssetBundleData GameDataBundles;
	GameDataBundles.AddBundleAssets(UMyGameAssetManager::LoadStateMenu, AssetReferences);

	// Recursively expand references to pick up tile Blueprints in Zone
	AssetManager.RecursivelyExpandBundleData(GameDataBundles);

	// Register a dynamic Asset
	AssetManager.AddDynamicAsset(WorldMapAssetId, FSoftObjectPath(), GameDataBundles);

	// Start preloading
	AssetManager.LoadPrimaryAsset(WorldMapAssetId, AssetManager.GetDefaultBundleState());

プライマリ アセットとセカンダリ アセット

ブループリント クラス アセットおよびデータ アセット

ブループリント クラス

非ブループリント アセット

アセット マネージャーおよびストリーミング可能マネージャー

アセット バンドル

プライマリ アセットを登録する、およびディスクからロードする

動的に作成されたプライマリ アセットを登録しロードする