[UE4] PakBlacklistの使い方メモ


検証Ver:4.25.0

1.まえがき

プロジェクトのパッケージから特定のアセットを除外したい場合、PakBlacklistという機能を利用することができます。これは公式ドキュメントでも説明されているように、アセットを1つのファイルに纏める場合(.pakファイルを使用する場合)にのみ有効です。

4.25でも利用することができますが、これはDuplicatedに分類されているため将来的には利用できなくなるかもしれません。代替え機能としてPakFileRuleという機能があり、以下のブログでも説明されています。

[UE4] uasset以外のアセットにChunkIDを設定する(ue4.22以降)

2.使い方の補足

除外するアセットリストの定義ファイルを配置する

といっても、PakBlacklistはまだまだ利用することができます。
以下のようにビルド構成毎にPakBlacklist-[BuildConfig].txtというファイルを[Project]/Build/[Platform]に配置するだけです。
例えば「TP_425というプロジェクトでAndroidのTest構成でのみ特定のファイルを除外したい」場合、 PakBlacklist-Test.txtを作成して、TP_425/Build/Android/PakBlacklist-Test.txtのように配置します。

※ Windowsで適用する場合"Win64"や"Win32"のプラットフォーム名を追加する必要があります

除外するアセットリストを定義する

先ほど作成した定義ファイルの中に除外するファイルを記載します。ここではディレクトリを指定することも、アセット個別で指定することも可能です。

../../../TP_425/Content/StarterContent/Audio/
../../../TP_425/Content/StarterContent/Audio/Collapse_Cue.uasset
../../../TP_425/Content/StarterContent/Audio/Collapse_Cue.uexp

※ プロジェクト内のパスを指定する場合必ず "../../../[Project]/" を指定する必要があります (不一致だと除外されません)

ここで除外するファイルについてはアセットのリファレンスとは別に強制的にパッケージから除外されることになるため、参照されないことが明らかであることを把握した上で設定を行ってください。除外されたアセットを参照するようなアセットがある場合、それらはロード時にエラーとなります。