ドキュメント

Unity Engine

Unity Engine

Unity での条件付きコンパイル

Unity スクリプトで条件付きコンパイルを使用する方法とタイミングの概要。
読み終わるまでの所要時間 7 分最終更新 5日前

Unity の C# 言語のサポートには、ディレクティブの使用が含まれています。ディレクティブを使用すると、特定のスクリプトシンボルが定義されているかどうかに基づいて、コンパイルにコードを選択的に含めたり除外したりできます。C# でのこれらのディレクティブの動作の詳細は、C# プリプロセッサーディレクティブに関する Microsoft のドキュメントを参照してください。
Unity には、スクリプトで使用できる定義済みのシンボル範囲があり、コードの一部をコンパイルに選択的に含めたり除外したりできます。例えば、Windows スタンドアロンプラットフォームのプロジェクトビルドで定義されるシンボルは
UNITY_STANDALONE_WIN
です。このシンボルが定義されているかどうかは、特殊なタイプの
if
ステートメントを使用して確認できます。
#if UNITY_STANDALONE_WIN Debug.Log("Standalone Windows");#endif
#if
と
#endif
の正面にあるハッシュ (
#
) 文字は、これらの文が、ランタイムではなくコンパイルプロセス中に処理される指令であることを示します。前の例では、デバッグ 行はプロジェクトの Windows スタンドアロンアロンビルドのビルドにのみ含まれます。Unity エディターまたはその他のターゲットビルドでコンパイルすると、完全に省略されます。これは、通常の if 文の使用とは異なり、ランタイムのコードの特定の部分の実行のみをバイパスできます。
#elif
と
#else
ディレクティブを使用して、複数の条件を確認できます。
#if UNITY_EDITOR Debug.Log("Unity Editor");#elif UNITY_IOS Debug.Log("Unity iOS");#else Debug.Log("Any other platform");#endif
定義済みのシンボルがいくつかあり、選択したプラットフォーム、エディタバージョン、およびその他のシステム環境シナリオに基づいて、コードを選択的にコンパイルまたは省略できます。Unity の定義済みシンボルの完全なリストについては、Unity スクリプトシンボルリファレンスを参照してください。
エディター、スクリプト、またはアセットファイルを使用して、独自のスクリプトシンボルを定義することもできます。詳細については、カスタムスクリプトシンボル を参照してください。
注
スクリプトシンボル は、定義シンボル、プリプロセッサー定義、または単に定義とも呼ばれます。

ディレクティブの代替手段

プリプロセッサー指令は、必ずしもコードを条件付きで含めたり除外したりするための最も適切で信頼性の高い方法ではありません。代替アプローチはここにリストされています。

attributeConditional`

C# の
Conditional
属性は、関数をよりクリーンに、エラーが発生しにくい方法でストリッピングできます。詳細は、ConditionalAttribute クラス を参照してください。
Start()
、
Update()
、
LateUpdate()
、
FixedUpdate()
、
Awake()
などの一般的な Unity コールバックは、エンジンから直接呼び出されるためこの属性の影響を受けません。また、パフォーマンス上の理由から、これらのコールバックはアカウントに含まれません。

アセンブリ定義制約

高レベルの条件付きコンパイルに推奨されるアプローチは、関連するアセンブリ定義ファイルを持つアセンブリにスクリプトを整理することです。条件付きで追加または除外するコードがアセンブリ内にある場合は、アセンブリ定義で制約の定義を設定して、例えば、特定のバージョンのパッケージがプロジェクトに存在する場合にのみコードをコンパイルできます。

条件付き実行

条件付きコンパイルの代わりに、標準
if
文を使用してコンパイル済みコードの条件付き実行を強制できます。例えば、Unity の
UNITY_64
スクリプトシンボルは、64 ビットアーキテクチャでは信頼性の低いテストであるため、代わりに以下の手順を実行します。
if (IntPtr.Size == 4){ // 32 bit code}else{ // 64-bit code}

追加リソース