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

Unreal Build Tool defines the Unreal project structure and provides unified source building utilities over multiple platforms. More...

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

Public Member Functions

UbtConfig Project (string project, bool withKey=false)
 Specify Project file without -Project
 
UbtConfig Game (bool present=true)
 Build with Game target.
 
UbtConfig Engine (bool present=true)
 Build with Engine target.
 
UbtConfig Target (string name, UnrealPlatform platform, IEnumerable< UnrealConfig > config)
 
UbtConfig Targets (params object[] target)
 
UbtConfig Targets (IEnumerable< object > target)
 
UbtConfig TargetPlatforms (params object[] platform)
 
UbtConfig TargetPlatforms (IEnumerable< object > platform)
 
UbtConfig Configurations (params object[] config)
 
UbtConfig Configurations (IEnumerable< object > config)
 
- Public Member Functions inherited from Nuke.Unreal.Tools.UbtConfigGenerated
virtual UbtConfig Verbose (bool present=true)
 The amount of detail to write to the log Increase output verbosity.
 
virtual UbtConfig VeryVerbose (bool present=true)
 The amount of detail to write to the log Increase output verbosity more.
 
virtual UbtConfig Log (object val=null)
 Specifies the path to a log file to write. Note that the default mode (eg. building, generating project files) will create a log file by default if this not specified. Specify a log file location instead of the default Engine/Programs/UnrealBuildTool/Log.txt Specify a log file location instead of the default Engine/Programs/UnrealHeaderTool/Saved/Logs/UnrealHeaderTool.log.
 
virtual UbtConfig Timestamps (bool? val=null)
 Whether to include timestamps in the log Include timestamps in the log.
 
virtual UbtConfig FromMsBuild (bool? val=null)
 Whether to format messages in MsBuild format Format messages for msbuild Whether UBT is invoked from MSBuild. If false will, disable bDontBundleLibrariesInAPK, unless forced .
 
virtual UbtConfig Progress (bool? val=null)
 Whether to write progress markup in a format that can be parsed by other programs Write progress messages in a format that can be parsed by other programs.
 
virtual UbtConfig NoMutex (bool? val=null)
 Whether to ignore the mutex Allow more than one instance of the program to run at once.
 
virtual UbtConfig WaitMutex (bool? val=null)
 Whether to wait for the mutex rather than aborting immediately Wait for another instance to finish and then start, rather than aborting immediately.
 
virtual UbtConfig RemoteIni (object val=null)
 Whether to wait for the mutex rather than aborting immediately Remote tool ini directory.
 
virtual UbtConfig Mode (object val=null)
 The mode to execute.
 
virtual UbtConfig Clean (bool present=true)
 The mode to execute Clean build products. Equivalent to -Mode=Clean.
 
virtual UbtConfig ProjectFiles (bool present=true)
 The mode to execute Generate project files based on IDE preference. Equivalent to -Mode=GenerateProjectFiles.
 
virtual UbtConfig ProjectFileFormat (bool present=true)
 The mode to execute Generate project files in specified format. May be used multiple times.
 
virtual UbtConfig Makefile (bool present=true)
 The mode to execute Generate Linux Makefile Generate Makefile.
 
virtual UbtConfig CMakefile (bool present=true)
 The mode to execute Generate project files for CMake.
 
virtual UbtConfig QMakefile (bool present=true)
 The mode to execute Generate project files for QMake.
 
virtual UbtConfig KDevelopfile (bool present=true)
 The mode to execute Generate project files for KDevelop.
 
virtual UbtConfig CodeliteFiles (bool present=true)
 The mode to execute Generate project files for Codelite.
 
virtual UbtConfig XCodeProjectFiles (bool present=true)
 The mode to execute Generate project files for XCode.
 
virtual UbtConfig EdditProjectFiles (bool present=true)
 The mode to execute.
 
virtual UbtConfig VSCode (bool present=true)
 The mode to execute Generate project files for Visual Studio Code.
 
virtual UbtConfig VSMac (bool present=true)
 The mode to execute Generate project files for Visual Studio Mac.
 
virtual UbtConfig CLion (bool present=true)
 The mode to execute Generate project files for CLion.
 
virtual UbtConfig Rider (bool present=true)
 The mode to execute Generate project files for Rider.
 
virtual UbtConfig UsePrecompiled (bool? val=null)
 Use existing static libraries for all engine modules in this target.
 
virtual UbtConfig NoXGE (bool present=true)
 Whether XGE may be used. Whether XGE may be used if available, default is true.
 
virtual UbtConfig NoFASTBuild (bool present=true)
 Whether FASTBuild may be used. Whether FASTBuild may be used if available, default is true.
 
virtual UbtConfig NoUBTMakefiles (bool present=true)
 Enables support for very fast iterative builds by caching target data. Turning this on causes Unreal Build Tool to emit 'UBT Makefiles' for targets when they are built the first time. Subsequent builds will load these Makefiles and begin outdatedness checking and build invocation very quickly. The caveat is that if source files are added or removed to the project, UBT will need to gather information about those in order for your build to complete successfully. Currently, you must run the project file generator after adding/removing source files to tell UBT to re-gather this information.
 
virtual UbtConfig MaxParallelActions (double? val=null)
 Number of actions that can be executed in parallel. If 0 then code will pick a default based on the number of cores available. Only applies to the ParallelExecutor Number of actions that can be executed in parallel. If 0 then code will pick a default based on the number of cores and memory available. Applies to the ParallelExecutor, HybridExecutor, and LocalExecutor.
 
virtual UbtConfig ForceHeaderGeneration (bool? val=null)
 If true, force header regeneration. Intended for the build machine.
 
virtual UbtConfig NoBuildUHT (bool? val=null)
 If true, do not build UHT, assume it is already built.
 
virtual UbtConfig FailIfGeneratedCodeChanges (bool? val=null)
 If true, fail if any of the generated header files is out of date. Consider any changes to output files as being an error.
 
virtual UbtConfig NoHotReloadFromIDE (bool present=true)
 True if hot-reload from IDE is allowed.
 
virtual UbtConfig SkipRulesCompile (bool? val=null)
 Whether to skip compiling rules assemblies and just assume they are valid.
 
virtual UbtConfig Plugin (object val=null)
 Foreign plugin to compile against this target.
 
virtual UbtConfig Module (params object[] values)
 Set of module names to compile.
 
virtual UbtConfig SingleFile (params object[] values)
 Individual file(s) to compile.
 
virtual UbtConfig NoHotReload (HotReloadMode? val=null)
 Whether to perform hot reload for this target.
 
virtual UbtConfig ForceHotReload (HotReloadMode? val=null)
 Whether to perform hot reload for this target.
 
virtual UbtConfig LiveCoding (HotReloadMode? val=null)
 Whether to perform hot reload for this target.
 
virtual UbtConfig WriteActions (params object[] values)
 Export the actions for the target to a file.
 
virtual UbtConfig LiveCodingModules (object val=null)
 Path to a file containing a list of modules that may be modified for live coding.
 
virtual UbtConfig LiveCodingManifest (object val=null)
 Path to the manifest for passing info about the output to live coding.
 
virtual UbtConfig Quiet (bool? val=null)
 Suppress messages about building this target.
 
virtual UbtConfig AllModules (bool? val=null)
 Build all the modules that are valid for this target type. Used for CIS and making installed engine builds.
 
virtual UbtConfig BuildPlugin (params object[] values)
 Additional plugins that are built for this target type but not enabled.
 
virtual UbtConfig EnablePlugin (params object[] values)
 Additional plugins that should be included for this target.
 
virtual UbtConfig 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 UbtConfig CompileAsDll (bool? val=null)
 Whether this target should be compiled as a DLL. Requires LinkType to be set to TargetLinkType.Monolithic.
 
virtual UbtConfig NoCompileChaos (bool present=true)
 Whether to compile the Chaos physics plugin.
 
virtual UbtConfig CompileChaos (bool present=true)
 Whether to compile the Chaos physics plugin.
 
