ドキュメント

Unity Engine

Unity Engine

コードストリッピングがコンテンツに与える影響

マネージコードストリッピング設定がコンテンツビルドに与える影響と、コンテンツが依存するコードの保存方法について説明します。
読み終わるまでの所要時間 10 分最終更新 6日前

Unity でプレイヤーをビルドするとき、UnityLinker プロセスは、使用されていない型を削除することでアセンブリのサイズを削減するために実行されます。このプロセスでは、以下の削除できます。
  • MonoBehaviour
    や
    ScriptableObject
    インスタンスなどの C# Unity オブジェクト全体。Unity は、
    UnityEngine.dll
    や
    Unity.dll
    などのコア Unity アセンブリからこれらを取り除くことができますが、これらのアセンブリが使用とマークされると、カスタム アセンブリに保持されます。
  • 通常の C# 構造体とクラス
  • クラスの一部 (使用され例えば)。
  • AI や物理演算などの Unity モジュール全体。モジュールからタイプが参照されていない場合。
コードストリッピングがコンテンツに与える影響は、null リファレンス例外、欠落タイプエラー、またはクラッシュとしてプレイヤーに表示されます。また、AssetBundle または Addressables コンテンツ専用ビルドでは、プレイヤービルドから削除されたタイプは使用できません。
ビルドレポート Inspector のストリッピングタブを使用して、プレイヤービルドに保持されているモジュールとタイプを確認できます。
以下の状況では、リンカーによるコードのストリッピングを防止できます。

アセットバンドルで使用されるタイプのコードストリッピングの防止

Unity は、アセットバンドルには存在するが、プレイヤービルドに含まれるシーンやアセットには含まれない Unity オブジェクトタイプを削除する場合があります。つまり、再生モードでテストする場合や、コードストリッピングが最小のビルドではアセットバンドルのコンテンツは機能しますが、コードストリッピングを有効にしてビルドされたプレイヤーではエラーやクラッシュが発生します。
これを解決するには、以下のように、アセットバンドルのマニフェストファイルを直接含むカスタムビルドスクリプトを作成します。
  1. プレイヤーをビルドする前にアセットバンドルをビルドします。出力フォルダーには、アセットバンドルごとに 1 つの
    .manifest
    ファイルと、出力フォルダーと同じ名前のルート
    .manifest
    ファイルが含まれます。
  2. ルート
    .manifest
    ファイルのパスを
    BuildPipeline.BuildPlayer
    API でプレイヤーのビルドプロセスに渡します。
詳細については、アセットバンドルファイル形式リファレンスと
BuildPlayerOptions.assetBundleManifestPath
を参照してください。
「保持」属性を使用したり、プロジェクト内の
link.xml
ファイルを手動で作成して、コードストリッピングの動作をさらに変更することもできます。

Addressables で使用されるタイプのストリッピングの防止

Unity オブジェクトのタイプが Addressables でビルドされたコンテンツに存在し、プレイヤーにビルドされたシーンやアセットに存在しない場合、Unity はそのタイプを削除することがあります。
Addressables は、
Library/com.unity.addressables
フォルダー内にコンテンツで使用されるタイプを記述した
link.xml
ファイルを自動的に生成します。プレイヤービルドでは、Addressables コンテンツがプレイヤービルドの前に、またはプレイヤービルドと同時にビルドされている場合、この
link.xml
ファイルが考慮されます。
「保持」属性を使用したり、プロジェクト内の
link.xml
ファイルを手動で作成して、コードストリッピングの動作をさらに変更することもできます。

モジュールストリッピングの防止

link.xml
ファイルを使用して、Unityモジュール全体(例えばAIや物理演算)がストリップされるのを防ぐことはできません。
Addressables ビルドでモジュールの型を使用する必要がある場合は、そのモジュールを参照するコンテンツがプレイヤービルドに含まれていることを確認してください。例えば、物理演算モジュールを維持するには、ビルドに含まれるシーンのゲームオブジェクトにリジッドボディやコライダーなどのコンポーネントを追加します。これにより、プレイヤーのビルドプロセスが認識する依存関係が作成され、モジュールが保持されます。

スクリプトのみのビルド

プレイヤービルドは、
Library/PlayerDataCache
フォルダー内の
ScriptsOnlyCache.yaml
ファイルに使用型を記録します。外観を見て、コードストリッピングの問題を診断できます。このファイルは、以前のプレイヤービルドのコンテンツを再利用できるインクリメンタルな(増分)ビルドパイプラインをサポートするために使用されます。その場合、プレイヤービルドはキャッシュされた型の使用方法をそのファイルから Unity リンカーに渡します。
注
ScriptsOnlyCache.yaml
ファイルは、将来の Unity バージョンで変更される可能性のある内部形式を使用します。コードストリッピングをコントロールするには、
link.xml
ファイルを直接変更するのではなく、プロジェクトでファイルを使用します。

追加リソース