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

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

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

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

virtual UhtGlobalOptionsConfig	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/UnrealHeaderTool/Saved/Logs/UnrealHeaderTool.log.

virtual UhtGlobalOptionsConfig	Timestamps (bool? val=null)
	Whether to include timestamps in the log Include timestamps in the log.

virtual UhtGlobalOptionsConfig	FromMsBuild (bool? val=null)
	Whether to format messages in MsBuild format Format messages for msbuild.

virtual UhtGlobalOptionsConfig	NoLog (bool? val=null)
	Disables all logging including the default log location Disable log file creation including the default log file.

virtual UhtGlobalOptionsConfig	Test (bool? val=null)
	Run testing scripts.

virtual UhtGlobalOptionsConfig	WarningsAsErrors (bool? val=null)
	Treat warnings as errors.

virtual UhtGlobalOptionsConfig	NoGoWide (bool? val=null)
	Disable concurrent parsing and code generation.

virtual UhtGlobalOptionsConfig	WriteRef (bool? val=null)
	Write all the output to a reference directory.

virtual UhtGlobalOptionsConfig	VerifyRef (bool? val=null)
	Write all the output to a verification directory and compare to the reference output.

virtual UhtGlobalOptionsConfig	FailIfGeneratedCodeChanges (bool? val=null)
	Consider any changes to output files as being an error.

virtual UhtGlobalOptionsConfig	NoOutput (bool? val=null)
	Do not save any output files other than reference output.

virtual UhtGlobalOptionsConfig	IncludeDebugOutput (bool? val=null)
	Include extra content in generated output to assist with debugging.

virtual UhtGlobalOptionsConfig	NoDefaultExporters (bool? val=null)
	Disable all default exporters. Useful for when a specific exporter is to be run.

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 18098 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ FailIfGeneratedCodeChanges()

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

virtual

Consider any changes to output files as being an error.

Definition at line 18320 of file UbtConfigGenerated.cs.

◆ FromMsBuild()

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

virtual

Whether to format messages in MsBuild format Format messages for msbuild.

Definition at line 18186 of file UbtConfigGenerated.cs.

◆ IncludeDebugOutput()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.IncludeDebugOutput ( bool? val = null )

virtual

Include extra content in generated output to assist with debugging.

Definition at line 18358 of file UbtConfigGenerated.cs.

◆ Log()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.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/UnrealHeaderTool/Saved/Logs/UnrealHeaderTool.log.

Definition at line 18146 of file UbtConfigGenerated.cs.

◆ NoDefaultExporters()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.NoDefaultExporters ( bool? val = null )

virtual

Disable all default exporters. Useful for when a specific exporter is to be run.

Definition at line 18377 of file UbtConfigGenerated.cs.

◆ NoGoWide()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.NoGoWide ( bool? val = null )

virtual

Disable concurrent parsing and code generation.

Definition at line 18263 of file UbtConfigGenerated.cs.

◆ NoLog()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.NoLog ( bool? val = null )

virtual

Disables all logging including the default log location Disable log file creation including the default log file.

Definition at line 18206 of file UbtConfigGenerated.cs.

◆ NoOutput()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.NoOutput ( bool? val = null )

virtual

Do not save any output files other than reference output.

Definition at line 18339 of file UbtConfigGenerated.cs.

◆ Test()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.Test ( bool? val = null )

virtual

Run testing scripts.

Definition at line 18225 of file UbtConfigGenerated.cs.

◆ Timestamps()

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

virtual

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

Definition at line 18166 of file UbtConfigGenerated.cs.

◆ Verbose()

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

virtual

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

Definition at line 18106 of file UbtConfigGenerated.cs.

◆ VerifyRef()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.VerifyRef ( bool? val = null )

virtual

Write all the output to a verification directory and compare to the reference output.

Definition at line 18301 of file UbtConfigGenerated.cs.

◆ VeryVerbose()

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

virtual

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

Definition at line 18126 of file UbtConfigGenerated.cs.

◆ WarningsAsErrors()

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

virtual

Treat warnings as errors.

Definition at line 18244 of file UbtConfigGenerated.cs.

◆ WriteRef()

virtual UhtGlobalOptionsConfig Nuke.Unreal.Tools.UbtConfigGenerated.UhtGlobalOptionsConfig.WriteRef ( bool? val = null )

virtual

Write all the output to a reference directory.

Definition at line 18282 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 18395 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 18101 of file UbtConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 18102 of file UbtConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 18396 of file UbtConfigGenerated.cs.

◆ Name

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

get

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

◆ FailIfGeneratedCodeChanges()

◆ FromMsBuild()

◆ IncludeDebugOutput()

◆ Log()

◆ NoDefaultExporters()

◆ NoGoWide()

◆ NoLog()

◆ NoOutput()

◆ Test()

◆ Timestamps()

◆ Verbose()

◆ VerifyRef()

◆ VeryVerbose()

◆ WarningsAsErrors()

◆ WriteRef()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name