Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig Class Reference

Builds a target. More...

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

Public Member Functions
virtual BuildConfig	IgnoreJunk (bool? val=null)
	Whether to skip checking for files identified by the junk manifest.
virtual BuildConfig	SkipBuild (bool? val=null)
	Skip building; just do setup and terminate.
virtual BuildConfig	SkipPreBuildTargets (bool? val=null)
	Skip pre build targets; just do the main target.
virtual BuildConfig	XGEExport (bool? val=null)
	Whether we should just export the XGE XML and pretend it succeeded.
virtual BuildConfig	NoEngineChanges (bool? val=null)
	Do not allow any engine files to be output (used by compile on startup functionality)
virtual BuildConfig	WriteOutdatedActions (object val=null)
	Whether we should just export the outdated actions list.
virtual BuildConfig	SaveCrashDumps (object val=null)
	An optional directory to copy crash dump files into.
virtual BuildConfig	ActionTypeFilter (object val=null)
	If specified, then only this type of action will execute.
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

Builds a target.

Definition at line 13613 of file UbtConfigGenerated.cs.

Member Function Documentation

ActionTypeFilter()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.ActionTypeFilter ( object val = null )

virtual

If specified, then only this type of action will execute.

Definition at line 13769 of file UbtConfigGenerated.cs.

IgnoreJunk()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.IgnoreJunk ( bool? val = null )

virtual

Whether to skip checking for files identified by the junk manifest.

Definition at line 13622 of file UbtConfigGenerated.cs.

NoEngineChanges()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.NoEngineChanges ( bool? val = null )

virtual

Do not allow any engine files to be output (used by compile on startup functionality)

Definition at line 13706 of file UbtConfigGenerated.cs.

SaveCrashDumps()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.SaveCrashDumps ( object val = null )

virtual

An optional directory to copy crash dump files into.

Definition at line 13748 of file UbtConfigGenerated.cs.

SkipBuild()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.SkipBuild ( bool? val = null )

virtual

Skip building; just do setup and terminate.

Definition at line 13643 of file UbtConfigGenerated.cs.

SkipPreBuildTargets()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.SkipPreBuildTargets ( bool? val = null )

virtual

Skip pre build targets; just do the main target.

Definition at line 13664 of file UbtConfigGenerated.cs.

WriteOutdatedActions()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.WriteOutdatedActions ( object val = null )

virtual

Whether we should just export the outdated actions list.

Definition at line 13727 of file UbtConfigGenerated.cs.

XGEExport()

virtual BuildConfig Nuke.Unreal.Tools.UbtConfigGenerated.BuildConfig.XGEExport ( bool? val = null )

virtual

Whether we should just export the XGE XML and pretend it succeeded.

Definition at line 13685 of file UbtConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 13787 of file UbtConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 13616 of file UbtConfigGenerated.cs.

Compatibility

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

get

Definition at line 13617 of file UbtConfigGenerated.cs.

Configs

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

getprotected

Definition at line 13788 of file UbtConfigGenerated.cs.

Name

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

get

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