ビルドコンフィギュレーション | Unreal Engine 4.27 ドキュメンテーション

UnrealBuildTool は、生成された UE4 プロジェクトの「Config/UnrealBuildTool」フォルダに追加されるだけでなく、Windows の次の場所にある XML 構成ファイルから設定を読み取ります。

Engine/Saved/UnrealBuildTool/BuildConfiguration.xml
User Folder/AppData/Roaming/Unreal Engine/UnrealBuildTool/BuildConfiguration.xml
My Documents/Unreal Engine/UnrealBuildTool/BuildConfiguration.xml

Linux と Mac では次のパスを使用します。

/Users//.config//Unreal Engine/UnrealBuildTool/BuildConfiguration.xml
/Users//Unreal Engine/UnrealBuildTool/BuildConfiguration.xml

ビルドコンフィギュレーションの設定とカスタマイズについては、次のプロパティの詳細を参照してください。

$ bGeneratedSYMFile :dSYM ファイルを生成するかどうかを指定します。シッピングビルド用は true、その他すべてのビルド用は false がデフォルトです。 -dsym はその他のビルド用に dsym の生成を強制します。 * NoDsym はシッピング用に強制的にオフにします。

$ bEnableAddressSanitizer :アドレスサニタイザー (ASan) を有効にします。

$ bEnableThreadSanitizer :スレッドサニタイザー (TSan) を有効にします。

$ bEnableUndefinedBehaviorSanitizer :未定義動作サニタイザー (UBSan) を有効にします。

$ BaseLogFileName :ログに使用するファイルを指定します。

$ bAllowDistccLocalFallback :有効にすると、リモートコンパイルが失敗したときに、DMUCS/Distcc をローカルコンパイルにフォールバックできます。デフォルトでは true に設定されています。これは、前処理段階とコンパイル段階を分離すると、致命的なものではないですがエラーが発生する可能性があるためです。

$ bVerboseDistccOutput :true の場合、デバッグに役立つ詳細な distcc 出力を有効にします。

$ DistccExecutablesPath :Distcc および DMUCS 実行ファイルへのパスです。

$ DMUCSCoordinator :DMUCS コーディネータのホスト名または IP アドレスです。

$ DMUCSDistProp :コンパイルホストを要求する DMUCS 識別プロパティ値です。

$ bXGENoWatchdogThread :VS2015 ツールチェーンの遅れを防ぐために no_watchdog_thread オプションを使用するかどうかを指定します。

$ bShowXGEMonitor :XGE ビルドモニターを表示するかどうかを指定します。

$ bStopXGECompilationAfterErrors :有効にすると、コンパイルエラーが発生した後、XGE はターゲットのコンパイルを停止します。他のユーザーのコンピュータリソースを節約するため、このオプションをお勧めします。

$ bWriteSolutionOptionFile :sln のソリューションオプション (suo) ファイルを書き込むかどうかを指定します。

$ bAddFastPDBToProjects :デフォルトでコマンドラインをビルドするための -FastPDB オプションを追加するかどうかを指定します。

$ bUsePerFileIntellisense :ファイル単位の IntelliSense データを生成するかどうかを指定します。

$ bEditorDependsOnShaderCompileWorker :エディタのプロジェクトファイルを生成するときに ShaderCompileWorker への依存関係をインクルードするかどうかを指定します。

$ bDebugBuildsActuallyUseDebugCRT :デバッグビルド用に Debug C++ ランタイム (CRT) を有効にします。デフォルトでは、リリースランタイムを常に使用します。これは、デバッグバージョンを用いた Unreal Engine プロジェクトのデバッグが実用的ではないことと、デバッグ CRT ライブラリとリンクすると、サードパーティライブラリの依存関係もデバッグ CRT を使用したコンパイルが強制されるためです (そして、通常は実行が遅くなります)。多くの場合、プログラムのコードをデバッグするためだけにサードパーティのスタティックライブラリのデバッグバージョンのコピーが別途必要となり、あまり便利ではありません。

$ bUseInlining :すべてのモジュールのインライン化を有効にします。

$ bUseDebugLiveCodingConsole :ライブコーディングに対応可能かどうかを指定します。

$ bUseXGEController :XGE のコントローラーワーカーとモジュールをエンジンビルドにインクルードするかどうかを指定します。これらは、XGE インターセプトションインターフェースを使用した分散シェーダコンパイルに必要です。

