Nuke.Unreal.Tools.UatConfigGenerated.BuildEditorConfig Class Reference

Builds the editor for the specified project. Example BuildEditor -project=QAGame 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.BuildEditorConfig:

Public Member Functions
virtual BuildEditorConfig	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 BuildEditorConfig	Notools (params object[] values)
	Don't build any tools (UHT, ShaderCompiler, CrashReporter Don't build any tools (UnrealPak, Lightmass, ShaderCompiler, CrashReporter.
virtual BuildEditorConfig	Open (params object[] values)
virtual BuildEditorConfig	Platform (params object[] values)
	Platforms to build, join multiple platforms using + Platform to build.
virtual BuildEditorConfig	Configuration (params object[] values)
	Configurations to build, join multiple configurations using +.
virtual BuildEditorConfig	Target (params object[] values)
	Targets to build, join multiple targets using +.
virtual BuildEditorConfig	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 BuildEditorConfig	NoXGE (params object[] values)
	Toggle to disable the distributed build process.
virtual BuildEditorConfig	DisableUnity (params object[] values)
	Toggle to disable the unity build system.
virtual BuildEditorConfig	UBTArgs (params object[] values)
	Extra UBT args.
virtual BuildEditorConfig	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 editor for the specified project. Example BuildEditor -project=QAGame Note: Editor will only ever build for the current platform in a Development config and required tools will be included.

Definition at line 19117 of file UatConfigGenerated.cs.

Member Function Documentation

Clean()

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

Configuration()

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

virtual

Configurations to build, join multiple configurations using +.

Definition at line 19203 of file UatConfigGenerated.cs.

DisableUnity()

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

virtual

Toggle to disable the unity build system.

Definition at line 19280 of file UatConfigGenerated.cs.

Notools()

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

NoXGE()

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

virtual

Toggle to disable the distributed build process.

Definition at line 19261 of file UatConfigGenerated.cs.

Open()

virtual BuildEditorConfig Nuke.Unreal.Tools.UatConfigGenerated.BuildEditorConfig.Open ( params object[] values )

virtual

Definition at line 19164 of file UatConfigGenerated.cs.

Platform()

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

virtual

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

Definition at line 19184 of file UatConfigGenerated.cs.

Preview()

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

virtual

Definition at line 19320 of file UatConfigGenerated.cs.

Project()

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

Target()

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

virtual

Targets to build, join multiple targets using +.

Definition at line 19222 of file UatConfigGenerated.cs.

UBTArgs()

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

virtual

Extra UBT args.

Definition at line 19301 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 19338 of file UatConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 19120 of file UatConfigGenerated.cs.

Compatibility

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

get

Definition at line 19121 of file UatConfigGenerated.cs.

Configs

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

getprotected

Definition at line 19339 of file UatConfigGenerated.cs.

Name

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

get

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