virtual UbtConfig NoUseChaos (bool present=true)
 Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.
 
virtual UbtConfig UseChaos (bool present=true)
 Whether to use the Chaos physics interface. This overrides the physx flags to disable APEX and NvCloth.
 
virtual UbtConfig Rtti (bool? val=null)
 Enable RTTI for all modules.
 
virtual UbtConfig 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 UbtConfig Precompile (bool? val=null)
 Make static libraries for all engine modules as intermediates for this target.
 
virtual UbtConfig DisableUnity (bool present=true)
 Whether to unify C++ code into larger files for faster compilation.
 
virtual UbtConfig ForceUnity (bool? val=null)
 Whether to force C++ source files to be combined into larger files for faster compilation.
 
virtual UbtConfig 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 UbtConfig FastMonoCalls (bool present=true)
 New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.
 
virtual UbtConfig NoFastMonoCalls (bool present=true)
 New Monolithic Graphics drivers have optional "fast calls" replacing various D3d functions.
 
virtual UbtConfig 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 UbtConfig ForceDebugInfo (bool? val=null)
 Whether to force debug info to be generated.
 
virtual UbtConfig 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 UbtConfig NoPDB (bool present=true)
 Whether PDB files should be used for Visual C++ builds.
 
virtual UbtConfig NoPCH (bool present=true)
 Whether PCH files should be used.
 
virtual UbtConfig Preprocess (bool? val=null)
 Whether to just preprocess source files for this target, and skip compilation.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig LTCG (bool? val=null)
 Whether to allow the use of link time code generation (LTCG).
 
virtual UbtConfig PGOProfile (bool present=true)
 Whether to enable Profile Guided Optimization (PGO) instrumentation in this build.
 
virtual UbtConfig PGOOptimize (bool present=true)
 Whether to optimize this build with Profile Guided Optimization (PGO).
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig MapFile (bool? val=null)
 Outputs a map file as part of the build.
 
virtual UbtConfig BundleVersion (object val=null)
 Bundle version for Mac apps.
 
virtual UbtConfig Deploy (bool? val=null)
 Whether to deploy the executable after compilation on platforms that require deployment.
 
virtual UbtConfig SkipDeploy (bool? val=null)
 Whether to force skipping deployment for platforms that require deployment by default.
 
virtual UbtConfig NoLink (bool? val=null)
 Whether to disable linking for this target.
 
virtual UbtConfig 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 UbtConfig FlushMac (bool? val=null)
 Whether to clean Builds directory on a remote Mac before building.
 
virtual UbtConfig Timing (bool? val=null)
 Whether to write detailed timing info from the compiler and linker.
 
virtual UbtConfig Tracing (bool? val=null)
 Whether to parse timing data into a tracing file compatible with chrome://tracing.
 
virtual UbtConfig PublicSymbolsByDefault (bool? val=null)
 Whether to expose all symbols as public by default on POSIX platforms.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig BuildVersion (object val=null)
 The build version string.
 
virtual UbtConfig Monolithic (bool present=true)
 Backing storage for the LinkType property.
 
virtual UbtConfig Modular (bool present=true)
 Backing storage for the LinkType property.
 
virtual UbtConfig Define (params object[] values)
 Macros to define globally across the whole target.
 
virtual UbtConfig ProjectDefine (params object[] values)
 Macros to define across all macros in the project.
 
virtual UbtConfig Manifest (params object[] values)
 Path to a manifest to output for this target.
 
virtual UbtConfig DependencyList (params object[] values)
 Path to a list of dependencies for this target, when precompiling.
 
virtual UbtConfig SharedBuildEnvironment (bool present=true)
 Backing storage for the BuildEnvironment property.
 
virtual UbtConfig UniqueBuildEnvironment (bool present=true)
 Backing storage for the BuildEnvironment property.
 
virtual UbtConfig OverrideBuildEnvironment (bool? val=null)
 Whether to ignore violations to the shared build environment (eg. editor targets modifying definitions)
 
virtual UbtConfig CompilerArguments (object val=null)
 Additional arguments to pass to the compiler.
 
virtual UbtConfig LinkerArguments (object val=null)
 Additional arguments to pass to the linker.
 
virtual UbtConfig Architectures (params object[] values)
 Lists Architectures that you want to build.
 
virtual UbtConfig GPUArchitectures (params object[] values)
 Lists GPU Architectures that you want to build (mostly used for mobile etc.)
 
virtual UbtConfig ForceAPKGeneration (bool present=true)
 Ignore AppBundle (AAB) generation setting if "-ForceAPKGeneration" specified.
 
virtual UbtConfig _2015 (bool present=true)
 Version of the compiler toolchain to use on HoloLens. A value of "default" will be changed to a specific version at UBT startup. Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig _2017 (WindowsCompiler? val=null)
 Version of the compiler toolchain to use on HoloLens. A value of "default" will be changed to a specific version at UBT startup. Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig _2019 (WindowsCompiler? val=null)
 Version of the compiler toolchain to use on HoloLens. A value of "default" will be changed to a specific version at UBT startup. Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig _2022 (WindowsCompiler? val=null)
 Version of the compiler toolchain to use on HoloLens. A value of "default" will be changed to a specific version at UBT startup. Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig Stripsymbols (bool present=true)
 Whether to strip iOS symbols or not (implied by Shipping config). Whether to strip symbols or not (implied by Shipping config).
 
virtual UbtConfig CreateStub (bool present=true)
 If true, then a stub IPA will be generated when compiling is done (minimal files needed for a valid IPA).
 
virtual UbtConfig Alwaysgeneratedsym (bool present=true)
 Don't generate crashlytics data.
 
virtual UbtConfig Skipcrashlytics (bool? val=null)
 Don't generate crashlytics data.
 
virtual UbtConfig Distribution (bool? val=null)
 Mark the build for distribution If -distribution was passed on the commandline, this build is for distribution.
 
virtual UbtConfig ImportProvision (object val=null)
 Manual override for the provision to use. Should be a full path.
 
virtual UbtConfig ImportCertificate (object val=null)
 Imports the given certificate (inc private key) into a temporary keychain before signing.
 
virtual UbtConfig ImportCertificatePassword (object val=null)
 Password for the imported certificate.
 
virtual UbtConfig BuildAsFramework (bool? val=null)
 Whether to build the iOS project as a framework.
 
virtual UbtConfig Generatedsymfile (bool? val=null)
 Whether to generate a dSYM file or not.
 
virtual UbtConfig Generatedsymbundle (bool? val=null)
 Whether to generate a dSYM bundle (as opposed to single file dSYM)
 
virtual UbtConfig EnableASan (bool? val=null)
 Enables address sanitizer (ASan) Enables address sanitizer (ASan). Enables address sanitizer (ASan). Only supported for Visual Studio 2019 16.7.0 and up.
 
virtual UbtConfig EnableTSan (bool? val=null)
 Enables thread sanitizer (TSan) Enables thread sanitizer (TSan).
 
virtual UbtConfig EnableUBSan (bool? val=null)
 Enables undefined behavior sanitizer (UBSan) Enables undefined behavior sanitizer (UBSan).
 
virtual UbtConfig EnableMSan (bool? val=null)
 Enables memory sanitizer (MSan)
 
virtual UbtConfig ThinLTO (bool? val=null)
 Enables "thin" LTO When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.
 
virtual UbtConfig Compiler (WindowsCompiler? val=null)
 Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig CompilerVersion (object val=null)
 The specific toolchain version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version). The specific compiler version to use. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).
 
virtual UbtConfig StaticAnalyzer (WindowsStaticAnalyzer? val=null)
 The static analyzer to use. Whether static code analysis should be enabled.
 
virtual UbtConfig ObjSrcMap (object val=null)
 Whether we should export a file containing .obj to source file mappings.
 
virtual UbtConfig Strict (bool? val=null)
 Enables strict standard conformance mode (/permissive-) in VS2017+. Enables strict standard conformance mode (/permissive-).
 
