Builds the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=PS4+XboxOne -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included Builds the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=Win64+Android -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included. More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig:

Public Member Functions
virtual BuildTargetConfig	Project (params object[] values)
	Project to build. Will search current path and paths in ueprojectdirs. If omitted will build vanilla UE4Editor Project to build. Will search current path and paths in ueprojectdirs. If omitted will build vanilla UnrealEditor.

virtual BuildTargetConfig	Platform (params object[] values)
	Platforms to build, join multiple platforms using + Platform to build.

virtual BuildTargetConfig	Configuration (params object[] values)
	Configurations to build, join multiple configurations using +.

virtual BuildTargetConfig	Target (params object[] values)
	Targets to build, join multiple targets using +.

virtual BuildTargetConfig	Notools (params object[] values)
	Don't build any tools (UnrealPak, Lightmass, ShaderCompiler, CrashReporter.

virtual BuildTargetConfig	Clean (params object[] values)
	Do a clean build Whether to clean this target. If not specified, the target will be cleaned if -Clean is on the command line.

virtual BuildTargetConfig	NoXGE (params object[] values)
	Toggle to disable the distributed build process.

virtual BuildTargetConfig	DisableUnity (params object[] values)
	Toggle to disable the unity build system.

virtual BuildTargetConfig	UBTArgs (params object[] values)
	Extra UBT args.

virtual BuildTargetConfig	Preview (params object[] values)

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 the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=PS4+XboxOne -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included Builds the specified targets and configurations for the specified project. Example BuildTarget -project=QAGame -target=Editor+Game -platform=Win64+Android -configuration=Development. Note: Editor will only ever build for the current platform in a Development config and required tools will be included.

Definition at line 9291 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Clean()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Clean ( params object[] values )

virtual

Do a clean build Whether to clean this target. If not specified, the target will be cleaned if -Clean is on the command line.

Definition at line 9396 of file UatConfigGenerated.cs.

◆ Configuration()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Configuration ( params object[] values )

virtual

Configurations to build, join multiple configurations using +.

Definition at line 9338 of file UatConfigGenerated.cs.

◆ DisableUnity()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.DisableUnity ( params object[] values )

virtual

Toggle to disable the unity build system.

Definition at line 9434 of file UatConfigGenerated.cs.

◆ Notools()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Notools ( params object[] values )

virtual

Don't build any tools (UnrealPak, Lightmass, ShaderCompiler, CrashReporter.

Definition at line 9376 of file UatConfigGenerated.cs.

◆ NoXGE()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.NoXGE ( params object[] values )

virtual

Toggle to disable the distributed build process.

Definition at line 9415 of file UatConfigGenerated.cs.

◆ Platform()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Platform ( params object[] values )

virtual

Platforms to build, join multiple platforms using + Platform to build.

Definition at line 9319 of file UatConfigGenerated.cs.

◆ Preview()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Preview ( params object[] values )

virtual

Definition at line 9474 of file UatConfigGenerated.cs.

◆ Project()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Project ( params object[] values )

virtual

Project to build. Will search current path and paths in ueprojectdirs. If omitted will build vanilla UE4Editor Project to build. Will search current path and paths in ueprojectdirs. If omitted will build vanilla UnrealEditor.

Definition at line 9299 of file UatConfigGenerated.cs.

◆ Target()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Target ( params object[] values )

virtual

Targets to build, join multiple targets using +.

Definition at line 9357 of file UatConfigGenerated.cs.

◆ UBTArgs()

virtual BuildTargetConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.UBTArgs ( params object[] values )

virtual

Extra UBT args.

Definition at line 9455 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig._configs = null

private

Definition at line 9492 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.CliName

get

Definition at line 9294 of file UatConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Compatibility

get

Definition at line 9295 of file UatConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Configs

getprotected

Definition at line 9493 of file UatConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildTargetConfig.Name

get

Definition at line 9293 of file UatConfigGenerated.cs.

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

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

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clean()

◆ Configuration()

◆ DisableUnity()

◆ Notools()

◆ NoXGE()

◆ Platform()

◆ Preview()

◆ Project()

◆ Target()

◆ UBTArgs()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name