Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig Class Reference

Builds the server for the specified project. Example BuildServer -project=QAGame -platform=Win64 -configuration=Development. More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig:
Nuke.Unreal.Tools.ToolConfig

Public Member Functions

virtual BuildServerConfig 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 BuildServerConfig Platform (params object[] values)
 Platforms to build, join multiple platforms using + Platform to build.
 
virtual BuildServerConfig Configuration (params object[] values)
 Configurations to build, join multiple configurations using +.
 
virtual BuildServerConfig Notools (params object[] values)
 Don't build any tools (UHT, ShaderCompiler, CrashReporter Don't build any tools (UnrealPak, Lightmass, ShaderCompiler, CrashReporter.
 
virtual BuildServerConfig Target (params object[] values)
 Targets to build, join multiple targets using +.
 
virtual BuildServerConfig 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 BuildServerConfig NoXGE (params object[] values)
 Toggle to disable the distributed build process.
 
virtual BuildServerConfig DisableUnity (params object[] values)
 Toggle to disable the unity build system.
 
virtual BuildServerConfig UBTArgs (params object[] values)
 Extra UBT args.
 
virtual BuildServerConfig 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< UnrealToolArgumentUsingArguments = []
 
readonly Dictionary< string, ToolConfigUsingSubtools = []
 

Detailed Description

Builds the server for the specified project. Example BuildServer -project=QAGame -platform=Win64 -configuration=Development.

Definition at line 19563 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Clean()

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

◆ Configuration()

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

Configurations to build, join multiple configurations using +.

Definition at line 19611 of file UatConfigGenerated.cs.

◆ DisableUnity()

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

Toggle to disable the unity build system.

Definition at line 19708 of file UatConfigGenerated.cs.

◆ Notools()

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

◆ NoXGE()

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

Toggle to disable the distributed build process.

Definition at line 19689 of file UatConfigGenerated.cs.

◆ Platform()

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

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

Definition at line 19592 of file UatConfigGenerated.cs.

◆ Preview()

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

Definition at line 19748 of file UatConfigGenerated.cs.

◆ Project()

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

◆ Target()

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

Targets to build, join multiple targets using +.

Definition at line 19650 of file UatConfigGenerated.cs.

◆ UBTArgs()

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

Extra UBT args.

Definition at line 19729 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig._configs = null
private

Definition at line 19766 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig.CliName
get

Definition at line 19566 of file UatConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig.Compatibility
get

Definition at line 19567 of file UatConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig.Configs
getprotected

Definition at line 19767 of file UatConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UatConfigGenerated.BuildServerConfig.Name
get

Definition at line 19565 of file UatConfigGenerated.cs.


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