virtual UbtConfig ShowIncludes (bool? val=null)
 Print out files that are included by each source file.
 
virtual UbtConfig Platforms (params object[] values)
 Platforms to generate project files for.
 
virtual UbtConfig TargetTypes (params TargetType[] values)
 Target types to generate project files for.
 
virtual UbtConfig TargetConfigurations (params UnrealTargetConfiguration[] values)
 Target configurations to generate project files for.
 
virtual UbtConfig ProjectNames (params object[] values)
 Projects to generate project files for.
 
virtual UbtConfig Minimize (bool present=true)
 Should format JSON files in human readable form, or use packed one without indents.
 
virtual UbtConfig TraceWrites (object val=null)
 Log all attempts to write to the specified file Trace writes requested to the specified file.
 
virtual UbtConfig EddieProjectFiles (bool present=true)
 The mode to execute Generate project files for Eddie.
 
virtual UbtConfig PrintDebugInfo (bool present=true)
 Whether debug info should be written to the console.
 
virtual UbtConfig NoSNDBS (bool present=true)
 Whether SN-DBS may be used. Whether SN-DBS may be used if available, default is true.
 
virtual UbtConfig ForceRulesCompile (bool? val=null)
 Whether to force compiling rules assemblies, regardless of whether they are valid.
 
virtual UbtConfig FileList (params object[] values)
 Lists of files to compile.
 
virtual UbtConfig File (params object[] values)
 Individual file(s) to compile.
 
virtual UbtConfig LiveCodingLimit (double? val=null)
 If a non-zero value, a live coding request will be terminated if more than the given number of actions are required.
 
virtual UbtConfig Rebuild (bool? val=null)
 Clean the target before trying to build it.
 
virtual UbtConfig NoUseVerse (bool present=true)
 Whether to use the verse script interface.
 
virtual UbtConfig UseVerse (bool present=true)
 Whether to use the verse script interface.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig EnableHWASan (bool? val=null)
 Enables HW address sanitizer (HWASan)
 
virtual UbtConfig EnableMinUBSan (bool? val=null)
 Enables minimal undefined behavior sanitizer (UBSan)
 
virtual UbtConfig EnableLLDB (bool? val=null)
 Turns on tuning of debug info for LLDB.
 
virtual UbtConfig NoDSYM (bool present=true)
 Enables the generation of .dsym files. This can be disabled to enable faster iteration times during development.
 
virtual UbtConfig StaticAnalyzerOutputType (WindowsStaticAnalyzerOutputType? val=null)
 The output type to use for the static analyzer. The output type to use for the static analyzer. This is only supported for Clang.
 
virtual UbtConfig Deterministic (bool? val=null)
 Set flags require for determinstic compiles (experimental) Force set flags require for determinstic compiling and linking (experimental, may not be fully supported). This setting is only recommended for testing, instead:
 
virtual UbtConfig SuppressSDKWarnings (bool? val=null)
 Whether or not to suppress warnings of missing SDKs from warnings to LogEventType.Log in UEBuildPlatformSDK.cs Missing SDKs error verbosity level will be reduced from warning to log.
 
virtual UbtConfig HordeCompute (bool present=true)
 Whether Horde remote compute may be used. Highly experimental, disabled by default.
 
virtual UbtConfig AllCores (bool? val=null)
 Consider logical cores when determining how many total cpu cores are available.
 
virtual UbtConfig IgnoreInvalidFiles (bool? val=null)
 When single file targets are specified, via -File=, -SingleFile=, or -FileList= If this option is set, no error will be produced if the source file is not included in the target. Additionally, if any file or file list is specified, the target will not be built if none of the specified files are part of that target, including the case where a file specified via -FileList= is empty.
 
virtual UbtConfig CompactOutput (bool? val=null)
 Instruct the executor to write compact output e.g. only errors, if supported by the executor. This field is used to hold the value when specified from the command line or XML.
 
virtual UbtConfig TargetNameOverride (object val=null)
 Override the name used for this target.
 
virtual UbtConfig ForceIncludeOrder (EngineIncludeOrderVersion? val=null)
 Force the include order to a specific version. Overrides any Target and Module rules.
 
virtual UbtConfig NoUseIris (bool present=true)
 Whether to use Iris.
 
virtual UbtConfig UseIris (bool present=true)
 Whether to use Iris.
 
virtual UbtConfig TrustedServer (bool present=true)
 
virtual UbtConfig NoTrustedServer (bool present=true)
 
virtual UbtConfig DisableMergingUnityFiles (bool present=true)
 Whether to merge module and generated unity files for faster compilation.
 
virtual UbtConfig RetainFramePointers (bool present=true)
 Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.
 
virtual UbtConfig NoRetainFramePointers (bool present=true)
 Forces frame pointers to be retained this is usually required when you want reliable callstacks e.g. mallocframeprofiler.
 
virtual UbtConfig BytesPerUnityCPP (double? val=null)
 An approximate number of bytes of C++ code to target for inclusion in a single unified C++ file.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig PreprocessDepends (bool? val=null)
 Generate dependency files by preprocessing. This is only recommended when distributing builds as it adds additional overhead.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig CrashDiagnosticDirectory (object val=null)
 Directory where to put crash report files for platforms that support it.
 
virtual UbtConfig DisableInliningGenCpps (bool? val=null)
 Disable supports for inlining gen.cpps.
 
virtual UbtConfig CStd (CStandardVersion? val=null)
 Which C standard to use for compiling this target.
 
virtual UbtConfig NoLog (bool? val=null)
 Disables all logging including the default log location Disable log file creation including the default log file.
 
virtual UbtConfig Test (bool? val=null)
 Run testing scripts.
 
virtual UbtConfig NoGoWide (bool? val=null)
 Disable concurrent parsing and code generation.
 
virtual UbtConfig WriteRef (bool? val=null)
 Write all the output to a reference directory.
 
virtual UbtConfig VerifyRef (bool? val=null)
 Write all the output to a verification directory and compare to the reference output.
 
virtual UbtConfig NoOutput (bool? val=null)
 Do not save any output files other than reference output.
 
virtual UbtConfig IncludeDebugOutput (bool? val=null)
 Include extra content in generated output to assist with debugging.
 
virtual UbtConfig NoDefaultExporters (bool? val=null)
 Disable all default exporters. Useful for when a specific exporter is to be run.
 
virtual UbtConfig BypassGradlePackaging (bool present=true)
 Do not use Gradle if previous APK exists and only libUnreal.so changed.
 
virtual UbtConfig Skipclangvalidation (bool present=true)
 Disables clang build verification checks on static libraries.
 
virtual UbtConfig EnableDSYM (bool present=true)
 Enables the generation of .dsym files. This can be disabled to enable faster iteration times during development. Don't generate crashlytics data.
 
virtual UbtConfig UpdatedCPPMacro (bool? val=null)
 Enables updated __cplusplus macro (/Zc:__cplusplus).
 
virtual UbtConfig StrictInline (bool? val=null)
 Enables inline conformance (Remove unreferenced COMDAT) (/Zc:inline).
 
virtual UbtConfig StrictPreprocessor (bool? val=null)
 Enables new preprocessor conformance (/Zc:preprocessor). Enables new preprocessor conformance (/Zc:preprocessor). This is always enabled for C++20 modules.
 
virtual UbtConfig StrictEnumTypes (bool? val=null)
 Enables enum types conformance (/Zc:enumTypes) in VS2022 17.4 Preview 4.0+.
 
virtual UbtConfig OnlyPrimaryProjectFile (bool? val=null)
 When specified only primary project file (root.json) will be generated. Normally project files for specific configurations are generated together with primary project file.
 
virtual UbtConfig Pie (bool? val=null)
 Enable Position Independent Executable (PIE). Has an overhead cost.
 
virtual UbtConfig StackProtect (bool? val=null)
 Enable Stack Protection. Has an overhead cost.
 
virtual UbtConfig OptimizationLevel (OptimizationMode? val=null)
 Allows to fine tune optimizations level for speed and\or code size.
 