$ bUseUnityBuild :コンパイルを高速化するために、C++ コードを大きなファイルに統合するかどうかを指定します。

$ bForceUnityBuild :コンパイルを高速化するために、C++ コードを大きなファイルに強制的に統合するかどうかを指定します。

$ bUseAdaptiveUnityBuild :ヒューリスティックな手法で、現在イテレート中のファイルを判別し、それらを単一のブロブから取り除き、増分コンパイル時間を短縮します。現在の実装では、読み取り専用フラグを使用して作業セットを区別しています。これは、ファイルが変更されるとソースコントロールシステムによって書き込み可能になることを前提としています。この方法は Perforce には使用できますが、Git には適しません。

$ bAdaptiveUnityDisablesOptimizations :適応する non-unity な作業セット内のファイル最適化を無効にします。

$ bAdaptiveUnityDisablesPCH :適応する non-unity な作業セットに含まれるファイルの強制インクルード PCH を無効にします。

$ bAdaptiveUnityDisablesProjectPCHForProjectPrivate :bAdaptiveUnityDisablesProjectPCH のベイキングストレージです。

$ bAdaptiveUnityCreatesDedicatedPCH :作業セット内のソースファイルごとに専用の PCH を作成することで、単純な cpp の変更のイテレーションを高速化します。

$ bAdaptiveUnityEnablesEditAndContinue :作業セット内のソースファイルごとに専用の PCH を作成することで、単純な cpp の変更のイテレーションを高速化します。

$ MinGameModuleSourceFilesForUnityBuild :unity ビルド前のゲームモジュール内のソースファイルの数は、そのモジュールに対してアクティブになります。これにより、小さなゲームモジュールでは、単一ファイルの反復コンパイル時間を短縮できますが、完全再ビルド時間は遅くなります。この設定は、モジュールの Build.cs ファイルの bFasterWithoutUnity オプションでオーバーライドできます。

$ UnsafeTypeCastWarningLevel :サポートしているプラットフォーム上で安全でないタイプのキャストとして処理する警告/エラーのレベルを表示します。(例： double->float or int64->int32)

$ bUndefinedIdentifierErrors :条件式で未定義の識別子を使用すると、強制的にエラーとして処理するようにします。

$ bUseFastMonoCalls :新しいモノリシックグラフィックスドライバには、各種 D3d 関数に代わる「fast calls」のオプションが付きました

$ bUseFastSemanticsRenderContexts :新しい Xbox ドライバは、「fast semantics」コンテキストタイプをサポートします。これにより、即時コンテキストと遅延コンテキストでこの機能がオンになります。Xbox RHI でレンダリングの問題やクラッシュが発生した場合は、この機能を無効にしてみてください。

$ NumIncludedBytesPerUnityCPP :単一の統合 C++ ファイルにインクルードする C++ コードの推定バイト数です。

$ bStressTestUnity :単一の統合ファイルからプロジェクトにすべての C++ ファイルをインクルードすることにより、C++ の unity ビルドの堅牢性をストレステストするかどうかを指定します。

$ bDisableDebugInfo :デバッグ情報の生成をグローバルに無効にするかどうかを指定します。構成単位、プラットフォーム固有のオプションは「DebugInfoHeuristics.cs」を参照してください。

$ bDisableDebugInfoForGeneratedCode :生成されたファイルのデバッグ情報の生成を無効にするかどうかを指定します。これにより、大量のグルーコードが生成されるモジュールのリンク時間が短縮されます。

$ bOmitPCDebugInfoInDevelopment :開発ビルド時に PC のデバッグ情報を無効にするかどうかを指定します (デバッグ情報を無効にするとリンク時間が非常に高速になるため、デベロッパーのイテレーションが高速になります)。

$ bUsePDBFiles :PDB ファイルを Visual C++ ビルドに使用するかどうかを指定します。

$ bUsePCHFiles :PCH ファイルを使用するかどうかを指定します。

$ MinFilesUsingPrecompiledHeader :作成および使用前にプリコンパイル済みヘッダの使用を必要とするファイルの最小数です。

