Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig Class Reference

TargetRules is a data structure that contains the rules for defining a target (application/executable) More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig:
Nuke.Unreal.Tools.ToolConfig

Public Member Functions

virtual TargetRulesConfig AllModules (bool? val=null)
 Build all the modules that are valid for this target type. Used for CIS and making installed engine builds.
 
virtual TargetRulesConfig BuildPlugin (params object[] values)
 Additional plugins that are built for this target type but not enabled.
 
virtual TargetRulesConfig EnablePlugin (params object[] values)
 Additional plugins that should be included for this target.
 
virtual TargetRulesConfig DisablePlugin (params object[] values)
 List of plugins to be disabled for this target. Note that the project file may still reference them, so they should be marked as optional to avoid failing to find them at runtime.
 
virtual TargetRulesConfig CompileAsDll (bool? val=null)
 Whether this target should be compiled as a DLL. Requires LinkType to be set to TargetLinkType.Monolithic.
 
virtual TargetRulesConfig NoCompileChaos (bool present=true)
 Whether to compile the Chaos physics plugin.
 
virtual TargetRulesConfig CompileChaos (bool present=true)
 Whether to compile the Chaos physics plugin.
 
virtual TargetRulesConfig NoUseChaos (bool present=true)
 Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.
 
virtual TargetRulesConfig UseChaos (bool present=true)
 Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.
 
virtual TargetRulesConfig Rtti (bool? val=null)
 Enable RTTI for all modules.
 
virtual TargetRulesConfig IWYU (bool? val=null)
 Enables "include what you use" by default for modules in this target. Changes the default PCH mode for any module in this project to PCHUsageMode.UseExplicitOrSharedPCHs. Enables "include what you use" mode.
 
virtual TargetRulesConfig Precompile (bool? val=null)
 Make static libraries for all engine modules as intermediates for this target.
 
virtual TargetRulesConfig DisableUnity (bool present=true)
 Whether to unify C++ code into larger files for faster compilation.
 
virtual TargetRulesConfig ForceUnity (bool? val=null)
 Whether to force C++ source files to be combined into larger files for faster compilation.
 
virtual TargetRulesConfig ShadowVariableErrors (WarningLevel? val=null)
 Forces shadow variable warnings to be treated as errors on platforms that support it. Forces shadow variable warnings to be treated as errors on platforms that support it. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4456 4456 - declaration of 'LocalVariable' hides previous local declaration https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4458 4458 - declaration of 'parameter' hides class member https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4459 4459 - declaration of 'LocalVariable' hides global declaration Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wshadow.
 
virtual TargetRulesConfig FastMonoCalls (bool present=true)
 New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.
 
virtual TargetRulesConfig NoFastMonoCalls (bool present=true)
 New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.
 
virtual TargetRulesConfig StressTestUnity (bool? val=null)
 Whether to stress test the C++ unity build robustness by including all C++ files files in a project from a single unified file.
 
virtual TargetRulesConfig ForceDebugInfo (bool? val=null)
 Whether to force debug info to be generated.
 
virtual TargetRulesConfig NoDebugInfo (bool? val=null)
 Whether to globally disable debug info generation; see DebugInfoHeuristics.cs for per-config and per-platform options. How much debug info should be generated. See DebugInfoMode enum for more details.
 
virtual TargetRulesConfig NoPDB (bool present=true)
 Whether PDB files should be used for Visual C++ builds.
 
virtual TargetRulesConfig NoPCH (bool present=true)
 Whether PCH files should be used.
 
virtual TargetRulesConfig Preprocess (bool? val=null)
 Whether to just preprocess source files for this target, and skip compilation.
 
virtual TargetRulesConfig IncrementalLinking (bool? val=null)
 Whether to use incremental linking or not. Incremental linking can yield faster iteration times when making small changes. Currently disabled by default because it tends to behave a bit buggy on some computers (PDB-related compile errors).
 
virtual TargetRulesConfig NoIncrementalLinking (bool present=true)
 Whether to use incremental linking or not. Incremental linking can yield faster iteration times when making small changes. Currently disabled by default because it tends to behave a bit buggy on some computers (PDB-related compile errors).
 
virtual TargetRulesConfig LTCG (bool? val=null)
 Whether to allow the use of link time code generation (LTCG).
 
virtual TargetRulesConfig PGOProfile (bool present=true)
 Whether to enable Profile Guided Optimization (PGO) instrumentation in this build.
 
virtual TargetRulesConfig PGOOptimize (bool present=true)
 Whether to optimize this build with Profile Guided Optimization (PGO).
 
virtual TargetRulesConfig NoSharedPCH (bool present=true)
 Enables "Shared PCHs", a feature which significantly speeds up compile times by attempting to share certain PCH files between modules that UBT detects is including those PCH's header files.
 
virtual TargetRulesConfig FastPDB (bool? val=null)
 Whether to use the :FASTLINK option when building with /DEBUG to create local PDBs on Windows. Fast, but currently seems to have problems finding symbols in the debugger.
 
virtual TargetRulesConfig MapFile (bool? val=null)
 Outputs a map file as part of the build.
 
virtual TargetRulesConfig BundleVersion (object val=null)
 Bundle version for Mac apps.
 
virtual TargetRulesConfig Deploy (bool? val=null)
 Whether to deploy the executable after compilation on platforms that require deployment.
 
virtual TargetRulesConfig SkipDeploy (bool? val=null)
 Whether to force skipping deployment for platforms that require deployment by default.
 
virtual TargetRulesConfig NoLink (bool? val=null)
 Whether to disable linking for this target.
 
virtual TargetRulesConfig Formal (bool? val=null)
 Indicates that this is a formal build, intended for distribution. This flag is automatically set to true when Build.version has a changelist set. The only behavior currently bound to this flag is to compile the default resource file separately for each binary so that the OriginalFilename field is set correctly. By default, we only compile the resource once to reduce build times. Indicates that this is a formal build, intended for distribution. This flag is automatically set to true when Build.version has a changelist set and is a promoted build. The only behavior currently bound to this flag is to compile the default resource file separately for each binary so that the OriginalFilename field is set correctly. By default, we only compile the resource once to reduce build times.
 
virtual TargetRulesConfig FlushMac (bool? val=null)
 Whether to clean Builds directory on a remote Mac before building.
 
virtual TargetRulesConfig Timing (bool? val=null)
 Whether to write detailed timing info from the compiler and linker.
 
virtual TargetRulesConfig Tracing (bool? val=null)
 Whether to parse timing data into a tracing file compatible with chrome://tracing.
 
virtual TargetRulesConfig PublicSymbolsByDefault (bool? val=null)
 Whether to expose all symbols as public by default on POSIX platforms.
 
virtual TargetRulesConfig ToolChain (object val=null)
 Allows overriding the toolchain to be created for this target. This must match the name of a class declared in the UnrealBuildTool assembly.
 
virtual TargetRulesConfig CppStd (CppStandardVersion? val=null)
 Which C++ stanard to use for compiling this target Which C++ standard to use for compiling this target (for non-engine modules)
 
virtual TargetRulesConfig NoManifestChanges (bool? val=null)
 Do not allow manifest changes when building this target. Used to cause earlier errors when building multiple targets with a shared build environment.
 
virtual TargetRulesConfig BuildVersion (object val=null)
 The build version string.
 
virtual TargetRulesConfig Monolithic (bool present=true)
 Backing storage for the LinkType property.
 
virtual TargetRulesConfig Modular (bool present=true)
 Backing storage for the LinkType property.
 
virtual TargetRulesConfig Define (params object[] values)
 Macros to define globally across the whole target.
 
virtual TargetRulesConfig ProjectDefine (params object[] values)
 Macros to define across all macros in the project.
 