virtual UbtConfig IWYUHeadersOnly (bool? val=null)
 Tells "include what you use" to only compile header files.
 
virtual UbtConfig DisableModuleNumIncludedBytesPerUnityCPPOverride (bool present=true)
 Disables overrides that are set by the module.
 
virtual UbtConfig ThinLTOCacheDirectory (object val=null)
 Directory where to put the ThinLTO cache on supported platforms.
 
virtual UbtConfig 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 UbtConfig ClangLinker (bool? val=null)
 True if we should use the Clang linker (LLD) when we are compiling with Clang, or Intel linker (xilink\xilib) when we are compiling with Intel oneAPI, otherwise we use the MSVC linker. True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.
 
virtual UbtConfig PGOFastGen (bool? val=null)
 If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize If specified along with -PGOProfile, then /FASTGENPROFILE will be used instead of /GENPROFILE. This usually means that the PGO data is generated faster, but the resulting data may not yield as efficient optimizations during -PGOOptimize.
 
virtual UbtConfig NoCompileCommands (bool? val=null)
 Do not create compile commands json files with compiler arguments for each file; works better with VS Code extension using UBT server mode.
 
virtual UbtConfig ArtifactReads (bool present=true)
 If set, artifacts will be read.
 
virtual UbtConfig NoArtifactReads (bool present=true)
 If set, artifacts will be read.
 
virtual UbtConfig ArtifactWrites (bool present=true)
 If set, artifacts will be written.
 
virtual UbtConfig NoArtifactWrites (bool present=true)
 If set, artifacts will be written.
 
virtual UbtConfig LogArtifactCacheMisses (bool present=true)
 If true, log all artifact cache misses as informational messages.
 
virtual UbtConfig ArtifactDirectory (object val=null)
 Location to store the artifacts.
 
virtual UbtConfig BuildPluginAsLocal (bool? val=null)
 Whether we should treat the ForeignPlugin argument as a local plugin for building purposes.
 
virtual UbtConfig Files (params object[] values)
 Relative path to file(s) to compile.
 
virtual UbtConfig WorkingDir (object val=null)
 Working directory when compiling with RelativePathsToSpecificFilesToCompile.
 
virtual UbtConfig SingleFileBuildDependents (bool? val=null)
 Will build all files that directly include any of the files provided in -SingleFile Will build all files that directly include any of the files provided in -SingleFile, not including generated code.
 
virtual UbtConfig IncludeHeaders (bool? val=null)
 Adds header files in included modules to the build.
 
virtual UbtConfig 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 UbtConfig CppStdEngine (CppStandardVersion? val=null)
 Which C++ standard to use for compiling this target (for engine modules)
 
virtual UbtConfig NoUseAutoRTFM (bool present=true)
 Whether to use the AutoRTFM Clang compiler. Whether to use force AutoRTFM Clang compiler off.
 
virtual UbtConfig UseAutoRTFM (bool present=true)
 Whether to use the AutoRTFM Clang compiler.
 
virtual UbtConfig CompileChaosVisualDebuggerSupport (bool? val=null)
 Whether to compile in Chaos Visual Debugger (CVD) support features to record the state of the physics simulation.
 
virtual UbtConfig HeadersOnly (bool? val=null)
 When used with -IncludeHeaders, only header files will be compiled.
 
virtual UbtConfig PCHPerformanceIssueWarningLevel (WarningLevel? val=null)
 Indicates what warning/error level to treat potential PCH performance issues.
 
virtual UbtConfig ModuleIncludePathWarningLevel (WarningLevel? val=null)
 How to treat general module include path validation messages.
 
virtual UbtConfig 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 UbtConfig ModuleIncludeSubdirectoryWarningLevel (WarningLevel? val=null)
 How to treat unnecessary module sub-directory include path validation messages.
 
virtual UbtConfig UsePDB (bool present=true)
 Whether PDB files should be used for Visual C++ builds.
 
virtual UbtConfig NoPCHChain (bool present=true)
 Whether PCHs should be chained when compiling with clang.
 
virtual UbtConfig WithAssembly (bool? val=null)
 Whether to generate assembly data while compiling this target. Works exclusively on MSVC for now.
 
virtual UbtConfig CodeCoverage (bool present=true)
 Whether the target requires code coverage compilation and linking.
 
virtual UbtConfig SupportEditAndContinue (bool? val=null)
 Whether to support edit and continue.
 
virtual UbtConfig 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 UbtConfig EnableLibFuzzer (bool? val=null)
 Enables LibFuzzer Enables LibFuzzer. Enables LibFuzzer. Only supported for Visual Studio 2022 17.0.0 and up.
 
virtual UbtConfig NoDumpSyms (bool? val=null)
 Whether to globally disable calling dump_syms.
 
virtual UbtConfig VCToolchain (WindowsCompiler? val=null)
 Version of the toolchain to use on Windows platform when a non-msvc Compiler is in use, to locate include paths etc.
 
virtual UbtConfig IgnoreStalePGOData (bool? val=null)
 If -PGOOptimize is specified but the linker flags have changed since the last -PGOProfile, this will emit a warning and build without PGO instead of failing during link with LNK1268.
 
virtual UbtConfig PGONoExtraCounters (bool? val=null)
 If specified along with -PGOProfile, prevent the usage of extra counters. Please note that by default /FASTGENPROFILE doesnt use extra counters.
 
virtual UbtConfig VCToolchainVersion (object val=null)
 The specific msvc toolchain version to use if the compiler is not msvc. This may be a specific version number (for example, "14.13.26128"), the string "Latest" to select the newest available version, or the string "Preview" to select the newest available preview version. By default, and if it is available, we use the toolchain version indicated by WindowsPlatform.DefaultToolChainVersion (otherwise, we use the latest version).
 
virtual UbtConfig VCFastFail (bool? val=null)
 True if /fastfail should be passed to the msvc compiler and linker.
 
virtual UbtConfig WindowsSDKVersion (object val=null)
 The specific Windows SDK version to use. This may be a specific version number (for example, "8.1", "10.0" or "10.0.10150.0"), or the string "Latest", to select the newest available version. By default, and if it is available, we use the Windows SDK version indicated by WindowsPlatform.DefaultWindowsSdkVersion (otherwise, we use the latest version).
 
virtual UbtConfig Sarif (bool? val=null)
 Whether .sarif files containing errors and warnings are written alongside each .obj, if supported.
 
virtual UbtConfig PdbAltPath (object val=null)
 Specify an alternate location for the PDB file. This option does not change the location of the generated PDB file, it changes the name that is embedded into the executable. Path can contain _PDB% which will be expanded to the original PDB file name of the target, without the directory. See https://learn.microsoft.com/en-us/cpp/build/reference/pdbaltpath-use-alternate-pdb-path.
 
virtual UbtConfig UseVSCodeExtension (bool? val=null)
 Create a workspace file for use with VS Code extension that communicates directly with UBT.
 
virtual UbtConfig UBA (bool present=true)
 Whether the UnrealBuildAccelerator executor will be used.
 
virtual UbtConfig NoUBA (bool present=true)
 Whether the UnrealBuildAccelerator executor will be used.
 
virtual UbtConfig UBALocal (bool present=true)
 Whether the UnrealBuildAccelerator (local only) executor will be used.
 
virtual UbtConfig NoUBALocal (bool present=true)
 Whether the UnrealBuildAccelerator (local only) executor will be used.
 
virtual UbtConfig BuildDependantPlugins (bool? val=null)
 When building a foreign plugin, whether to build plugins it depends on as well.
 
virtual UbtConfig 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 UbtConfig NoUseVerseBPVM (bool present=true)
 Whether to use the BPVM to run Verse.
 
virtual UbtConfig UseVerseBPVM (bool present=true)
 Whether to use the BPVM to run Verse.
 
virtual UbtConfig FPSemantics (FPSemanticsMode? val=null)
 Allows setting the FP semantics.
 