$ bForcePrecompiledHeaderForGameModules :有効にすると、モジュール内のソースファイルの数が少ない場合でも、常にゲームモジュール用のプリコンパイル済みヘッダが生成されます。これにより、プロジェクト内のいくつかのファイルで繰り返し変更を行う際のコンパイル時間が大幅に短縮されますが、小さなゲームプロジェクトでは完全な再ビルドの時間が遅くなります。モジュールの Build.cs ファイルに MinFilesUsingPrecompiledHeaderOverride を指定すると、オーバーライドが可能になります。

$ bUseIncrementalLinking :インクリメンタルリンクを使用するかどうかを指定します。インクリメンタルリンクを使用すると、小さな変更を行うときのイテレーション時間を短縮できます。一部のコンピュータでは動作が不安定になる傾向があるため、現在はデフォルトで無効になっています (PDB 関連のコンパイルエラー)。

$ bAllowLTCG :リンク時コード生成 (LTCG) の使用を許可するかどうかを指定します。

$ bPGOProfile :このビルドで最適化のガイド付きプロファイル (PGO) を使用したインストールを有効にするかどうかを指定します。

$ bPGOOptimize :最適化のガイド付きプロファイル (PGO) を使用してこのビルドを最適化するかどうかを指定します。

$ bSupportEditAndContinue :編集をサポートし継続するかどうかを指定します。Microsoft コンパイラでのみ機能します。

$ bOmitFramePointers :フレームポインタを省略するかどうかを指定します。無効にすると、PC のメモリプロファイリングなど行う際に便利です。

$ bUseMallocProfiler :True にすると、ビルドのメモリプロファイリングが有効になります (USE_MALLOC_PROFILER=1 を定義し bOmitFramePointers=false を強制します)。

$ bUseSharedPCHs :「Shared PCHs」を有効にします。この機能は、PCH のヘッダファイルがインクルードされている UBT が検出したモジュール間で特定の PCH ファイルを共有しようとすることで、コンパイル時間を大幅に短縮します。

$ bUseShippingPhysXLibraries :開発ビルドおよびリリースビルドで PhysX/APEX のリリースコンフィギュレーションを使用する必要がある場合は true にします。

$ bUseCheckedPhysXLibraries :開発ビルドおよびリリースビルドで PhysX/APEX のチェック済み設定を使用する場合は true にします。bUseShippingPhysXLibraries が true の場合は無視されます。

$ bCheckLicenseViolations :現在ビルド中のモジュールが EULA に違反していないかをチェックするよう UBT に伝えます。

$ bBreakBuildOnLicenseViolation :現在ビルド中のモジュールが EULA に違反している場合、ビルドを中断するよう UBT に伝えます。

$ bUseFastPDBLinking :/DEBUG を使用してビルドし、Windows でローカル PDB を作成する場合、:FASTLINK オプションを使用するかどうかを指定します。高速ですが、デバッガでのシンボルの検索にまだ問題があるようです。

$ bCreateMapFile :ビルドの一部としてマップファイルを出力します。

$ bAllowRuntimeSymbolFiles :プラットフォームによってはポストビルドステップとしてランタイムシンボルファイルを生成すべきなら trueこれらのファイルは、ログにといてコールスタックバックとレースのシンボル名を解決するためにエンジンが使用します。

$ bCheckSystemHeadersForModification :無効のアクションと判断した場合、システムパスのヘッダ修正確認を行うかどうか指定します。

$ bFlushBuildDirOnRemoteMac :ビルド前にリモート Mac の「Builds」ディレクトリを消去するかどうかを指定します。

$ bPrintToolChainTimingInfo :コンパイラおよびリンカから詳細なタイミング情報を書き込むかどうかを指定します。

$ bParseTimingInfoForTracing :タイミングデータを chrome://tracing と互換性のあるトレースファイルにパースするかどうかを指定します。

$ bPublicSymbolsByDefault :POSIX プラットフォームでデフォルトでシンボルを非表示にするかどうかを指定します。

$ CppStandard :このターゲットのコンパイルに使用する C++ 標準です。

$ bStripSymbols :iOS シンボルを削除するかどうかを指定します (Shipping config によって暗黙的に指定)。

$ bEnableMemorySanitizer :メモリ差に間人 (MSan) を有効にします。

$ bIgnoreOutdatedImportLibraries :ターゲットをビルドするときに、期限切れのインポートライブラリファイルを無視するかどうかを指定します。イテレーション時間を短縮するには、true に設定します。依存関係にある「.lib」が 1 つしか変更されない場合、ターゲットの依存関係にあるヘッダファイルが変更されるまでインポートライブラリは実際に変更されないため、デフォルトではターゲットは再リンクされません。その場合、ターゲットは自動的に再ビルドされます