virtual TargetRulesConfig Manifest (params object[] values)
 Path to a manifest to output for this target.
 
virtual TargetRulesConfig DependencyList (params object[] values)
 Path to a list of dependencies for this target, when precompiling.
 
virtual TargetRulesConfig SharedBuildEnvironment (bool present=true)
 Backing storage for the BuildEnvironment property.
 
virtual TargetRulesConfig UniqueBuildEnvironment (bool present=true)
 Backing storage for the BuildEnvironment property.
 
virtual TargetRulesConfig OverrideBuildEnvironment (bool? val=null)
 Whether to ignore violations to the shared build environment (eg. editor targets modifying definitions)
 
virtual TargetRulesConfig CompilerArguments (object val=null)
 Additional arguments to pass to the compiler.
 
virtual TargetRulesConfig LinkerArguments (object val=null)
 Additional arguments to pass to the linker.
 
virtual TargetRulesConfig NoUseVerse (bool present=true)
 Whether to use the verse script interface.
 
virtual TargetRulesConfig UseVerse (bool present=true)
 Whether to use the verse script interface.
 
virtual TargetRulesConfig DisableAdaptiveUnity (bool present=true)
 Use a heuristic to determine which files are currently being iterated on and exclude them from unity blobs, result in faster incremental compile times. The current implementation uses the read-only flag to distinguish the working set, assuming that files will be made writable by the source control system if they are being modified. This is true for Perforce, but not for Git. Use a heuristic to determine which files are currently being iterated on and exclude them from unity blobs. This results in faster incremental compile times. For Perforce repositories, the current implementation uses the read-only flag to distinguish the working set, assuming that files will be made writable by the source control system if they are being modified. For Git repositories, the implementation uses the git status command. Source code archives downloaded from Git as .zip files are not supported.
 
virtual TargetRulesConfig WarningsAsErrors (bool? val=null)
 Whether to enable all warnings as errors. UE enables most warnings as errors already, but disables a few (such as deprecation warnings). Treat warnings as errors.
 
virtual TargetRulesConfig ThinLTO (bool? val=null)
 When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.
 
virtual TargetRulesConfig TargetNameOverride (object val=null)
 Override the name used for this target.
 
virtual TargetRulesConfig ForceIncludeOrder (EngineIncludeOrderVersion? val=null)
 Force the include order to a specific version. Overrides any Target and Module rules.
 
virtual TargetRulesConfig NoUseIris (bool present=true)
 Whether to use Iris.
 
virtual TargetRulesConfig UseIris (bool present=true)
 Whether to use Iris.
 
virtual TargetRulesConfig TrustedServer (bool present=true)
 
virtual TargetRulesConfig NoTrustedServer (bool present=true)
 
virtual TargetRulesConfig DisableMergingUnityFiles (bool present=true)
 Whether to merge module and generated unity files for faster compilation.
 
virtual TargetRulesConfig RetainFramePointers (bool present=true)
 Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.
 
virtual TargetRulesConfig NoRetainFramePointers (bool present=true)
 Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.
 
virtual TargetRulesConfig BytesPerUnityCPP (double? val=null)
 An approximate number of bytes of C++ code to target for inclusion in a single unified C++ file.
 
virtual TargetRulesConfig DetailedUnityFiles (bool present=true)
 Whether to add additional information to the unity files, such as '_of_X' in the file name. Whether to add additional information to the unity files, such as '_of_X' in the file name. Not recommended.
 
virtual TargetRulesConfig NoDetailedUnityFiles (bool present=true)
 Whether to add additional information to the unity files, such as '_of_X' in the file name. Whether to add additional information to the unity files, such as '_of_X' in the file name. Not recommended.
 
virtual TargetRulesConfig Deterministic (bool? val=null)
 Force set flags require for determinstic compiling and linking (experimental, may not be fully supported). This setting is only recommended for testing, instead:
 
virtual TargetRulesConfig PreprocessDepends (bool? val=null)
 Generate dependency files by preprocessing. This is only recommended when distributing builds as it adds additional overhead.
 
virtual TargetRulesConfig StaticAnalyzer (StaticAnalyzer? val=null)
 Whether static code analysis should be enabled. The static analyzer to use.
 
virtual TargetRulesConfig StaticAnalyzerOutputType (StaticAnalyzerOutputType? val=null)
 The output type to use for the static analyzer. This is only supported for Clang.
 
virtual TargetRulesConfig StaticAnalyzerMode (StaticAnalyzerMode? val=null)
 The mode to use for the static analyzer. This is only supported for Clang. Shallow mode completes quicker but is generally not recommended.
 
virtual TargetRulesConfig PackagePath (object val=null)
 Package full path (directory + filename) where to store input files used at link time Normally used to debug a linker crash for platforms that support it.
 
virtual TargetRulesConfig CrashDiagnosticDirectory (object val=null)
 Directory where to put crash report files for platforms that support it.
 
virtual TargetRulesConfig DisableInliningGenCpps (bool? val=null)
 Disable supports for inlining gen.cpps.
 
virtual TargetRulesConfig CStd (CStandardVersion? val=null)
 Which C standard to use for compiling this target.
 
virtual TargetRulesConfig Pie (bool? val=null)
 Enable Position Independent Executable (PIE). Has an overhead cost.
 
virtual TargetRulesConfig StackProtect (bool? val=null)
 Enable Stack Protection. Has an overhead cost.
 
virtual TargetRulesConfig OptimizationLevel (OptimizationMode? val=null)
 Allows to fine tune optimizations level for speed and\or code size.
 
virtual TargetRulesConfig IWYUHeadersOnly (bool? val=null)
 Tells "include what you use" to only compile header files.
 
virtual TargetRulesConfig DisableModuleNumIncludedBytesPerUnityCPPOverride (bool present=true)
 Disables overrides that are set by the module.
 
virtual TargetRulesConfig ThinLTOCacheDirectory (object val=null)
 Directory where to put the ThinLTO cache on supported platforms.
 
virtual TargetRulesConfig ThinLTOCachePruningArguments (object val=null)
 Arguments that will be applied to prune the ThinLTO cache on supported platforms. Arguments will only be applied if ThinLTOCacheDirectory is set.
 
virtual TargetRulesConfig IncludeHeaders (bool? val=null)
 Adds header files in included modules to the build.
 
virtual TargetRulesConfig NonDeterministic (bool present=true)
 Set flags require for deterministic compiling and linking. Enabling deterministic mode for msvc disables codegen multithreading so compiling will be slower.
 
virtual TargetRulesConfig CppStdEngine (CppStandardVersion? val=null)
 Which C++ standard to use for compiling this target (for engine modules)
 
virtual TargetRulesConfig NoUseAutoRTFM (bool present=true)
 Whether to use the AutoRTFM Clang compiler. Whether to use force AutoRTFM Clang compiler off.
 
virtual TargetRulesConfig UseAutoRTFM (bool present=true)
 Whether to use the AutoRTFM Clang compiler.
 
virtual TargetRulesConfig CompileChaosVisualDebuggerSupport (bool? val=null)
 Whether to compile in Chaos Visual Debugger (CVD) support features to record the state of the physics simulation.
 
virtual TargetRulesConfig HeadersOnly (bool? val=null)
 When used with -IncludeHeaders, only header files will be compiled.
 
virtual TargetRulesConfig PCHPerformanceIssueWarningLevel (WarningLevel? val=null)
 Indicates what warning/error level to treat potential PCH performance issues.
 
virtual TargetRulesConfig ModuleIncludePathWarningLevel (WarningLevel? val=null)
 How to treat general module include path validation messages.
 
virtual TargetRulesConfig ModuleIncludePrivateWarningLevel (WarningLevel? val=null)
 How to treat private module include path validation messages, where a module is adding an include path that exposes private headers.
 
