Global settings for building. Should not contain any target-specific settings. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig:

Public Member Functions
virtual BuildConfigurationConfig	UsePrecompiled (bool? val=null)
	Use existing static libraries for all engine modules in this target.

virtual BuildConfigurationConfig	NoXGE (bool present=true)
	Whether XGE may be used. Whether XGE may be used if available, default is true.

virtual BuildConfigurationConfig	NoFASTBuild (bool present=true)
	Whether FASTBuild may be used. Whether FASTBuild may be used if available, default is true.

virtual BuildConfigurationConfig	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 BuildConfigurationConfig	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 BuildConfigurationConfig	ForceHeaderGeneration (bool? val=null)
	If true, force header regeneration. Intended for the build machine.

virtual BuildConfigurationConfig	NoBuildUHT (bool? val=null)
	If true, do not build UHT, assume it is already built.

virtual BuildConfigurationConfig	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 BuildConfigurationConfig	NoHotReloadFromIDE (bool present=true)
	True if hot-reload from IDE is allowed.

virtual BuildConfigurationConfig	SkipRulesCompile (bool? val=null)
	Whether to skip compiling rules assemblies and just assume they are valid.

virtual BuildConfigurationConfig	PrintDebugInfo (bool present=true)
	Whether debug info should be written to the console.

virtual BuildConfigurationConfig	NoSNDBS (bool present=true)
	Whether SN-DBS may be used. Whether SN-DBS may be used if available, default is true.

virtual BuildConfigurationConfig	ForceRulesCompile (bool? val=null)
	Whether to force compiling rules assemblies, regardless of whether they are valid.

virtual BuildConfigurationConfig	HordeCompute (bool present=true)
	Whether Horde remote compute may be used. Highly experimental, disabled by default.

virtual BuildConfigurationConfig	AllCores (bool? val=null)
	Consider logical cores when determining how many total cpu cores are available.

virtual BuildConfigurationConfig	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 BuildConfigurationConfig	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 BuildConfigurationConfig	ArtifactReads (bool present=true)
	If set, artifacts will be read.

virtual BuildConfigurationConfig	NoArtifactReads (bool present=true)
	If set, artifacts will be read.

virtual BuildConfigurationConfig	ArtifactWrites (bool present=true)
	If set, artifacts will be written.

virtual BuildConfigurationConfig	NoArtifactWrites (bool present=true)
	If set, artifacts will be written.

virtual BuildConfigurationConfig	LogArtifactCacheMisses (bool present=true)
	If true, log all artifact cache misses as informational messages.

virtual BuildConfigurationConfig	ArtifactDirectory (object val=null)
	Location to store the artifacts.

virtual BuildConfigurationConfig	UBA (bool present=true)
	Whether the UnrealBuildAccelerator executor will be used.

virtual BuildConfigurationConfig	NoUBA (bool present=true)
	Whether the UnrealBuildAccelerator executor will be used.

virtual BuildConfigurationConfig	UBALocal (bool present=true)
	Whether the UnrealBuildAccelerator (local only) executor will be used.

virtual BuildConfigurationConfig	NoUBALocal (bool present=true)
	Whether the UnrealBuildAccelerator (local only) executor will be used.

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< UnrealToolArgument >	UsingArguments = []

readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Detailed Description

Global settings for building. Should not contain any target-specific settings.

Definition at line 9316 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ AllCores()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.AllCores ( bool? val = null )

virtual

Consider logical cores when determining how many total cpu cores are available.

Definition at line 9634 of file UbtConfigGenerated.cs.

◆ ArtifactDirectory()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.ArtifactDirectory ( object val = null )

virtual

Location to store the artifacts.

Definition at line 9806 of file UbtConfigGenerated.cs.

◆ ArtifactReads()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.ArtifactReads ( bool present = true )

virtual

If set, artifacts will be read.

Definition at line 9701 of file UbtConfigGenerated.cs.

◆ ArtifactWrites()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.ArtifactWrites ( bool present = true )

virtual

If set, artifacts will be written.

Definition at line 9743 of file UbtConfigGenerated.cs.

◆ CompactOutput()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.CompactOutput ( bool? val = null )

virtual

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.

Definition at line 9680 of file UbtConfigGenerated.cs.

◆ FailIfGeneratedCodeChanges()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.FailIfGeneratedCodeChanges ( bool? val = null )

virtual

If true, fail if any of the generated header files is out of date. Consider any changes to output files as being an error.

Definition at line 9488 of file UbtConfigGenerated.cs.

◆ ForceHeaderGeneration()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.ForceHeaderGeneration ( bool? val = null )

virtual

If true, force header regeneration. Intended for the build machine.

Definition at line 9447 of file UbtConfigGenerated.cs.

◆ ForceRulesCompile()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.ForceRulesCompile ( bool? val = null )

virtual

Whether to force compiling rules assemblies, regardless of whether they are valid.

Definition at line 9592 of file UbtConfigGenerated.cs.

◆ HordeCompute()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.HordeCompute ( bool present = true )

virtual

Whether Horde remote compute may be used. Highly experimental, disabled by default.

Definition at line 9613 of file UbtConfigGenerated.cs.

◆ IgnoreInvalidFiles()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.IgnoreInvalidFiles ( bool? val = null )

virtual

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.