$ bPrintDebugInfo :デバッグ情報をコンソールに書き込むかどうかを指定します。

$ bLogDetailedActionStats :詳細なアクション統計をログに記録するかどうかを指定します。これにより、ローカルでの実行を強制します。

$ bAllowHybridExecutor :ハイブリッドエグゼキューター (リモートエグゼキューターとローカルエグゼキューター) を使用するかどうかを指定します。

$ bAllowXGE :XGE の使用許可について指定します。

$ bAllowFASTBuild :Whether FASTBuild を使用する場合があります。

$ bAllowSNDBS :SN-DBS の使用許可について指定します。

$ bUseUBTMakefiles :ターゲットデータをキャッシュして、非常に高速な反復ビルドのサポートを有効にします。このオプションを有効にすると、Unreal Build Tool の初回ビルド時にターゲットに対して「UBT Makefiles」をエクスポートします。以降のビルドでは、この Makefiles をロードして、期限切れのバージョンのチェックを開始した後、非常に迅速にビルド呼び出しをします。ただし、ソースファイルがプロジェクトに追加または削除された場合、UBT はビルドを正常に終了するためにこれらの情報を収集する必要があります。現在のソースファイルを追加または削除した後にプロジェクトファイルジェネレータを実行して、UBT にこの情報を再収集するようにしてください。 'UBT Makefile' を無効にできるイベント: .cpp フィアルの追加 / 削除 UObjects がある .h ファイルの追加 / 削除 既存の UObject 型がなかったファイルに Uobject 型を追加 グローバルビルド設定の変更 (このファイルのほとんどの設定に適しています) アンリアルヘッダツールの動作に影響するコードの変更 '-gather' 引数をパスする、あるいはプロジェクトファイルを単に再生成すれば、'UBT Makefile' の再生成を強制できます。 インクルードファイルの依存性のスキャンおよびキャッシュシステムの速度が上がり、アンリアルビルドツールは古いバージョンの依存性を非常に速く検出できるようになります。有効にすると、Deep C++ のインクルードグラフを生成する必要がなくなり、代わりに、依存ビルド後に間接インクルードをスキャンしてキャッシュするだけで、製品がすでに期限切れかどうかがわかります。次のビルドの間、これらのキャッシュされた間接インクルードをロードし、バージョンが古くないかをチェックをします。

$ bAllowDistcc :DMUCS/Distcc の使用許可について指定します。Distcc にはいくつかの設定が必要なため、デフォルトは無効になり、ローカルやリモートビルドが中断されることはありません。

$ bAllowParallelExecutor :Windows での並列エグゼキューターの使用許可について指定します。

$ MaxParallelActions :同時に実行できるアクションの数です。0 の場合、使用可能なコア数に基づいてデフォルトを拾います。ParallelExecutor のみに適用します。

HybridExecutor

$ MaxLocalActions :ローカルで実行できるアクションの最大数です。

BuildMode

$ bIgnoreJunk :ジャンクマニフェストで指定されたファイルのチェックをスキップするかどうかを指定します。

ProjectFileGenerator

$ DisablePlatformProjectGenerators :プロジェクトに対してネイティブプロジェクトファイルジェネレータを無効にします。ネイティブのプロジェクトファイルジェネレータを使用するプラットフォームでは、通常、IDE 拡張機能をインストールする必要があります。

$ Format :生成するプロジェクトファイル形式のデフォルトのリストです。

$ bGenerateIntelliSenseData :intellisense データを生成する場合は true にします (時間がかかります)

$ bIncludeDocumentation :生成されたプロジェクトにドキュメントをインクルードする場合は true にします。

$ bAllDocumentationLanguages :生成されたプロジェクトにすべてのドキュメント言語を含める場合は true、含めない場合は「INT」ファイルのみを含めます

$ bUsePrecompiled :ビルドターゲットが -useprecompiled 引数を渡す必要がある場合は true にします

$ bIncludeEngineSource :生成されたソリューションにエンジンソースをインクルードする場合は true にします

$ bIncludeEnterpriseSource :生成されるソリューションにエンタープライズソースをインクルードするかどうかを指定します

$ bIncludeShaderSource :シェーダソースファイルを生成されたプロジェクトにインクルードする場合は true にします