virtual TargetRulesConfig ModuleIncludeSubdirectoryWarningLevel (WarningLevel? val=null)
 How to treat unnecessary module sub-directory include path validation messages.
 
virtual TargetRulesConfig UsePDB (bool present=true)
 Whether PDB files should be used for Visual C++ builds.
 
virtual TargetRulesConfig NoPCHChain (bool present=true)
 Whether PCHs should be chained when compiling with clang.
 
virtual TargetRulesConfig WithAssembly (bool? val=null)
 Whether to generate assembly data while compiling this target. Works exclusively on MSVC for now.
 
virtual TargetRulesConfig CodeCoverage (bool present=true)
 Whether the target requires code coverage compilation and linking.
 
virtual TargetRulesConfig SupportEditAndContinue (bool? val=null)
 Whether to support edit and continue.
 
virtual TargetRulesConfig MinCpuArchX64 (MinimumCpuArchitectureX64? val=null)
 Direct the compiler to generate AVX instructions wherever SSE or AVX intrinsics are used, on the x64 platforms that support it. Note that by enabling this you are changing the minspec for the PC platform, and the resultant executable will crash on machines without AVX support. Direct the compiler to generate AVX instructions wherever SSE or AVX intrinsics are used, on the x64 platforms that support it. Ignored for arm64. Note that by enabling this you are changing the minspec for the target platform, and the resultant executable will crash on machines without AVX support.
 
virtual TargetRulesConfig CustomConfig (object val=null)
 Extra subdirectory to load config files out of, for making multiple types of builds with the same platform This will get baked into the game executable as CUSTOM_CONFIG and used when staging to filter files and settings.
 
virtual TargetRulesConfig NoUseVerseBPVM (bool present=true)
 Whether to use the BPVM to run Verse.
 
virtual TargetRulesConfig UseVerseBPVM (bool present=true)
 Whether to use the BPVM to run Verse.
 
virtual TargetRulesConfig FPSemantics (FPSemanticsMode? val=null)
 Allows setting the FP semantics.
 
virtual TargetRulesConfig DebugInfo (DebugInfoMode? val=null)
 How much debug info should be generated. See DebugInfoMode enum for more details.
 
virtual TargetRulesConfig DisableDebugInfoModules (params object[] values)
 Modules that should have debug info disabled.
 
virtual TargetRulesConfig DisableDebugInfoPlugins (params object[] values)
 Plugins that should have debug info disabled.
 
virtual TargetRulesConfig DebugInfoLineTablesOnly (DebugInfoMode? val=null)
 True if only debug line number tables should be emitted in debug information for compilers that support doing so. Overrides TargetRules.DebugInfo See https://clang.llvm.org/docs/UsersManual.html#cmdoption-gline-tables-only for more information.
 
virtual TargetRulesConfig DebugInfoLineTablesOnlyModules (params object[] values)
 Modules that should emit line number tables instead of full debug information for compilers that support doing so. Overrides DisableDebugInfoModules.
 
virtual TargetRulesConfig DebugInfoLineTablesOnlyPlugins (params object[] values)
 Plugins that should emit line number tables instead of full debug information for compilers that support doing so. Overrides DisableDebugInfoPlugins.
 
virtual TargetRulesConfig StaticAnalyzerPVSPrintLevel (double? val=null)
 The level of warnings to print when analyzing using PVS-Studio.
 
virtual TargetRulesConfig StaticAnalyzerProjectOnly (bool? val=null)
 Only run static analysis against project modules, skipping engine modules.
 
virtual TargetRulesConfig StaticAnalyzerIncludeGenerated (bool? val=null)
 When enabled, generated source files will be analyzed.
 
virtual TargetRulesConfig HeaderUnits (bool? val=null)
 Will replace pch with ifc and use header units instead. This is an experimental and msvc-only feature.
 
virtual TargetRulesConfig AdditionalPlugins (params object[] values)
 A list of additional plugins which need to be included in this target. This allows referencing non-optional plugin modules which cannot be disabled, and allows building against specific modules in program targets which do not fit the categories in ModuleHostType.
 
virtual TargetRulesConfig OptionalPlugins (params object[] values)
 Additional plugins that should be included for this target if they are found.
 
virtual TargetRulesConfig UseAutoRTFMVerifier (bool present=true)
 Whether to enable emitting AutoRTFM verification metadata.
 
virtual TargetRulesConfig CompileIoStoreOnDemand (bool present=true)
 Whether to use I/O store on-demand.
 
virtual TargetRulesConfig UndefinedIdentifierWarningLevel (WarningLevel? val=null)
 Indicates what warning/error level to treat undefined identifiers in conditional expressions. Indicates what warning/error level to treat undefined identifiers in conditional expressions. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4668 4668 - 'symbol' is not defined as a preprocessor macro, replacing with '0' for 'directives' 44668 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wundef.
 
virtual TargetRulesConfig UBAStoreObjFilesCompressed (bool present=true)
 Experimental: Store object (.obj) compressed on disk. Requires UBA to link, currently MSVC only. Toggling this flag will invalidate MSVC actions. Warning, this option is not currently compatitable with PGO or the the cl-clang linker as those are not detoured and linking will fail. Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
 
virtual TargetRulesConfig StripExports (bool? val=null)
 Experimental: Strip unused exports from libraries. Only applies when LinkType is Modular.
 
virtual TargetRulesConfig MergeModules (bool? val=null)
 Experimental: Merge modular modules into combined libraries. Sets LinkType to Modular and enables bStripExports.
 
virtual TargetRulesConfig MergePlugins (params object[] values)
 Experimental: List of plugins (and their dependencies) to each merge into separate libraries. Requires bMergeModules to be enabled.
 
virtual TargetRulesConfig ShowIncludes (bool? val=null)
 Print out files that are included by each source file.
 
virtual TargetRulesConfig AutoRTFMVerify (bool present=true)
 Whether to run LLVM verification after the AutoRTFM compiler pass. This is used by our compiler folks to ensure the pass works with the various code-paths UBT can take us down.
 
virtual TargetRulesConfig AutoRTFMClosedStaticLinkage (bool present=true)
 Whether to link closed function declarations statically.
 
virtual TargetRulesConfig VFS (bool present=true)
 Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.
 
virtual TargetRulesConfig NoVFS (bool present=true)
 Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.
 
virtual TargetRulesConfig MinArm64CpuTarget (Arm64TargetCpuType? val=null)
 Select a minimum ARM64 target CPU. This will change what ARMv8(9)-A ISA + extension code will be compiled for. Changing it from default will guarantee not to work on all ARM64 CPUs. Currently supported by clang compiler only.
 
virtual TargetRulesConfig MergePluginsIgnored (params object[] values)
 Experimental: List of plugins (and their dependencies) to ignore when processing merged libraries. Requires bMergeModules to be enabled Ignored plugins will still be compiled, but if they're kept in the base executable, their dependencies will not be forced out of merged library with them. This should be used carefully, for organisational plugins known to have dependencies they don't actually need at runtime.
 
virtual TargetRulesConfig BinariesSubfolder (object val=null)
 Subfolder to place executables in, relative to the default location.
 
virtual TargetRulesConfig DebugInfoNoInlineLineTables (DebugInfoMode? val=null)
 True if debug line number tables should be omitted in debug information for inline functions, compilers that support doing so.
 
virtual TargetRulesConfig DebugInfoInlineLineTablesModules (params object[] values)
 Modules that should include line number tables for inline functions for compilers that support doing so, even if DebugInfoNoInlineLineTables would otherwise remove them.
 