virtual UbtConfig DebugInfo (DebugInfoMode? val=null)
 How much debug info should be generated. See DebugInfoMode enum for more details.
 
virtual UbtConfig DisableDebugInfoModules (params object[] values)
 Modules that should have debug info disabled.
 
virtual UbtConfig DisableDebugInfoPlugins (params object[] values)
 Plugins that should have debug info disabled.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig StaticAnalyzerPVSPrintLevel (double? val=null)
 The level of warnings to print when analyzing using PVS-Studio.
 
virtual UbtConfig StaticAnalyzerProjectOnly (bool? val=null)
 Only run static analysis against project modules, skipping engine modules.
 
virtual UbtConfig StaticAnalyzerIncludeGenerated (bool? val=null)
 When enabled, generated source files will be analyzed.
 
virtual UbtConfig HeaderUnits (bool? val=null)
 Will replace pch with ifc and use header units instead. This is an experimental and msvc-only feature.
 
virtual UbtConfig 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 UbtConfig OptionalPlugins (params object[] values)
 Additional plugins that should be included for this target if they are found.
 
virtual UbtConfig ActionStallReportTime (double? val=null)
 Number of second of no completed actions to trigger an action stall report. If zero, stall reports will not be enabled.
 
virtual UbtConfig UBADisableRemote (bool? val=null)
 When set to true, UBA will not use any remote help.
 
virtual UbtConfig UBAForceRemote (bool? val=null)
 When set to true, UBA will force all actions that can be built remotely to be built remotely. This will hang if there are no remote agents available.
 
virtual UbtConfig UBAForcedRetry (bool? val=null)
 When set to true, actions that fail locally with UBA will be retried without UBA. When set to true, all actions that fail locally with UBA will be retried without UBA.
 
virtual UbtConfig UBAStrict (bool? val=null)
 When set to true, all errors and warnings from UBA will be output at the appropriate severity level to the log (rather than being output as 'information' and attempting to continue regardless).
 
virtual UbtConfig UBAStoreRaw (bool? val=null)
 If UBA should store cas compressed or raw.
 
virtual UbtConfig UBALinkRemote (bool? val=null)
 If UBA should distribute linking to remote workers. This needs bandwidth but can be an optimization.
 
virtual UbtConfig UBAStoreCapacityGb (double? val=null)
 The amount of gigabytes UBA is allowed to use to store workset and cached data. It is a good idea to have this >10gb.
 
virtual UbtConfig UBAMaxWorkers (double? val=null)
 Max number of worker threads that can handle messages from remotes.
 
virtual UbtConfig UBASendSize (double? val=null)
 Max size of each message sent from server to client.
 
virtual UbtConfig UBAHost (object val=null)
 Which ip UBA server should listen to for connections.
 
virtual UbtConfig UBAPort (double? val=null)
 Which port UBA server should listen to for connections.
 
virtual UbtConfig UBARootDir (object val=null)
 Which directory to store files for UBA.
 
virtual UbtConfig UBAQuic (bool present=true)
 Use Quic protocol instead of Tcp (experimental)
 
virtual UbtConfig UBALog (bool present=true)
 Enable logging of UBA processes.
 
virtual UbtConfig UBAPrintSummary (bool present=true)
 Prints summary of UBA stats at end of build.
 
virtual UbtConfig UBAVisualizer (bool present=true)
 Launch visualizer application which shows build progress.
 
virtual UbtConfig UBAResetCas (bool present=true)
 Resets the cas cache.
 
virtual UbtConfig UBATraceOutputFile (object val=null)
 Provide custom path for trace output file.
 
virtual UbtConfig UBADetailedTrace (bool present=true)
 Add verbose details to the UBA trace.
 
virtual UbtConfig UBADisableWaitOnMem (bool present=true)
 Disable UBA waiting on available memory before spawning new processes.
 
virtual UbtConfig UBAAllowKillOnMem (bool present=true)
 Let UBA kill running processes when close to out of memory.
 
virtual UbtConfig UBAOutputStatsThresholdMs (double? val=null)
 Threshold for when executor should output logging for the process. Defaults to never.
 
virtual UbtConfig UBANoWrite (bool present=true)
 Skip writing intermediate and output files to disk. Useful for validation builds where we don't need the output.
 
virtual UbtConfig UBANoCustomMalloc (bool present=true)
 Set to true to disable mimalloc and detouring of memory allocations.
 
virtual UbtConfig UBAZone (object val=null)
 The zone to use for UBA.
 
virtual UbtConfig UBACrypto (bool present=true)
 Set to true to enable encryption when transferring files over the network.
 
virtual UbtConfig UBAUseKnownInputs (bool present=true)
 Set to true to provide known inputs to processes that are run remote. This is an experimental feature to speed up build times when ping is higher.
 
virtual UbtConfig UBAActionsOutputFile (object val=null)
 Write yaml file with all actions that are queued for build. This can be used to replay using "UbaCli.exe local file.yaml".
 
virtual UbtConfig UBADetailedLog (bool present=true)
 Set to true to see more info about what is happening inside uba and also log output from agents.
 
virtual UbtConfig UBAHorde (object val=null)
 Uri of the Horde server.
 
virtual UbtConfig UBAHordeToken (object val=null)
 Uri of the Horde server Auth token for the Horde server.
 
virtual UbtConfig UBAHordeOidc (object val=null)
 OIDC id for the login to use.
 
virtual UbtConfig UBAHordePool (object val=null)
 Pool for the Horde agent to assign, only used for commandline override.
 
virtual UbtConfig UBAHordeRequirements (object val=null)
 Requirements for the Horde agent to assign.
 
virtual UbtConfig UBAHordeHost (object val=null)
 Which ip UBA server should give to agents. This will invert so host listens and agents connect.
 
virtual UbtConfig UBAHordeMaxCores (double? val=null)
 Max cores allowed to be used by build session.
 
virtual UbtConfig UBAHordeDelay (double? val=null)
 How long UBT should wait to ask for help. Useful in build configs where machine can delay remote work and still get same wall time results (pch dependencies etc)
 
virtual UbtConfig UBAHordeAllowWine (bool present=true)
 Allow use of Wine. Only applicable to Horde agents running Linux. Can still be ignored if Wine executable is not set on agent.
 
virtual UbtConfig UBAHordeConnectionMode (object val=null)
 Connection mode for agent/compute communication ConnectionMode for valid modes.
 
virtual UbtConfig UBAHordeEncryption (object val=null)
 Encryption to use for agent/compute communication. Note that UBA agent uses its own encryption. Encryption for valid modes.
 
virtual UbtConfig UBASentryUrl (object val=null)
 Sentry URL to send box data to. Optional.
 
virtual UbtConfig UBADisableHorde (bool? val=null)
 Disable horde all together.
 
virtual UbtConfig ForceDontBundleLibrariesInAPK (bool? val=null)
 Forcing bDontBundleLibrariesInAPK to "true" or "false" ignoring any other option.
 
virtual UbtConfig ScudoMemoryTracing (bool present=true)
 Adds LD_PRELOAD'ed .so to capture all malloc/free/etc calls to libc.so and route them to our memory tracing.
 
virtual UbtConfig SetResourceVersions (bool? val=null)
 If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.
 
virtual UbtConfig NoSetResourceVersions (bool present=true)
 If enabled will set the ProductVersion embeded in windows executables and dlls to contain BUILT_FROM_CHANGELIST and BuildVersion Enabled by default for all precompiled and Shipping configurations. Regardless of this setting, the versions from Build.version will be available via the BuildSettings module Note: Embedding these versions will cause resource files to be recompiled whenever changelist is updated which will cause binaries to relink.
 
virtual UbtConfig ToolchainVersionWarningLevel (WarningLevel? val=null)
 Warning level when reporting toolchains that are not in the preferred version list.
 
virtual UbtConfig SampleBasedPGO (bool? val=null)
 If specified along with -PGOProfile, use sample-based PGO instead of instrumented. Currently Intel oneAPI 2024.0+ only.
 
