Nuke.Unreal.Tools.UatConfigGenerated.BuildGameConfig Class Reference

Builds the game for the specified project. Example BuildGame -project=QAGame -platform=PS4+XboxOne -configuration=Development. Builds the game for the specified project. Example BuildGame -project=QAGame -platform=Win64+Android -configuration=Development. More...

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

Public Member Functions
virtual BuildGameConfig	Project (params object[] values)
	Project to build. Will search current path and paths in ueprojectdirs. 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 BuildGameConfig	Platform (params object[] values)
	Platforms to build, join multiple platforms using + Platform to build.
virtual BuildGameConfig	Configuration (params object[] values)
	Configurations to build, join multiple configurations using +.
virtual BuildGameConfig	Notools (params object[] values)
	Don't build any tools (UHT, ShaderCompiler, CrashReporter Don't build any tools (UnrealPak, Lightmass, ShaderCompiler, CrashReporter.
virtual BuildGameConfig	Target (params object[] values)
	Targets to build, join multiple targets using +.
virtual BuildGameConfig	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 BuildGameConfig	NoXGE (params object[] values)
	Toggle to disable the distributed build process.
virtual BuildGameConfig	DisableUnity (params object[] values)
	Toggle to disable the unity build system.
virtual BuildGameConfig	UBTArgs (params object[] values)
	Extra UBT args.
virtual BuildGameConfig	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 game for the specified project. Example BuildGame -project=QAGame -platform=PS4+XboxOne -configuration=Development. Builds the game for the specified project. Example BuildGame -project=QAGame -platform=Win64+Android -configuration=Development.

Definition at line 19350 of file UatConfigGenerated.cs.

Member Function Documentation

Clean()

virtual BuildGameConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildGameConfig.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 19457 of file UatConfigGenerated.cs.

Configuration()

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

virtual

Configurations to build, join multiple configurations using +.

Definition at line 19398 of file UatConfigGenerated.cs.

DisableUnity()

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

virtual

Toggle to disable the unity build system.

Definition at line 19495 of file UatConfigGenerated.cs.

Notools()

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

virtual

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

Definition at line 19418 of file UatConfigGenerated.cs.

NoXGE()

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

virtual

Toggle to disable the distributed build process.

Definition at line 19476 of file UatConfigGenerated.cs.

Platform()

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

virtual

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

Definition at line 19379 of file UatConfigGenerated.cs.

Preview()

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

virtual

Definition at line 19535 of file UatConfigGenerated.cs.

Project()

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

virtual

Project to build. Will search current path and paths in ueprojectdirs. 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 19359 of file UatConfigGenerated.cs.

Target()

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

virtual

Targets to build, join multiple targets using +.

Definition at line 19437 of file UatConfigGenerated.cs.

UBTArgs()

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

virtual

Extra UBT args.

Definition at line 19516 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 19553 of file UatConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 19353 of file UatConfigGenerated.cs.

Compatibility

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

get

Definition at line 19354 of file UatConfigGenerated.cs.

Configs

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

getprotected

Definition at line 19554 of file UatConfigGenerated.cs.

Name

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

get

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