virtual TargetRulesConfig DebugInfoInlineLineTablesPlugins (params object[] values)
 Modules that should include line number tables for inline functions for compilers that support doing so, even if DebugInfoNoInlineLineTables would otherwise remove them.
 
virtual TargetRulesConfig DebugInfoSimpleTemplateNames (DebugInfoMode? val=null)
 True if template type names should be simplified to reduce the size of debug info for compilers that support doing so.
 
virtual TargetRulesConfig DebugInfoSimpleTemplateNamesModules (params object[] values)
 Modules for which template type names should be simplified to reduce the size of debug info for compilers that support doing so.
 
virtual TargetRulesConfig DebugInfoSimpleTemplateNamesPlugins (params object[] values)
 Plugins for which template type names should be simplified to reduce the size of debug info for compilers that support doing so.
 
virtual TargetRulesConfig CacheSalt (object val=null)
 Salt value to modify cache bucket calculation, can be used to invalidate cached actions outputs.
 
virtual TargetRulesConfig NoThinLTO (bool present=true)
 When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.
 
virtual TargetRulesConfig ThinLTODistributed (bool? val=null)
 When ThinLTO is enabled we use distributed linking if supported This can save a lot of time for large binaries.
 
virtual TargetRulesConfig MergeAdditionalCommonModules (params object[] values)
 Experimental: List of modules to exclude from Engine to be placed in Common.
 
virtual TargetRulesConfig MergePluginsExcluded (params object[] values)
 Experimental: List of plugins (and their dependencies) to explicitly exclude when processing merged libraries. Requires bMergeModules to be enabled Ignored plugins will still be compiled but forced into the executable.
 
virtual TargetRulesConfig MergeModulesReport (bool? val=null)
 Experimental: Whether to report module merging data to the game target.
 
- Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void AppendArgument (UnrealToolArgument arg)
 
virtual void AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)
 
virtual void AppendSubtool (ToolConfig subtool)
 
virtual string Gather (EngineVersion ueVersion)
 Gether the arguments and subtools and render a command line output.
 

Properties

override string Name [get]
 
override string CliName [get]
 
override UnrealCompatibility Compatibility [get]
 
override ToolConfig[] Configs [get]
 
- Properties inherited from Nuke.Unreal.Tools.ToolConfig
string Name [get]
 The C# friendly name of the tool which will be used inside configurators.
 
string CliName [get]
 The name which will be rendered onto command line.
 
UnrealCompatibility Compatibility [get]
 Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.
 
virtual ToolConfig[] Configs [get]
 

Private Attributes

ToolConfig[] _configs = null
 

Additional Inherited Members

- Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgumentUsingArguments = []
 
readonly Dictionary< string, ToolConfigUsingSubtools = []
 

Detailed Description

TargetRules is a data structure that contains the rules for defining a target (application/executable)

Definition at line 10417 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ AdditionalPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.AdditionalPlugins ( params object[] values)
virtual

A list of additional plugins which need to be included in this target. This allows referencing non-optional plugin modules which cannot be disabled, and allows building against specific modules in program targets which do not fit the categories in ModuleHostType.

Definition at line 12962 of file UbtConfigGenerated.cs.

◆ AllModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.AllModules ( bool? val = null)
virtual

Build all the modules that are valid for this target type. Used for CIS and making installed engine builds.

Definition at line 10426 of file UbtConfigGenerated.cs.

◆ AutoRTFMClosedStaticLinkage()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.AutoRTFMClosedStaticLinkage ( bool present = true)
virtual

Whether to link closed function declarations statically.

Definition at line 13200 of file UbtConfigGenerated.cs.

◆ AutoRTFMVerify()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.AutoRTFMVerify ( bool present = true)
virtual

Whether to run LLVM verification after the AutoRTFM compiler pass. This is used by our compiler folks to ensure the pass works with the various code-paths UBT can take us down.

Definition at line 13179 of file UbtConfigGenerated.cs.

◆ BinariesSubfolder()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.BinariesSubfolder ( object val = null)
virtual

Subfolder to place executables in, relative to the default location.

Definition at line 13309 of file UbtConfigGenerated.cs.

◆ BuildPlugin()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.BuildPlugin ( params object[] values)
virtual

Additional plugins that are built for this target type but not enabled.

Definition at line 10447 of file UbtConfigGenerated.cs.

◆ BuildVersion()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.BuildVersion ( object val = null)
virtual

The build version string.

Definition at line 11341 of file UbtConfigGenerated.cs.

◆ BundleVersion()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.BundleVersion ( object val = null)
virtual

Bundle version for Mac apps.

Definition at line 11087 of file UbtConfigGenerated.cs.

◆ BytesPerUnityCPP()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.BytesPerUnityCPP ( double? val = null)
virtual

An approximate number of bytes of C++ code to target for inclusion in a single unified C++ file.

Definition at line 11903 of file UbtConfigGenerated.cs.

◆ CacheSalt()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CacheSalt ( object val = null)
virtual

Salt value to modify cache bucket calculation, can be used to invalidate cached actions outputs.

Definition at line 13456 of file UbtConfigGenerated.cs.

◆ CodeCoverage()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CodeCoverage ( bool present = true)
virtual

Whether the target requires code coverage compilation and linking.

Definition at line 12599 of file UbtConfigGenerated.cs.

◆ CompileAsDll()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CompileAsDll ( bool? val = null)
virtual

Whether this target should be compiled as a DLL. Requires LinkType to be set to TargetLinkType.Monolithic.

Definition at line 10511 of file UbtConfigGenerated.cs.

◆ CompileChaos()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CompileChaos ( bool present = true)
virtual

Whether to compile the Chaos physics plugin.

Definition at line 10553 of file UbtConfigGenerated.cs.

◆ CompileChaosVisualDebuggerSupport()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CompileChaosVisualDebuggerSupport ( bool? val = null)
virtual

Whether to compile in Chaos Visual Debugger (CVD) support features to record the state of the physics simulation.

Definition at line 12410 of file UbtConfigGenerated.cs.

◆ CompileIoStoreOnDemand()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CompileIoStoreOnDemand ( bool present = true)
virtual

Whether to use I/O store on-demand.

Definition at line 13025 of file UbtConfigGenerated.cs.

◆ CompilerArguments()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CompilerArguments ( object val = null)
virtual

Additional arguments to pass to the compiler.

Definition at line 11567 of file UbtConfigGenerated.cs.

◆ CppStd()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CppStd ( CppStandardVersion? val = null)
virtual

Which C++ stanard to use for compiling this target Which C++ standard to use for compiling this target (for non-engine modules)

Definition at line 11299 of file UbtConfigGenerated.cs.

◆ CppStdEngine()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CppStdEngine ( CppStandardVersion? val = null)
virtual

Which C++ standard to use for compiling this target (for engine modules)

Definition at line 12348 of file UbtConfigGenerated.cs.

◆ CrashDiagnosticDirectory()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CrashDiagnosticDirectory ( object val = null)
virtual

Directory where to put crash report files for platforms that support it.

Definition at line 12094 of file UbtConfigGenerated.cs.

◆ CStd()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CStd ( CStandardVersion? val = null)
virtual

Which C standard to use for compiling this target.

Definition at line 12136 of file UbtConfigGenerated.cs.

◆ CustomConfig()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CustomConfig ( object val = null)
virtual

Extra subdirectory to load config files out of, for making multiple types of builds with the same platform This will get baked into the game executable as CUSTOM_CONFIG and used when staging to filter files and settings.

Definition at line 12664 of file UbtConfigGenerated.cs.

◆ DebugInfo()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfo ( DebugInfoMode? val = null)
virtual

How much debug info should be generated. See DebugInfoMode enum for more details.

Definition at line 12748 of file UbtConfigGenerated.cs.

◆ DebugInfoInlineLineTablesModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoInlineLineTablesModules ( params object[] values)
virtual