virtual UbtConfig VCExtendedWarningInfo (bool? val=null)
 True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.
 
virtual UbtConfig VCDisableExtendedWarningInfo (bool present=true)
 True if /d2ExtendedWarningInfo should be passed to the compiler and /d2:-ExtendedWarningInfo to the linker.
 
virtual UbtConfig ClangStandaloneDebug (bool? val=null)
 True if optimizations to reduce the size of debug information should be disabled See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.
 
virtual UbtConfig LinkRepro (object val=null)
 Whether to have the linker or library tool to generate a link repro in the specified directory See https://learn.microsoft.com/en-us/cpp/build/reference/linkrepro for more information.
 
virtual UbtConfig StripPrivateSymbols (bool? val=null)
 Whether to request the linker create a stripped pdb file as part of the build. If enabled the full debug pdb will have the extension .full.pdb.
 
virtual UbtConfig UseXCurl (bool? val=null)
 Whether this build will use Microsoft's custom XCurl instead of libcurl Note that XCurl is not part of the normal Windows SDK and will require additional downloads.
 
virtual UbtConfig TelemetryProvider (params object[] values)
 Additional command line providers to load opt-in telemetry connection information from ini. List of ini providers for telemetry.
 
virtual UbtConfig Session (object val=null)
 Session identifier for this run of UBT, if unset defaults to a random Guid.
 
virtual UbtConfig UseAutoRTFMVerifier (bool present=true)
 Whether to enable emitting AutoRTFM verification metadata.
 
virtual UbtConfig CompileIoStoreOnDemand (bool present=true)
 Whether to use I/O store on-demand.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig StripExports (bool? val=null)
 Experimental: Strip unused exports from libraries. Only applies when LinkType is Modular.
 
virtual UbtConfig MergeModules (bool? val=null)
 Experimental: Merge modular modules into combined libraries. Sets LinkType to Modular and enables bStripExports.
 
virtual UbtConfig MergePlugins (params object[] values)
 Experimental: List of plugins (and their dependencies) to each merge into separate libraries. Requires bMergeModules to be enabled.
 
virtual UbtConfig ActionStallTerminateTime (double? val=null)
 Number of second of no completed actions to trigger to terminate the queue. If zero, force termination not be enabled.
 
virtual UbtConfig UBAForcedRetryRemote (bool? val=null)
 When set to true, actions that fail remotely with UBA will be retried locally with UBA.
 
virtual UbtConfig UBACache (object val=null)
 Address of the uba cache service. Will automatically use cache if connected.
 
virtual UbtConfig UBAWriteCache (bool? val=null)
 Set cache to write instead of fetch Set cache to write, expects one of [True, False, BuildMachineOnly].
 
virtual UbtConfig UBACacheMaxWorkers (double? val=null)
 Max number of cache download tasks that can execute in parallel.
 
virtual UbtConfig UBAReportCacheMissReason (bool? val=null)
 Report reason a cache miss happened. Useful when searching for determinism/portability issues.
 
virtual UbtConfig UBAHordeCluster (object val=null)
 Compute cluster ID to use in Horde. Set to "_auto" to let Horde server resolve a suitable cluster. In multi-region setups this is can simplify configuration of UBT/UBA a lot.
 
virtual UbtConfig DisableVolatileMetadata (bool? val=null)
 Volatile Metadata is enabled by default and improves x64 emulation on arm64, but may come at a small perfomance cost (/volatileMetadata-).
 
virtual UbtConfig PGOMergedPGD (object val=null)
 If specified along with -PGOOptimize, will use the specified per-merged pgd file instead of the usual pgd file with loose pgc files.
 
virtual UbtConfig NoClangLinker (bool present=true)
 True if we should use the Clang linker (LLD) when we are compiling with Clang or Intel oneAPI, otherwise we use the MSVC linker.
 
virtual UbtConfig StrictODR (bool? val=null)
 Enables enforcing standard C++ ODR violations (/Zc:checkGwOdr) in VS2022 17.5 Preview 2.0+.
 
virtual UbtConfig NoLinkerDebugInfo (bool? val=null)
 If you supply -NoDebugInfo, windows platforms still create debug info while linking. Set this to true to not create debug info while linking in this circumstance.
 
virtual UbtConfig Query (object val=null)
 Outputs all the available configurations, platforms and targets to a file provided by the user.
 
virtual UbtConfig TargetDescriptionFile (object val=null)
 
virtual UbtConfig WorkspaceGeneratorVersion (bool? val=null)
 Show version information and exit.
 
virtual UbtConfig GenerateVsConfigOnly (bool? val=null)
 Generate .vsconfig file with dependencies and exit.
 
virtual UbtConfig SwitchUnhandledEnumeratorWarningLevel (WarningLevel? val=null)
 Indicates what warning/error level to treat unhandled enumerators in switches on enumeration-typed values. MSVC - 4061 - https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4061 44061 - Note: The extra 4 is not a typo, /wLXXXX sets warning XXXX to level L Clang - https://clang.llvm.org/docs/DiagnosticsReference.html#wswitch-enum.
 
virtual UbtConfig ModuleUnsupportedWarningLevel (WarningLevel? val=null)
 How to treat module unsupported validation messages.
 
virtual UbtConfig PluginModuleUnsupportedWarningLevel (WarningLevel? val=null)
 How to treat plugin specific module unsupported validation messages.
 
virtual UbtConfig 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 UbtConfig AutoRTFMClosedStaticLinkage (bool present=true)
 Whether to link closed function declarations statically.
 
virtual UbtConfig VFS (bool present=true)
 Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.
 
virtual UbtConfig NoVFS (bool present=true)
 Experimental work in progress: Set flags to use toolchain virtual file system support, to generate consistent pathing in outputs.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig UBAProviders (params object[] values)
 List of provider names for remote connections from ini It is recommended to set Providers in ini so the setting can be shared with the uba controller in editor, such as Windows: ProgramData%/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Mac: ~/Library/Application Support/Epic/Unreal Engine/Engine/Config/SystemEngine.ini Linux: ~/.config/Epic/Unreal Engine/Engine/Config/SystemEngine.ini.
 
virtual UbtConfig UBACacheProviders (params object[] values)
 List of provider names for remote cache from ini.
 
virtual UbtConfig UBANoRetry (bool present=true)
 When set to true, actions that fail locally with certain error codes will retry without uba.
 
virtual UbtConfig UBADisableStoreObjFilesCompressed (bool present=true)
 Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
 
virtual UbtConfig UBANoDetour (bool present=true)
 Disable all detouring making all actions run outside uba.
 
virtual UbtConfig UBAShuffleCache (bool? val=null)
 Shuffle the list of cache servers before each read attempt.
 
virtual UbtConfig UBACompressionLevel (object val=null)
 Compression level. Options are None, SuperFast, VeryFast, Fast, Normal, Optimal1 to Optimal5.
 
virtual UbtConfig DynamicDebugging (bool? val=null)
 If specificed Visual Studio Dynamic Debugging support will be enabled, unless the compiler or linker is not MSVC or LTCG is enabled.
 
virtual UbtConfig RadLinker (bool? val=null)
 True if we should use the Rad linker.
 
virtual UbtConfig EnableInstrumentation (bool? val=null)
 Enables instrumentation.
 
virtual UbtConfig AndroidStudio (bool present=true)
 The mode to execute Generate project files for Android Studio.
 
virtual UbtConfig BinariesSubfolder (object val=null)
 Subfolder to place executables in, relative to the default location.
 
virtual UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig 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 UbtConfig CacheSalt (object val=null)
 Salt value to modify cache bucket calculation, can be used to invalidate cached actions outputs.
 
virtual UbtConfig NoThinLTO (bool present=true)
 When Link Time Code Generation (LTCG) is enabled, whether to prefer using the lighter weight version on supported platforms.
 
virtual UbtConfig 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 UbtConfig MergeAdditionalCommonModules (params object[] values)
 Experimental: List of modules to exclude from Engine to be placed in Common.
 
