Global options for UBT (any modes) More...

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

Public Member Functions
virtual GlobalOptionsConfig	Verbose (bool present=true)
	The amount of detail to write to the log Increase output verbosity.

virtual GlobalOptionsConfig	VeryVerbose (bool present=true)
	The amount of detail to write to the log Increase output verbosity more.

virtual GlobalOptionsConfig	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 GlobalOptionsConfig	Timestamps (bool? val=null)
	Whether to include timestamps in the log Include timestamps in the log.

virtual GlobalOptionsConfig	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 GlobalOptionsConfig	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 GlobalOptionsConfig	NoMutex (bool? val=null)
	Whether to ignore the mutex Allow more than one instance of the program to run at once.

virtual GlobalOptionsConfig	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 GlobalOptionsConfig	RemoteIni (object val=null)
	Whether to wait for the mutex rather than aborting immediately Remote tool ini directory.

virtual GlobalOptionsConfig	Mode (object val=null)
	The mode to execute.

virtual GlobalOptionsConfig	Clean (bool present=true)
	The mode to execute Clean build products. Equivalent to -Mode=Clean.

virtual GlobalOptionsConfig	ProjectFiles (bool present=true)
	The mode to execute Generate project files based on IDE preference. Equivalent to -Mode=GenerateProjectFiles.

virtual GlobalOptionsConfig	ProjectFileFormat (bool present=true)
	The mode to execute Generate project files in specified format. May be used multiple times.

virtual GlobalOptionsConfig	Makefile (bool present=true)
	The mode to execute Generate Linux Makefile Generate Makefile.

virtual GlobalOptionsConfig	CMakefile (bool present=true)
	The mode to execute Generate project files for CMake.

virtual GlobalOptionsConfig	QMakefile (bool present=true)
	The mode to execute Generate project files for QMake.

virtual GlobalOptionsConfig	KDevelopfile (bool present=true)
	The mode to execute Generate project files for KDevelop.

virtual GlobalOptionsConfig	CodeliteFiles (bool present=true)
	The mode to execute Generate project files for Codelite.

virtual GlobalOptionsConfig	XCodeProjectFiles (bool present=true)
	The mode to execute Generate project files for XCode.

virtual GlobalOptionsConfig	EdditProjectFiles (bool present=true)
	The mode to execute.

virtual GlobalOptionsConfig	VSCode (bool present=true)
	The mode to execute Generate project files for Visual Studio Code.

virtual GlobalOptionsConfig	VSMac (bool present=true)
	The mode to execute Generate project files for Visual Studio Mac.

virtual GlobalOptionsConfig	CLion (bool present=true)
	The mode to execute Generate project files for CLion.

virtual GlobalOptionsConfig	Rider (bool present=true)
	The mode to execute Generate project files for Rider.

virtual GlobalOptionsConfig	TraceWrites (object val=null)
	Log all attempts to write to the specified file Trace writes requested to the specified file.

virtual GlobalOptionsConfig	EddieProjectFiles (bool present=true)
	The mode to execute Generate project files for Eddie.

virtual GlobalOptionsConfig	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 GlobalOptionsConfig	TelemetryProvider (params object[] values)
	Additional command line providers to load opt-in telemetry connection information from ini. List of ini providers for telemetry.

virtual GlobalOptionsConfig	Session (object val=null)
	Session identifier for this run of UBT, if unset defaults to a random Guid.

virtual GlobalOptionsConfig	AndroidStudio (bool present=true)
	The mode to execute Generate project files for Android Studio.

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 options for UBT (any modes)

Definition at line 8692 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ AndroidStudio()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.AndroidStudio ( bool present = true )

virtual

The mode to execute Generate project files for Android Studio.

Definition at line 9287 of file UbtConfigGenerated.cs.

◆ Clean()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Clean ( bool present = true )

virtual

The mode to execute Clean build products. Equivalent to -Mode=Clean.

Definition at line 8904 of file UbtConfigGenerated.cs.

◆ CLion()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.CLion ( bool present = true )

virtual

The mode to execute Generate project files for CLion.

Definition at line 9146 of file UbtConfigGenerated.cs.

◆ CMakefile()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.CMakefile ( bool present = true )

virtual

The mode to execute Generate project files for CMake.

Definition at line 8985 of file UbtConfigGenerated.cs.

◆ CodeliteFiles()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.CodeliteFiles ( bool present = true )

virtual

The mode to execute Generate project files for Codelite.

Definition at line 9045 of file UbtConfigGenerated.cs.

◆ EddieProjectFiles()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.EddieProjectFiles ( bool present = true )

virtual

The mode to execute Generate project files for Eddie.

Definition at line 9206 of file UbtConfigGenerated.cs.

◆ EdditProjectFiles()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.EdditProjectFiles ( bool present = true )

virtual

The mode to execute.

Definition at line 9086 of file UbtConfigGenerated.cs.

◆ FromMsBuild()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.FromMsBuild ( bool? val = null )

virtual

Whether to format messages in MsBuild format Format messages for msbuild Whether UBT is invoked from MSBuild. If false will, disable bDontBundleLibrariesInAPK, unless forced .

Definition at line 8783 of file UbtConfigGenerated.cs.

◆ KDevelopfile()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.KDevelopfile ( bool present = true )