Modules that should include line number tables for inline functions for compilers that support doing so, even if DebugInfoNoInlineLineTables would otherwise remove them.

Definition at line 13351 of file UbtConfigGenerated.cs.

◆ DebugInfoInlineLineTablesPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoInlineLineTablesPlugins ( params object[] values)
virtual

Modules that should include line number tables for inline functions for compilers that support doing so, even if DebugInfoNoInlineLineTables would otherwise remove them.

Definition at line 13372 of file UbtConfigGenerated.cs.

◆ DebugInfoLineTablesOnly()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoLineTablesOnly ( DebugInfoMode? val = null)
virtual

True if only debug line number tables should be emitted in debug information for compilers that support doing so. Overrides TargetRules.DebugInfo See https://clang.llvm.org/docs/UsersManual.html#cmdoption-gline-tables-only for more information.

Definition at line 12812 of file UbtConfigGenerated.cs.

◆ DebugInfoLineTablesOnlyModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoLineTablesOnlyModules ( params object[] values)
virtual

Modules that should emit line number tables instead of full debug information for compilers that support doing so. Overrides DisableDebugInfoModules.

Definition at line 12833 of file UbtConfigGenerated.cs.

◆ DebugInfoLineTablesOnlyPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoLineTablesOnlyPlugins ( params object[] values)
virtual

Plugins that should emit line number tables instead of full debug information for compilers that support doing so. Overrides DisableDebugInfoPlugins.

Definition at line 12854 of file UbtConfigGenerated.cs.

◆ DebugInfoNoInlineLineTables()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoNoInlineLineTables ( DebugInfoMode? val = null)
virtual

True if debug line number tables should be omitted in debug information for inline functions, compilers that support doing so.

Definition at line 13330 of file UbtConfigGenerated.cs.

◆ DebugInfoSimpleTemplateNames()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoSimpleTemplateNames ( DebugInfoMode? val = null)
virtual

True if template type names should be simplified to reduce the size of debug info for compilers that support doing so.

Definition at line 13393 of file UbtConfigGenerated.cs.

◆ DebugInfoSimpleTemplateNamesModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoSimpleTemplateNamesModules ( params object[] values)
virtual

Modules for which template type names should be simplified to reduce the size of debug info for compilers that support doing so.

Definition at line 13414 of file UbtConfigGenerated.cs.

◆ DebugInfoSimpleTemplateNamesPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DebugInfoSimpleTemplateNamesPlugins ( params object[] values)
virtual

Plugins for which template type names should be simplified to reduce the size of debug info for compilers that support doing so.

Definition at line 13435 of file UbtConfigGenerated.cs.

◆ Define()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Define ( params object[] values)
virtual

Macros to define globally across the whole target.

Definition at line 11404 of file UbtConfigGenerated.cs.

◆ DependencyList()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DependencyList ( params object[] values)
virtual

Path to a list of dependencies for this target, when precompiling.

Definition at line 11479 of file UbtConfigGenerated.cs.

◆ Deploy()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Deploy ( bool? val = null)
virtual

Whether to deploy the executable after compilation on platforms that require deployment.

Definition at line 11108 of file UbtConfigGenerated.cs.

◆ DetailedUnityFiles()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DetailedUnityFiles ( bool present = true)
virtual

Whether to add additional information to the unity files, such as '_of_X' in the file name. Whether to add additional information to the unity files, such as '_of_X' in the file name. Not recommended.

Definition at line 11923 of file UbtConfigGenerated.cs.

◆ Deterministic()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Deterministic ( bool? val = null)
virtual

Force set flags require for determinstic compiling and linking (experimental, may not be fully supported). This setting is only recommended for testing, instead:

  • Set bDeterministic on a per module basis in ModuleRules to control deterministic compiling.
  • Set bDeterministic on a per target basis in TargetRules to control deterministic linking. Set flags require for deterministic compiling and linking. Enabling deterministic mode for msvc disables codegen multithreading so compiling will be slower

Definition at line 11967 of file UbtConfigGenerated.cs.

◆ DisableAdaptiveUnity()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableAdaptiveUnity ( bool present = true)
virtual

Use a heuristic to determine which files are currently being iterated on and exclude them from unity blobs, result in faster incremental compile times. The current implementation uses the read-only flag to distinguish the working set, assuming that files will be made writable by the source control system if they are being modified. This is true for Perforce, but not for Git. Use a heuristic to determine which files are currently being iterated on and exclude them from unity blobs. This results in faster incremental compile times. For Perforce repositories, the current implementation uses the read-only flag to distinguish the working set, assuming that files will be made writable by the source control system if they are being modified. For Git repositories, the implementation uses the git status command. Source code archives downloaded from Git as .zip files are not supported.

Definition at line 11655 of file UbtConfigGenerated.cs.

◆ DisableDebugInfoModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableDebugInfoModules ( params object[] values)
virtual

Modules that should have debug info disabled.

Definition at line 12769 of file UbtConfigGenerated.cs.

◆ DisableDebugInfoPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableDebugInfoPlugins ( params object[] values)
virtual

Plugins that should have debug info disabled.

Definition at line 12790 of file UbtConfigGenerated.cs.

◆ DisableInliningGenCpps()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableInliningGenCpps ( bool? val = null)
virtual

Disable supports for inlining gen.cpps.

Definition at line 12115 of file UbtConfigGenerated.cs.

◆ DisableMergingUnityFiles()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableMergingUnityFiles ( bool present = true)
virtual

Whether to merge module and generated unity files for faster compilation.

Definition at line 11840 of file UbtConfigGenerated.cs.

◆ DisableModuleNumIncludedBytesPerUnityCPPOverride()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableModuleNumIncludedBytesPerUnityCPPOverride ( bool present = true)
virtual

Disables overrides that are set by the module.

Definition at line 12241 of file UbtConfigGenerated.cs.

◆ DisablePlugin()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisablePlugin ( params object[] values)
virtual

List of plugins to be disabled for this target. Note that the project file may still reference them, so they should be marked as optional to avoid failing to find them at runtime.

Definition at line 10490 of file UbtConfigGenerated.cs.

◆ DisableUnity()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.DisableUnity ( bool present = true)
virtual

Whether to unify C++ code into larger files for faster compilation.

Definition at line 10678 of file UbtConfigGenerated.cs.

◆ EnablePlugin()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.EnablePlugin ( params object[] values)
virtual

Additional plugins that should be included for this target.

Definition at line 10468 of file UbtConfigGenerated.cs.

◆ FastMonoCalls()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.FastMonoCalls ( bool present = true)
virtual

New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.

Definition at line 10749 of file UbtConfigGenerated.cs.

◆ FastPDB()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.FastPDB ( bool? val = null)
virtual

Whether to use the :FASTLINK option when building with /DEBUG to create local PDBs on Windows. Fast, but currently seems to have problems finding symbols in the debugger.

Definition at line 11045 of file UbtConfigGenerated.cs.

◆ FlushMac()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.FlushMac ( bool? val = null)
virtual

Whether to clean Builds directory on a remote Mac before building.

Definition at line 11195 of file UbtConfigGenerated.cs.

◆ ForceDebugInfo()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ForceDebugInfo ( bool? val = null)
virtual

Whether to force debug info to be generated.

Definition at line 10812 of file UbtConfigGenerated.cs.

◆ ForceIncludeOrder()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ForceIncludeOrder ( EngineIncludeOrderVersion? val = null)
virtual

Force the include order to a specific version. Overrides any Target and Module rules.

Definition at line 11739 of file UbtConfigGenerated.cs.

◆ ForceUnity()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ForceUnity ( bool? val = null)
virtual