virtual UbtConfig 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 UbtConfig MergeModulesReport (bool? val=null)
 Experimental: Whether to report module merging data to the game target.
 
virtual UbtConfig Nocompress (bool present=true)
 Store object (.obj) compressed on disk. Requires uba to do link step where it will decompress obj files again.
 
virtual UbtConfig UBAHordeMaxWorkers (double? val=null)
 Max workers allowed to be used by build session.
 
virtual UbtConfig UBAHordeMaxIdle (double? val=null)
 Max idle time in seconds to maintain a connection to a worker when no pending actions are currently available due to waiting on dependencies.
 
virtual UbtConfig UBAHordeCacheEnabled (bool? val=null)
 Enabled parameter for use by INI config, expects one of [True, False, BuildMachineOnly].
 
virtual UbtConfig UBAHordeCacheDesiredConnectionCount (double? val=null)
 Number of desired connections when connecting to cache.
 
virtual UbtConfig FastIterate (bool present=true)
 Makes build interation faster.
 
virtual UbtConfig OnlyGradleGeneration (bool present=true)
 Only generates gradle.
 
virtual UbtConfig Createstripflagfile (bool present=true)
 Whether to create a ".stripped" file when stripping symbols or not.
 
virtual UbtConfig NoStripSymbols (bool? val=null)
 Whether to globally skip symbol stripping.
 
virtual UbtConfig _2026 (WindowsCompiler? val=null)
 Version of the compiler toolchain to use on Windows platform. A value of "default" will be changed to a specific version at UBT start up.
 
virtual UbtConfig NoClangStandaloneDebug (bool present=true)
 True if optimizations to reduce the size of debug information should be disabled. Disabling this option can decrease pdb size but may degrade the debugging experience. See https://clang.llvm.org/docs/UsersManual.html#cmdoption-fstandalone-debug for more information.
 
UbtConfig UnrealBuildTool (Action< UnrealBuildToolConfig > configurator)
 
UbtConfig GlobalOptions (Action< GlobalOptionsConfig > configurator)
 Global options for UBT (any modes)
 
UbtConfig BuildConfiguration (Action< BuildConfigurationConfig > configurator)
 Global settings for building. Should not contain any target-specific settings.
 
UbtConfig TargetDescriptor (Action< TargetDescriptorConfig > configurator)
 Describes all of the information needed to initialize a UEBuildTarget object.
 
UbtConfig TargetRules (Action< TargetRulesConfig > configurator)
 TargetRules is a data structure that contains the rules for defining a target (application/executable)
 
UbtConfig AggregateParsedTimingInfo (Action< AggregateParsedTimingInfoConfig > configurator)
 Aggregates parsed Visual C++ timing information files together into one monolithic breakdown file.
 
UbtConfig Build (Action< BuildConfig > configurator)
 Builds a target.
 
UbtConfig Clean (Action< CleanConfig > configurator)
 Cleans build products and intermediates for the target. This deletes files which are named consistently with the target being built (e.g. UE4Editor-Foo-Win64-Debug.dll) rather than an actual record of previous build products. Cleans build products and intermediates for the target. This deletes files which are named consistently with the target being built (e.g. UnrealEditor-Foo-Win64-Debug.dll) rather than an actual record of previous build products.
 
UbtConfig Deploy (Action< DeployConfig > configurator)
 Invokes the deployment handler for a target.
 
UbtConfig Execute (Action< ExecuteConfig > configurator)
 Builds a target.
 
UbtConfig GenerateClangDatabase (Action< GenerateClangDatabaseConfig > configurator)
 Generate a clang compile_commands file for a target.
 
UbtConfig GenerateProjectFiles (Action< GenerateProjectFilesConfig > configurator)
 Generates project files for one or more projects.
 
UbtConfig JsonExport (Action< JsonExportConfig > configurator)
 Exports a target as a JSON file.
 
UbtConfig ParseMsvcTimingInfo (Action< ParseMsvcTimingInfoConfig > configurator)
 Parses an MSVC timing info file generated from cl-filter to turn it into a form that can be used by other tooling. This is implemented as a separate mode to allow it to be done as part of the action graph.
 
UbtConfig QueryTargets (Action< QueryTargetsConfig > configurator)
 Queries information about the targets supported by a project.
 
UbtConfig SetupPlatforms (Action< SetupPlatformsConfig > configurator)
 Register all platforms (and in the process, configure all autosdks)
 
UbtConfig ValidatePlatforms (Action< ValidatePlatformsConfig > configurator)
 Validates the various platforms to determine if they are ready for building.
 
UbtConfig WriteDocumentation (Action< WriteDocumentationConfig > configurator)
 Generates documentation from reflection data.
 
UbtConfig WriteMetadata (Action< WriteMetadataConfig > configurator)
 Writes all metadata files at the end of a build (receipts, version files, etc...). This is implemented as a separate mode to allow it to be done as part of the action graph.
 
UbtConfig AndroidToolChain (Action< AndroidToolChainConfig > configurator)
 
UbtConfig AndroidTargetRules (Action< AndroidTargetRulesConfig > configurator)
 Android-specific target settings.
 
UbtConfig UEDeployAndroid (Action< UEDeployAndroidConfig > configurator)
 
UbtConfig HoloLensTargetRules (Action< HoloLensTargetRulesConfig > configurator)
 HoloLens-specific target settings.
 
UbtConfig IOSPostBuildSync (Action< IOSPostBuildSyncConfig > configurator)
 
UbtConfig IOSTargetRules (Action< IOSTargetRulesConfig > configurator)
 IOS-specific target settings.
 
UbtConfig IOSProjectSettings (Action< IOSProjectSettingsConfig > configurator)
 Stores project-specific IOS settings. Instances of this object are cached by IOSPlatform.
 
UbtConfig LinuxTargetRules (Action< LinuxTargetRulesConfig > configurator)
 Linux-specific target settings.
 
UbtConfig LuminToolChain (Action< LuminToolChainConfig > configurator)
 
UbtConfig LuminTargetRules (Action< LuminTargetRulesConfig > configurator)
 Lumin-specific target settings.
 
UbtConfig MacTargetRules (Action< MacTargetRulesConfig > configurator)
 Mac-specific target settings.
 
UbtConfig PVSGather (Action< PVSGatherConfig > configurator)
 Special mode for gathering all the messages into a single output file.
 
UbtConfig WindowsTargetRules (Action< WindowsTargetRulesConfig > configurator)
 Windows-specific target settings.
 
UbtConfig RiderProjectFileGenerator (Action< RiderProjectFileGeneratorConfig > configurator)
 
UbtConfig Analyze (Action< AnalyzeConfig > configurator)
 Outputs information about the given target, including a module dependecy graph (in .gefx format and list of module references)
 
UbtConfig AggregateClangTimingInfo (Action< AggregateClangTimingInfoConfig > configurator)
 Aggregates clang timing information files together into one monolithic breakdown file.
 
UbtConfig FixIncludePaths (Action< FixIncludePathsConfig > configurator)
 Fixes the include paths found in a header and source file.
 
UbtConfig InlineGeneratedCpps (Action< InlineGeneratedCppsConfig > configurator)
 Generate a clang compile_commands file for a target.
 
UbtConfig PrintBuildGraphInfo (Action< PrintBuildGraphInfoConfig > configurator)
 Generate a clang compile_commands file for a target.
 
UbtConfig Test (Action< TestConfig > configurator)
 Builds low level tests on one or more targets.
 
UbtConfig UhtGlobalOptions (Action< UhtGlobalOptionsConfig > configurator)
 Global options for UBT (any modes)
 
UbtConfig UnrealHeaderTool (Action< UnrealHeaderToolConfig > configurator)
 Invoke UHT.
 
UbtConfig IWYU (Action< IWYUConfig > configurator)
 Profiles different unity sizes and prints out the different size and its timings.
 
UbtConfig ProfileUnitySizes (Action< ProfileUnitySizesConfig > configurator)
 Profiles different unity sizes and prints out the different size and its timings.
 