virtual

The mode to execute Generate project files for KDevelop.

Definition at line 9025 of file UbtConfigGenerated.cs.

◆ Log()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Log ( object val = null )

virtual

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.

Definition at line 8741 of file UbtConfigGenerated.cs.

◆ Makefile()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Makefile ( bool present = true )

virtual

The mode to execute Generate Linux Makefile Generate Makefile.

Definition at line 8965 of file UbtConfigGenerated.cs.

◆ Mode()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Mode ( object val = null )

virtual

The mode to execute.

Definition at line 8884 of file UbtConfigGenerated.cs.

◆ NoMutex()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.NoMutex ( bool? val = null )

virtual

Whether to ignore the mutex Allow more than one instance of the program to run at once.

Definition at line 8823 of file UbtConfigGenerated.cs.

◆ Progress()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Progress ( bool? val = null )

virtual

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.

Definition at line 8803 of file UbtConfigGenerated.cs.

◆ ProjectFileFormat()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.ProjectFileFormat ( bool present = true )

virtual

The mode to execute Generate project files in specified format. May be used multiple times.

Definition at line 8944 of file UbtConfigGenerated.cs.

◆ ProjectFiles()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.ProjectFiles ( bool present = true )

virtual

The mode to execute Generate project files based on IDE preference. Equivalent to -Mode=GenerateProjectFiles.

Definition at line 8924 of file UbtConfigGenerated.cs.

◆ QMakefile()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.QMakefile ( bool present = true )

virtual

The mode to execute Generate project files for QMake.

Definition at line 9005 of file UbtConfigGenerated.cs.

◆ RemoteIni()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.RemoteIni ( object val = null )

virtual

Whether to wait for the mutex rather than aborting immediately Remote tool ini directory.

Definition at line 8863 of file UbtConfigGenerated.cs.

◆ Rider()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Rider ( bool present = true )

virtual

The mode to execute Generate project files for Rider.

Definition at line 9166 of file UbtConfigGenerated.cs.

◆ Session()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Session ( object val = null )

virtual

Session identifier for this run of UBT, if unset defaults to a random Guid.

Definition at line 9267 of file UbtConfigGenerated.cs.

◆ SuppressSDKWarnings()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.SuppressSDKWarnings ( bool? val = null )

virtual

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.

Definition at line 9226 of file UbtConfigGenerated.cs.

◆ TelemetryProvider()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.TelemetryProvider ( params object[] values )

virtual

Additional command line providers to load opt-in telemetry connection information from ini. List of ini providers for telemetry.

Definition at line 9246 of file UbtConfigGenerated.cs.

◆ Timestamps()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Timestamps ( bool? val = null )

virtual

Whether to include timestamps in the log Include timestamps in the log.

Definition at line 8761 of file UbtConfigGenerated.cs.

◆ TraceWrites()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.TraceWrites ( object val = null )

virtual

Log all attempts to write to the specified file Trace writes requested to the specified file.

Definition at line 9186 of file UbtConfigGenerated.cs.

◆ Verbose()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.Verbose ( bool present = true )

virtual

The amount of detail to write to the log Increase output verbosity.

Definition at line 8700 of file UbtConfigGenerated.cs.

◆ VeryVerbose()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.VeryVerbose ( bool present = true )

virtual

The amount of detail to write to the log Increase output verbosity more.

Definition at line 8720 of file UbtConfigGenerated.cs.

◆ VSCode()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.VSCode ( bool present = true )

virtual

The mode to execute Generate project files for Visual Studio Code.

Definition at line 9106 of file UbtConfigGenerated.cs.

◆ VSMac()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.VSMac ( bool present = true )

virtual

The mode to execute Generate project files for Visual Studio Mac.

Definition at line 9126 of file UbtConfigGenerated.cs.

◆ WaitMutex()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.WaitMutex ( bool? val = null )

virtual

Whether to wait for the mutex rather than aborting immediately Wait for another instance to finish and then start, rather than aborting immediately.

Definition at line 8843 of file UbtConfigGenerated.cs.

◆ XCodeProjectFiles()

virtual GlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.GlobalOptionsConfig.XCodeProjectFiles ( bool present = true )

virtual

The mode to execute Generate project files for XCode.

Definition at line 9065 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 9305 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 8695 of file UbtConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 8696 of file UbtConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 9306 of file UbtConfigGenerated.cs.

◆ Name

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

get

Definition at line 8694 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

◆ AndroidStudio()

◆ Clean()

◆ CLion()

◆ CMakefile()

◆ CodeliteFiles()

◆ EddieProjectFiles()

◆ EdditProjectFiles()

◆ FromMsBuild()

◆ KDevelopfile()

◆ Log()

◆ Makefile()

◆ Mode()

◆ NoMutex()

◆ Progress()

◆ ProjectFileFormat()

◆ ProjectFiles()

◆ QMakefile()

◆ RemoteIni()

◆ Rider()

◆ Session()

◆ SuppressSDKWarnings()

◆ TelemetryProvider()

◆ Timestamps()

◆ TraceWrites()

◆ Verbose()

◆ VeryVerbose()

◆ VSCode()

◆ VSMac()

◆ WaitMutex()

◆ XCodeProjectFiles()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name