Whether to force C++ source files to be combined into larger files for faster compilation.

Definition at line 10699 of file UbtConfigGenerated.cs.

◆ Formal()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Formal ( bool? val = null)
virtual

Indicates that this is a formal build, intended for distribution. This flag is automatically set to true when Build.version has a changelist set. The only behavior currently bound to this flag is to compile the default resource file separately for each binary so that the OriginalFilename field is set correctly. By default, we only compile the resource once to reduce build times. Indicates that this is a formal build, intended for distribution. This flag is automatically set to true when Build.version has a changelist set and is a promoted build. The only behavior currently bound to this flag is to compile the default resource file separately for each binary so that the OriginalFilename field is set correctly. By default, we only compile the resource once to reduce build times.

Definition at line 11174 of file UbtConfigGenerated.cs.

◆ FPSemantics()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.FPSemantics ( FPSemanticsMode? val = null)
virtual

Allows setting the FP semantics.

Definition at line 12727 of file UbtConfigGenerated.cs.

◆ HeadersOnly()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.HeadersOnly ( bool? val = null)
virtual

When used with -IncludeHeaders, only header files will be compiled.

Definition at line 12431 of file UbtConfigGenerated.cs.

◆ HeaderUnits()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.HeaderUnits ( bool? val = null)
virtual

Will replace pch with ifc and use header units instead. This is an experimental and msvc-only feature.

Definition at line 12939 of file UbtConfigGenerated.cs.

◆ IncludeHeaders()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.IncludeHeaders ( bool? val = null)
virtual

Adds header files in included modules to the build.

Definition at line 12305 of file UbtConfigGenerated.cs.

◆ IncrementalLinking()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.IncrementalLinking ( bool? val = null)
virtual

Whether to use incremental linking or not. Incremental linking can yield faster iteration times when making small changes. Currently disabled by default because it tends to behave a bit buggy on some computers (PDB-related compile errors).

Definition at line 10917 of file UbtConfigGenerated.cs.

◆ IWYU()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.IWYU ( bool? val = null)
virtual

Enables "include what you use" by default for modules in this target. Changes the default PCH mode for any module in this project to PCHUsageMode.UseExplicitOrSharedPCHs. Enables "include what you use" mode.

Definition at line 10636 of file UbtConfigGenerated.cs.

◆ IWYUHeadersOnly()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.IWYUHeadersOnly ( bool? val = null)
virtual

Tells "include what you use" to only compile header files.

Definition at line 12220 of file UbtConfigGenerated.cs.

◆ LinkerArguments()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.LinkerArguments ( object val = null)
virtual

Additional arguments to pass to the linker.

Definition at line 11588 of file UbtConfigGenerated.cs.

◆ LTCG()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.LTCG ( bool? val = null)
virtual

Whether to allow the use of link time code generation (LTCG).

Definition at line 10960 of file UbtConfigGenerated.cs.

◆ Manifest()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Manifest ( params object[] values)
virtual

Path to a manifest to output for this target.

Definition at line 11454 of file UbtConfigGenerated.cs.

◆ MapFile()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MapFile ( bool? val = null)
virtual

Outputs a map file as part of the build.

Definition at line 11066 of file UbtConfigGenerated.cs.

◆ MergeAdditionalCommonModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergeAdditionalCommonModules ( params object[] values)
virtual

Experimental: List of modules to exclude from Engine to be placed in Common.

Definition at line 13521 of file UbtConfigGenerated.cs.

◆ MergeModules()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergeModules ( bool? val = null)
virtual

Experimental: Merge modular modules into combined libraries. Sets LinkType to Modular and enables bStripExports.

Definition at line 13114 of file UbtConfigGenerated.cs.

◆ MergeModulesReport()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergeModulesReport ( bool? val = null)
virtual

Experimental: Whether to report module merging data to the game target.

Definition at line 13564 of file UbtConfigGenerated.cs.

◆ MergePlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergePlugins ( params object[] values)
virtual

Experimental: List of plugins (and their dependencies) to each merge into separate libraries. Requires bMergeModules to be enabled.

Definition at line 13135 of file UbtConfigGenerated.cs.

◆ MergePluginsExcluded()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergePluginsExcluded ( params object[] values)
virtual

Experimental: List of plugins (and their dependencies) to explicitly exclude when processing merged libraries. Requires bMergeModules to be enabled Ignored plugins will still be compiled but forced into the executable.

Definition at line 13543 of file UbtConfigGenerated.cs.

◆ MergePluginsIgnored()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MergePluginsIgnored ( params object[] values)
virtual

Experimental: List of plugins (and their dependencies) to ignore when processing merged libraries. Requires bMergeModules to be enabled Ignored plugins will still be compiled, but if they're kept in the base executable, their dependencies will not be forced out of merged library with them. This should be used carefully, for organisational plugins known to have dependencies they don't actually need at runtime.

Definition at line 13288 of file UbtConfigGenerated.cs.

◆ MinArm64CpuTarget()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MinArm64CpuTarget ( Arm64TargetCpuType? val = null)
virtual

Select a minimum ARM64 target CPU. This will change what ARMv8(9)-A ISA + extension code will be compiled for. Changing it from default will guarantee not to work on all ARM64 CPUs. Currently supported by clang compiler only.

Definition at line 13265 of file UbtConfigGenerated.cs.

◆ MinCpuArchX64()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.MinCpuArchX64 ( MinimumCpuArchitectureX64? val = null)
virtual

Direct the compiler to generate AVX instructions wherever SSE or AVX intrinsics are used, on the x64 platforms that support it. Note that by enabling this you are changing the minspec for the PC platform, and the resultant executable will crash on machines without AVX support. Direct the compiler to generate AVX instructions wherever SSE or AVX intrinsics are used, on the x64 platforms that support it. Ignored for arm64. Note that by enabling this you are changing the minspec for the target platform, and the resultant executable will crash on machines without AVX support.

Definition at line 12642 of file UbtConfigGenerated.cs.

◆ Modular()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Modular ( bool present = true)
virtual

Backing storage for the LinkType property.

Definition at line 11383 of file UbtConfigGenerated.cs.

◆ ModuleIncludePathWarningLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ModuleIncludePathWarningLevel ( WarningLevel? val = null)
virtual

How to treat general module include path validation messages.

Definition at line 12473 of file UbtConfigGenerated.cs.

◆ ModuleIncludePrivateWarningLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ModuleIncludePrivateWarningLevel ( WarningLevel? val = null)
virtual

How to treat private module include path validation messages, where a module is adding an include path that exposes private headers.

Definition at line 12494 of file UbtConfigGenerated.cs.

◆ ModuleIncludeSubdirectoryWarningLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ModuleIncludeSubdirectoryWarningLevel ( WarningLevel? val = null)
virtual

How to treat unnecessary module sub-directory include path validation messages.

Definition at line 12515 of file UbtConfigGenerated.cs.

◆ Monolithic()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Monolithic ( bool present = true)
virtual

Backing storage for the LinkType property.

Definition at line 11362 of file UbtConfigGenerated.cs.

◆ NoCompileChaos()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoCompileChaos ( bool present = true)
virtual

Whether to compile the Chaos physics plugin.

Definition at line 10532 of file UbtConfigGenerated.cs.

◆ NoDebugInfo()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoDebugInfo ( bool? val = null)
virtual

Whether to globally disable debug info generation; see DebugInfoHeuristics.cs for per-config and per-platform options. How much debug info should be generated. See DebugInfoMode enum for more details.

Definition at line 10832 of file UbtConfigGenerated.cs.

◆ NoDetailedUnityFiles()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoDetailedUnityFiles ( bool present = true)
virtual