Definition at line 9658 of file UbtConfigGenerated.cs.

◆ LogArtifactCacheMisses()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.LogArtifactCacheMisses ( bool present = true )

virtual

If true, log all artifact cache misses as informational messages.

Definition at line 9785 of file UbtConfigGenerated.cs.

◆ MaxParallelActions()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.MaxParallelActions ( double? val = null )

virtual

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.

Definition at line 9426 of file UbtConfigGenerated.cs.

◆ NoArtifactReads()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoArtifactReads ( bool present = true )

virtual

If set, artifacts will be read.

Definition at line 9722 of file UbtConfigGenerated.cs.

◆ NoArtifactWrites()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoArtifactWrites ( bool present = true )

virtual

If set, artifacts will be written.

Definition at line 9764 of file UbtConfigGenerated.cs.

◆ NoBuildUHT()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoBuildUHT ( bool? val = null )

virtual

If true, do not build UHT, assume it is already built.

Definition at line 9468 of file UbtConfigGenerated.cs.

◆ NoFASTBuild()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoFASTBuild ( bool present = true )

virtual

Whether FASTBuild may be used. Whether FASTBuild may be used if available, default is true.

Definition at line 9365 of file UbtConfigGenerated.cs.

◆ NoHotReloadFromIDE()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoHotReloadFromIDE ( bool present = true )

virtual

True if hot-reload from IDE is allowed.

Definition at line 9509 of file UbtConfigGenerated.cs.

◆ NoSNDBS()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoSNDBS ( bool present = true )

virtual

Whether SN-DBS may be used. Whether SN-DBS may be used if available, default is true.

Definition at line 9571 of file UbtConfigGenerated.cs.

◆ NoUBA()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoUBA ( bool present = true )

virtual

Whether the UnrealBuildAccelerator executor will be used.

Definition at line 9848 of file UbtConfigGenerated.cs.

◆ NoUBALocal()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoUBALocal ( bool present = true )

virtual

Whether the UnrealBuildAccelerator (local only) executor will be used.

Definition at line 9890 of file UbtConfigGenerated.cs.

◆ NoUBTMakefiles()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoUBTMakefiles ( bool present = true )

virtual

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.

Events that can invalidate the 'UBT Makefile':

Adding/removing .cpp files
Adding/removing .h files with UObjects
Adding new UObject types to a file that did not previously have any
Changing global build settings (most settings in this file qualify)
Changed code that affects how Unreal Header Tool works

You can force regeneration of the 'UBT Makefile' by passing the '-gather' argument, or simply regenerating project files.

This also enables the fast include file dependency scanning and caching system that allows Unreal Build Tool to detect out of date dependencies very quickly. When enabled, a deep C++ include graph does not have to be generated, and instead, we only scan and cache indirect includes for after a dependent build product was already found to be out of date. During the next build, we will load those cached indirect includes and check for outdatedness.

Definition at line 9404 of file UbtConfigGenerated.cs.

◆ NoXGE()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.NoXGE ( bool present = true )

virtual

Whether XGE may be used. Whether XGE may be used if available, default is true.

Definition at line 9345 of file UbtConfigGenerated.cs.

◆ PrintDebugInfo()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.PrintDebugInfo ( bool present = true )

virtual

Whether debug info should be written to the console.

Definition at line 9551 of file UbtConfigGenerated.cs.

◆ SkipRulesCompile()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.SkipRulesCompile ( bool? val = null )

virtual

Whether to skip compiling rules assemblies and just assume they are valid.

Definition at line 9530 of file UbtConfigGenerated.cs.

◆ UBA()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.UBA ( bool present = true )

virtual

Whether the UnrealBuildAccelerator executor will be used.

Definition at line 9827 of file UbtConfigGenerated.cs.

◆ UBALocal()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.UBALocal ( bool present = true )

virtual

Whether the UnrealBuildAccelerator (local only) executor will be used.

Definition at line 9869 of file UbtConfigGenerated.cs.

◆ UsePrecompiled()

virtual BuildConfigurationConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.UsePrecompiled ( bool? val = null )

virtual

Use existing static libraries for all engine modules in this target.

Definition at line 9325 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig._configs = null

private

Definition at line 9908 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.CliName

get

Definition at line 9319 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.Compatibility

get

Definition at line 9320 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.Configs

getprotected

Definition at line 9909 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfigurationConfig.Name

get

Definition at line 9318 of file UbtConfigGenerated.cs.

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

/home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AllCores()

◆ ArtifactDirectory()

◆ ArtifactReads()

◆ ArtifactWrites()

◆ CompactOutput()

◆ FailIfGeneratedCodeChanges()

◆ ForceHeaderGeneration()

◆ ForceRulesCompile()

◆ HordeCompute()

◆ IgnoreInvalidFiles()

◆ LogArtifactCacheMisses()

◆ MaxParallelActions()

◆ NoArtifactReads()

◆ NoArtifactWrites()

◆ NoBuildUHT()

◆ NoFASTBuild()

◆ NoHotReloadFromIDE()

◆ NoSNDBS()

◆ NoUBA()

◆ NoUBALocal()

◆ NoUBTMakefiles()

◆ NoXGE()

◆ PrintDebugInfo()

◆ SkipRulesCompile()

◆ UBA()

◆ UBALocal()

◆ UsePrecompiled()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name