$ bIncludeBuildSystemFiles :ビルドシステムファイルをインクルードする場合は true にします

$ bIncludeConfigFiles :生成されたプロジェクトにコンフィグファイル (.ini) ファイルをインクルードする場合は true にします

$ bIncludeLocalizationFiles :生成されたプロジェクトにローカライゼーションファイルをインクルードする場合は true にします。

$ bIncludeTemplateFiles :生成されたプロジェクトにテンプレートファイルをインクルードする場合は true にします。

$ IncludeEnginePrograms :生成されたソリューションにドキュメントをインクルードする場合は true にします。

$ bIncludeTempTargets :デフォルト以外の設定のコンテンツのみのプロジェクトをサポートするために UAT で生成せされた一時的なターゲットを含むかどうかを指定します。

$ bIncludeDotNETCoreProjects :生成されたソリューションに .NET Core プロジェクトをインクルードする場合は true にします。

$ bKeepSourceSubDirectories :マスタープロジェクトのディスク上の "Source" サブディレクトリをマスタープロジェクトディレクトリとして反映する場合は true にします。これにより、マスタープロジェクトが可視性が低下しますが、ディスク上のファイル編成がより明確になります。

$ Platforms :生成されたプロジェクトファイルにインクルードするためのプラットフォーム名

$ Configurations :生成されたプロジェクトファイルにインクルードするコンフィギュレーションの名前です。有効なエントリについては UnrealTargetConfiguration を参照してください。

$ MasterProjectName :マスタープロジェクトファイルの名前です (例 : Visual Studio のソリューションファイルのベースファイル名、Mac の Xcode プロジェクトファイル)

$ bMasterProjectNameFromFolder :true の場合、マスタープロジェクトのフォルダ名に基づいてマスタープロジェクト名を設定します。

$ bIncludeTestAndShippingConfigs :生成されたプロジェクトに「Test」と「Shipping」の設定をインクルードするかどうかを指定します。これを無効にするには、「-NoShippingConfigs」を渡します。

LocalExecutor

$ ProcessorCountMultiplier :ローカル実行用のプロセッサカウント乗数です。1 より小さい値を指定すると、他のタスク用に CPU を予約できます。ローカルエグゼキューター (XGE 以外) を使用する場合は、各 CPU コアで単一のアクションを実行します。この値を大きくすると、多くの場合ビルド時間が少し速くなりますが、コンパイル中のコンピュータの応答性が大幅に低下する可能性があります。

$ MaxProcessorCount :ローカル実行用の最大プロセッサ数です。

ParallelExecutor

$ MaxProcessorCount :ローカル実行用の最大プロセッサ数です。

$ ProcessorCountMultiplier :ローカル実行用のプロセッサカウント乗数です。1 より小さい値を指定すると、他のタスク用に CPU を予約できます。

$ bStopCompilationAfterErrors :有効にすると、コンパイルエラーが発生した後にターゲットのコンパイルが停止されます。

XGE

$ bAllowOverVpn :false に有効にすると、コンパイルエラーが発生した後、XGE はターゲットのコンパイルを停止します。他のユーザーのコンピュータリソースを節約するため、このオプションをお勧めします。

$ VpnSubnets :VPN に割り当てられた IP アドレスを含むサブネットのリストです。

FASTBuild

$ FBuildExecutablePath :配布されたバイナリが使用されていない場合、fbuild.exe の場所を指定するために使用します。

$ bEnableDistribution :ネットワークビルドの配布を制御します。

$ FBuildBrokeragePath :仲介の場所を指定するために使用されます。null の場合、FASTBuild がフォールバックして FASTBUILD_BROKERAGE_PATH を確認します。

$ bEnableCaching :すべてにキャッシングを使うかどうかを指定します。これがオンの場合、CachePath と FASTCacheMode のみが関係します。

$ CacheMode :キャッシュアクセスモード - bEnableCaching が true の場合のみ関係します。

$ FBuildCachePath :キャッシュの位置を指定するために使用されます。null の場合、FASTBuild がフォールバックして FASTBUILD_CACHE_PATH を確認します。

$ bForceRemote :リモートを強制するかどうかを指定します。

$ bStopOnError :エラーで停止するかどうかを指定します。

$ MsvcCRTRedistVersion :使用する MSVC CRT Redist のバージョンを指定します。

CLionGenerator