Whether to add additional information to the unity files, such as '_of_X' in the file name. Whether to add additional information to the unity files, such as '_of_X' in the file name. Not recommended.

Definition at line 11943 of file UbtConfigGenerated.cs.

◆ NoFastMonoCalls()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoFastMonoCalls ( bool present = true)
virtual

New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.

Definition at line 10770 of file UbtConfigGenerated.cs.

◆ NoIncrementalLinking()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoIncrementalLinking ( bool present = true)
virtual

Whether to use incremental linking or not. Incremental linking can yield faster iteration times when making small changes. Currently disabled by default because it tends to behave a bit buggy on some computers (PDB-related compile errors).

Definition at line 10939 of file UbtConfigGenerated.cs.

◆ NoLink()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoLink ( bool? val = null)
virtual

Whether to disable linking for this target.

Definition at line 11150 of file UbtConfigGenerated.cs.

◆ NoManifestChanges()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoManifestChanges ( bool? val = null)
virtual

Do not allow manifest changes when building this target. Used to cause earlier errors when building multiple targets with a shared build environment.

Definition at line 11320 of file UbtConfigGenerated.cs.

◆ NonDeterministic()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NonDeterministic ( bool present = true)
virtual

Set flags require for deterministic compiling and linking. Enabling deterministic mode for msvc disables codegen multithreading so compiling will be slower.

Definition at line 12327 of file UbtConfigGenerated.cs.

◆ NoPCH()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoPCH ( bool present = true)
virtual

Whether PCH files should be used.

Definition at line 10874 of file UbtConfigGenerated.cs.

◆ NoPCHChain()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoPCHChain ( bool present = true)
virtual

Whether PCHs should be chained when compiling with clang.

Definition at line 12557 of file UbtConfigGenerated.cs.

◆ NoPDB()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoPDB ( bool present = true)
virtual

Whether PDB files should be used for Visual C++ builds.

Definition at line 10853 of file UbtConfigGenerated.cs.

◆ NoRetainFramePointers()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoRetainFramePointers ( bool present = true)
virtual

Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.

Definition at line 11882 of file UbtConfigGenerated.cs.

◆ NoSharedPCH()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoSharedPCH ( bool present = true)
virtual

Enables "Shared PCHs", a feature which significantly speeds up compile times by attempting to share certain PCH files between modules that UBT detects is including those PCH's header files.

Definition at line 11024 of file UbtConfigGenerated.cs.

◆ NoThinLTO()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoThinLTO ( bool present = true)
virtual

When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.

Definition at line 13478 of file UbtConfigGenerated.cs.

◆ NoTrustedServer()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoTrustedServer ( bool present = true)
virtual

Definition at line 11819 of file UbtConfigGenerated.cs.

◆ NoUseAutoRTFM()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoUseAutoRTFM ( bool present = true)
virtual

Whether to use the AutoRTFM Clang compiler. Whether to use force AutoRTFM Clang compiler off.

Definition at line 12368 of file UbtConfigGenerated.cs.

◆ NoUseChaos()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoUseChaos ( bool present = true)
virtual

Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.

Definition at line 10574 of file UbtConfigGenerated.cs.

◆ NoUseIris()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoUseIris ( bool present = true)
virtual

Whether to use Iris.

Definition at line 11760 of file UbtConfigGenerated.cs.

◆ NoUseVerse()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoUseVerse ( bool present = true)
virtual

Whether to use the verse script interface.

Definition at line 11609 of file UbtConfigGenerated.cs.

◆ NoUseVerseBPVM()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoUseVerseBPVM ( bool present = true)
virtual

Whether to use the BPVM to run Verse.

Definition at line 12685 of file UbtConfigGenerated.cs.

◆ NoVFS()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.NoVFS ( bool present = true)
virtual

Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.

Definition at line 13242 of file UbtConfigGenerated.cs.

◆ OptimizationLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.OptimizationLevel ( OptimizationMode? val = null)
virtual

Allows to fine tune optimizations level for speed and\or code size.

Definition at line 12199 of file UbtConfigGenerated.cs.

◆ OptionalPlugins()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.OptionalPlugins ( params object[] values)
virtual

Additional plugins that should be included for this target if they are found.

Definition at line 12983 of file UbtConfigGenerated.cs.

◆ OverrideBuildEnvironment()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.OverrideBuildEnvironment ( bool? val = null)
virtual

Whether to ignore violations to the shared build environment (eg. editor targets modifying definitions)

Definition at line 11546 of file UbtConfigGenerated.cs.

◆ PackagePath()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PackagePath ( object val = null)
virtual

Package full path (directory + filename) where to store input files used at link time Normally used to debug a linker crash for platforms that support it.

Definition at line 12073 of file UbtConfigGenerated.cs.

◆ PCHPerformanceIssueWarningLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PCHPerformanceIssueWarningLevel ( WarningLevel? val = null)
virtual

Indicates what warning/error level to treat potential PCH performance issues.

Definition at line 12452 of file UbtConfigGenerated.cs.

◆ PGOOptimize()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PGOOptimize ( bool present = true)
virtual

Whether to optimize this build with Profile Guided Optimization (PGO).

Definition at line 11002 of file UbtConfigGenerated.cs.

◆ PGOProfile()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PGOProfile ( bool present = true)
virtual

Whether to enable Profile Guided Optimization (PGO) instrumentation in this build.

Definition at line 10981 of file UbtConfigGenerated.cs.

◆ Pie()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Pie ( bool? val = null)
virtual

Enable Position Independent Executable (PIE). Has an overhead cost.

Definition at line 12157 of file UbtConfigGenerated.cs.

◆ Precompile()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Precompile ( bool? val = null)
virtual

Make static libraries for all engine modules as intermediates for this target.

Definition at line 10657 of file UbtConfigGenerated.cs.

◆ Preprocess()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Preprocess ( bool? val = null)
virtual

Whether to just preprocess source files for this target, and skip compilation.

Definition at line 10895 of file UbtConfigGenerated.cs.

◆ PreprocessDepends()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PreprocessDepends ( bool? val = null)
virtual

Generate dependency files by preprocessing. This is only recommended when distributing builds as it adds additional overhead.

Definition at line 11988 of file UbtConfigGenerated.cs.

◆ ProjectDefine()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ProjectDefine ( params object[] values)
virtual

Macros to define across all macros in the project.

Definition at line 11429 of file UbtConfigGenerated.cs.

◆ PublicSymbolsByDefault()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.PublicSymbolsByDefault ( bool? val = null)
virtual

Whether to expose all symbols as public by default on POSIX platforms.

Definition at line 11258 of file UbtConfigGenerated.cs.

◆ RetainFramePointers()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.RetainFramePointers ( bool present = true)
virtual

Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.

Definition at line 11861 of file UbtConfigGenerated.cs.

◆ Rtti()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Rtti ( bool? val = null)
virtual

Enable RTTI for all modules.

Definition at line 10616 of file UbtConfigGenerated.cs.

◆ ShadowVariableErrors()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ShadowVariableErrors ( WarningLevel? val = null)
virtual

Forces shadow variable warnings to be treated as errors on platforms that support it. Forces shadow variable warnings to be treated as errors on platforms that support it. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4456 4456 - declaration of 'LocalVariable' hides previous local declaration https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4458 4458 - declaration of 'parameter' hides class member https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4459 4459 - declaration of 'LocalVariable' hides global declaration Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wshadow.

Definition at line 10728 of file UbtConfigGenerated.cs.

◆ SharedBuildEnvironment()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.SharedBuildEnvironment ( bool present = true)
virtual

Backing storage for the BuildEnvironment property.

Definition at line 11504 of file UbtConfigGenerated.cs.

◆ ShowIncludes()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ShowIncludes ( bool? val = null)
virtual

Print out files that are included by each source file.