UbtConfig Server (Action< ServerConfig > configurator)
 
UbtConfig VSCodeProjectFileGenerator (Action< VSCodeProjectFileGeneratorConfig > configurator)
 
UbtConfig ClRepro (Action< ClReproConfig > configurator)
 
UbtConfig Query (Action< QueryConfig > configurator)
 
UbtConfig ApplePostBuildSync (Action< ApplePostBuildSyncConfig > configurator)
 
UbtConfig ImmediateActionQueue (Action< ImmediateActionQueueConfig > configurator)
 Helper class to manage the action queue.
 
UbtConfig UnrealBuildAcceleratorConfig (Action< UnrealBuildAcceleratorConfigConfig > configurator)
 Configuration for Unreal Build Accelerator.
 
UbtConfig UnrealBuildAcceleratorHordeConfig (Action< UnrealBuildAcceleratorHordeConfigConfig > configurator)
 Configuration for Unreal Build Accelerator Horde session.
 
UbtConfig PipInstall (Action< PipInstallConfig > configurator)
 Identifies plugins with python requirements and attempts to install all dependencies using pip.
 
UbtConfig VSWorkspaceProjectFileGenerator (Action< VSWorkspaceProjectFileGeneratorConfig > configurator)
 
UbtConfig CppCompileWarnings (Action< CppCompileWarningsConfig > configurator)
 Container class used for C++ compiler warning settings.
 
UbtConfig UnrealBuildAcceleratorCacheConfig (Action< UnrealBuildAcceleratorCacheConfigConfig > configurator)
 Configuration for Unreal Build Accelerator.
 
UbtConfig AppleTargetRules (Action< AppleTargetRulesConfig > configurator)
 Apple-specific target settings.
 
- 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.
 

Additional Inherited Members

- Protected Attributes inherited from Nuke.Unreal.Tools.UbtConfigGenerated
readonly UnrealBuildToolConfig UnrealBuildToolStorage = new()
 
readonly GlobalOptionsConfig GlobalOptionsStorage = new()
 
readonly BuildConfigurationConfig BuildConfigurationStorage = new()
 
readonly TargetDescriptorConfig TargetDescriptorStorage = new()
 
readonly TargetRulesConfig TargetRulesStorage = new()
 
readonly AggregateParsedTimingInfoConfig AggregateParsedTimingInfoStorage = new()
 
readonly BuildConfig BuildStorage = new()
 
readonly CleanConfig CleanStorage = new()
 
readonly DeployConfig DeployStorage = new()
 
readonly ExecuteConfig ExecuteStorage = new()
 
readonly GenerateClangDatabaseConfig GenerateClangDatabaseStorage = new()
 
readonly GenerateProjectFilesConfig GenerateProjectFilesStorage = new()
 
readonly JsonExportConfig JsonExportStorage = new()
 
readonly ParseMsvcTimingInfoConfig ParseMsvcTimingInfoStorage = new()
 
readonly QueryTargetsConfig QueryTargetsStorage = new()
 
readonly SetupPlatformsConfig SetupPlatformsStorage = new()
 
readonly ValidatePlatformsConfig ValidatePlatformsStorage = new()
 
readonly WriteDocumentationConfig WriteDocumentationStorage = new()
 
readonly WriteMetadataConfig WriteMetadataStorage = new()
 
readonly AndroidToolChainConfig AndroidToolChainStorage = new()
 
readonly AndroidTargetRulesConfig AndroidTargetRulesStorage = new()
 
readonly UEDeployAndroidConfig UEDeployAndroidStorage = new()
 
readonly HoloLensTargetRulesConfig HoloLensTargetRulesStorage = new()
 
readonly IOSPostBuildSyncConfig IOSPostBuildSyncStorage = new()
 
readonly IOSTargetRulesConfig IOSTargetRulesStorage = new()
 
readonly IOSProjectSettingsConfig IOSProjectSettingsStorage = new()
 
readonly LinuxTargetRulesConfig LinuxTargetRulesStorage = new()
 
readonly LuminToolChainConfig LuminToolChainStorage = new()
 
readonly LuminTargetRulesConfig LuminTargetRulesStorage = new()
 
readonly MacTargetRulesConfig MacTargetRulesStorage = new()
 
readonly PVSGatherConfig PVSGatherStorage = new()
 
readonly WindowsTargetRulesConfig WindowsTargetRulesStorage = new()
 
readonly RiderProjectFileGeneratorConfig RiderProjectFileGeneratorStorage = new()
 
readonly AnalyzeConfig AnalyzeStorage = new()
 
readonly AggregateClangTimingInfoConfig AggregateClangTimingInfoStorage = new()
 
readonly FixIncludePathsConfig FixIncludePathsStorage = new()
 
readonly InlineGeneratedCppsConfig InlineGeneratedCppsStorage = new()
 
readonly PrintBuildGraphInfoConfig PrintBuildGraphInfoStorage = new()
 
readonly TestConfig TestStorage = new()
 
readonly UhtGlobalOptionsConfig UhtGlobalOptionsStorage = new()
 
readonly UnrealHeaderToolConfig UnrealHeaderToolStorage = new()
 
readonly IWYUConfig IWYUStorage = new()
 
readonly ProfileUnitySizesConfig ProfileUnitySizesStorage = new()
 
readonly ServerConfig ServerStorage = new()
 
readonly VSCodeProjectFileGeneratorConfig VSCodeProjectFileGeneratorStorage = new()
 
readonly ClReproConfig ClReproStorage = new()
 
readonly QueryConfig QueryStorage = new()
 
readonly ApplePostBuildSyncConfig ApplePostBuildSyncStorage = new()
 
readonly ImmediateActionQueueConfig ImmediateActionQueueStorage = new()
 
readonly UnrealBuildAcceleratorConfigConfig UnrealBuildAcceleratorConfigStorage = new()
 
readonly UnrealBuildAcceleratorHordeConfigConfig UnrealBuildAcceleratorHordeConfigStorage = new()
 
readonly PipInstallConfig PipInstallStorage = new()
 
readonly VSWorkspaceProjectFileGeneratorConfig VSWorkspaceProjectFileGeneratorStorage = new()
 
readonly CppCompileWarningsConfig CppCompileWarningsStorage = new()
 
readonly UnrealBuildAcceleratorCacheConfigConfig UnrealBuildAcceleratorCacheConfigStorage = new()
 
readonly AppleTargetRulesConfig AppleTargetRulesStorage = new()
 
- Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgumentUsingArguments = []
 
readonly Dictionary< string, ToolConfigUsingSubtools = []
 
- Properties inherited from Nuke.Unreal.Tools.UbtConfigGenerated
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]
 

Detailed Description

Unreal Build Tool defines the Unreal project structure and provides unified source building utilities over multiple platforms.

Definition at line 12 of file UbtConfig.cs.

Member Function Documentation

◆ Configurations()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Configurations ( IEnumerable< object > config)

Definition at line 87 of file UbtConfig.cs.

◆ Engine()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Engine ( bool present = true)

Build with Engine target.

Parameters
present
Returns

Definition at line 57 of file UbtConfig.cs.

◆ Game()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Game ( bool present = true)

Build with Game target.

Parameters
present
Returns

Definition at line 42 of file UbtConfig.cs.

◆ Project()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Project ( string project,
bool withKey = false )

Specify Project file without -Project

Parameters
project
withKeyuse -project key to specify target project
Returns

Definition at line 20 of file UbtConfig.cs.

◆ Target()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Target ( string name,
UnrealPlatform platform,
IEnumerable< UnrealConfig > config )

Definition at line 66 of file UbtConfig.cs.

◆ TargetPlatforms()

UbtConfig Nuke.Unreal.Tools.UbtConfig.TargetPlatforms ( IEnumerable< object > platform)

Definition at line 80 of file UbtConfig.cs.

◆ Targets()

UbtConfig Nuke.Unreal.Tools.UbtConfig.Targets ( IEnumerable< object > target)

Definition at line 73 of file UbtConfig.cs.


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