Definition at line 13156 of file UbtConfigGenerated.cs.

◆ SkipDeploy()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.SkipDeploy ( bool? val = null)
virtual

Whether to force skipping deployment for platforms that require deployment by default.

Definition at line 11129 of file UbtConfigGenerated.cs.

◆ StackProtect()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StackProtect ( bool? val = null)
virtual

Enable Stack Protection. Has an overhead cost.

Definition at line 12178 of file UbtConfigGenerated.cs.

◆ StaticAnalyzer()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzer ( StaticAnalyzer? val = null)
virtual

Whether static code analysis should be enabled. The static analyzer to use.

Definition at line 12008 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerIncludeGenerated()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzerIncludeGenerated ( bool? val = null)
virtual

When enabled, generated source files will be analyzed.

Definition at line 12918 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerMode()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzerMode ( StaticAnalyzerMode? val = null)
virtual

The mode to use for the static analyzer. This is only supported for Clang. Shallow mode completes quicker but is generally not recommended.

Definition at line 12051 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerOutputType()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzerOutputType ( StaticAnalyzerOutputType? val = null)
virtual

The output type to use for the static analyzer. This is only supported for Clang.

Definition at line 12029 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerProjectOnly()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzerProjectOnly ( bool? val = null)
virtual

Only run static analysis against project modules, skipping engine modules.

PVS-Studio: warnings that are disabled via Engine/Source/Runtime/Core/Public/Microsoft/MicrosoftPlatformCodeAnalysis.h will be reenabled

Definition at line 12897 of file UbtConfigGenerated.cs.

◆ StaticAnalyzerPVSPrintLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StaticAnalyzerPVSPrintLevel ( double? val = null)
virtual

The level of warnings to print when analyzing using PVS-Studio.

Definition at line 12875 of file UbtConfigGenerated.cs.

◆ StressTestUnity()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StressTestUnity ( bool? val = null)
virtual

Whether to stress test the C++ unity build robustness by including all C++ files files in a project from a single unified file.

Definition at line 10791 of file UbtConfigGenerated.cs.

◆ StripExports()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.StripExports ( bool? val = null)
virtual

Experimental: Strip unused exports from libraries. Only applies when LinkType is Modular.

Definition at line 13093 of file UbtConfigGenerated.cs.

◆ SupportEditAndContinue()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.SupportEditAndContinue ( bool? val = null)
virtual

Whether to support edit and continue.

Definition at line 12620 of file UbtConfigGenerated.cs.

◆ TargetNameOverride()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.TargetNameOverride ( object val = null)
virtual

Override the name used for this target.

Definition at line 11718 of file UbtConfigGenerated.cs.

◆ ThinLTO()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ThinLTO ( bool? val = null)
virtual

When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.

Definition at line 11697 of file UbtConfigGenerated.cs.

◆ ThinLTOCacheDirectory()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ThinLTOCacheDirectory ( object val = null)
virtual

Directory where to put the ThinLTO cache on supported platforms.

Definition at line 12262 of file UbtConfigGenerated.cs.

◆ ThinLTOCachePruningArguments()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ThinLTOCachePruningArguments ( object val = null)
virtual

Arguments that will be applied to prune the ThinLTO cache on supported platforms. Arguments will only be applied if ThinLTOCacheDirectory is set.

Definition at line 12284 of file UbtConfigGenerated.cs.

◆ ThinLTODistributed()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ThinLTODistributed ( bool? val = null)
virtual

When ThinLTO is enabled we use distributed linking if supported This can save a lot of time for large binaries.

Definition at line 13500 of file UbtConfigGenerated.cs.

◆ Timing()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Timing ( bool? val = null)
virtual

Whether to write detailed timing info from the compiler and linker.

Definition at line 11216 of file UbtConfigGenerated.cs.

◆ ToolChain()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.ToolChain ( object val = null)
virtual

Allows overriding the toolchain to be created for this target. This must match the name of a class declared in the UnrealBuildTool assembly.

Definition at line 11279 of file UbtConfigGenerated.cs.

◆ Tracing()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Tracing ( bool? val = null)
virtual

Whether to parse timing data into a tracing file compatible with chrome://tracing.

Definition at line 11237 of file UbtConfigGenerated.cs.

◆ TrustedServer()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.TrustedServer ( bool present = true)
virtual

Definition at line 11800 of file UbtConfigGenerated.cs.

◆ UBAStoreObjFilesCompressed()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UBAStoreObjFilesCompressed ( bool present = true)
virtual

Experimental: Store object (.obj) compressed on disk. Requires UBA to link, currently MSVC only. Toggling this flag will invalidate MSVC actions. Warning, this option is not currently compatitable with PGO or the the cl-clang linker as those are not detoured and linking will fail. Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.

Definition at line 13072 of file UbtConfigGenerated.cs.

◆ UndefinedIdentifierWarningLevel()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UndefinedIdentifierWarningLevel ( WarningLevel? val = null)
virtual

Indicates what warning/error level to treat undefined identifiers in conditional expressions. Indicates what warning/error level to treat undefined identifiers in conditional expressions. MSVC - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4668 4668 - 'symbol' is not defined as a preprocessor macro, replacing with '0' for 'directives' 44668 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wundef.

Definition at line 13051 of file UbtConfigGenerated.cs.

◆ UniqueBuildEnvironment()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UniqueBuildEnvironment ( bool present = true)
virtual

Backing storage for the BuildEnvironment property.

Definition at line 11525 of file UbtConfigGenerated.cs.

◆ UseAutoRTFM()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseAutoRTFM ( bool present = true)
virtual

Whether to use the AutoRTFM Clang compiler.

Definition at line 12389 of file UbtConfigGenerated.cs.

◆ UseAutoRTFMVerifier()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseAutoRTFMVerifier ( bool present = true)
virtual

Whether to enable emitting AutoRTFM verification metadata.

Definition at line 13004 of file UbtConfigGenerated.cs.

◆ UseChaos()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseChaos ( bool present = true)
virtual

Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.

Definition at line 10595 of file UbtConfigGenerated.cs.

◆ UseIris()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseIris ( bool present = true)
virtual

Whether to use Iris.

Definition at line 11781 of file UbtConfigGenerated.cs.

◆ UsePDB()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UsePDB ( bool present = true)
virtual

Whether PDB files should be used for Visual C++ builds.

Definition at line 12536 of file UbtConfigGenerated.cs.

◆ UseVerse()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseVerse ( bool present = true)
virtual

Whether to use the verse script interface.

Definition at line 11630 of file UbtConfigGenerated.cs.

◆ UseVerseBPVM()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.UseVerseBPVM ( bool present = true)
virtual

Whether to use the BPVM to run Verse.

Definition at line 12706 of file UbtConfigGenerated.cs.

◆ VFS()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.VFS ( bool present = true)
virtual

Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.

Definition at line 13221 of file UbtConfigGenerated.cs.

◆ WarningsAsErrors()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.WarningsAsErrors ( bool? val = null)
virtual

Whether to enable all warnings as errors. UE enables most warnings as errors already, but disables a few (such as deprecation warnings). Treat warnings as errors.

Definition at line 11675 of file UbtConfigGenerated.cs.

◆ WithAssembly()

virtual TargetRulesConfig Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.WithAssembly ( bool? val = null)
virtual

Whether to generate assembly data while compiling this target. Works exclusively on MSVC for now.

Definition at line 12578 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig._configs = null
private

Definition at line 13582 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.CliName
get

Definition at line 10420 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Compatibility
get

Definition at line 10421 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Configs
getprotected

Definition at line 13583 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.TargetRulesConfig.Name
get

Definition at line 10419 of file UbtConfigGenerated.cs.


The documentation for this class was generated from the following file: