Executes scripted commands. More...

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

Public Member Functions
virtual AutomationConfig	Verbose (params object[] values)
	Enables verbose logging.

virtual AutomationConfig	Nop4 (params object[] values)
	Disables Perforce functionality (default if not run on a build machine)

virtual AutomationConfig	P4 (params object[] values)
	Enables Perforce functionality (default if run on a build machine)

virtual AutomationConfig	Compileonly (params object[] values)
	Does not run any commands, only compiles them.

virtual AutomationConfig	Compile (params object[] values)
	Dynamically compiles all commands (otherwise assumes they are already built)

virtual AutomationConfig	Help (params object[] values)
	Displays help.

virtual AutomationConfig	List (params object[] values)
	Lists all available commands.

virtual AutomationConfig	Submit (params object[] values)
	Allows UAT command to submit changes.

virtual AutomationConfig	Nosubmit (params object[] values)
	Prevents any submit attempts.

virtual AutomationConfig	Nokill (params object[] values)
	Does not kill any spawned processes on exit.

virtual AutomationConfig	Ignorejunk (params object[] values)
	Prevents UBT from cleaning junk files.

virtual AutomationConfig	UseLocalBuildStorage (params object[] values)
	Allows you to use local storage for your root build storage dir (default of P:\Builds (on PC) is changed to Engine\Saved\LocalBuilds). Used for local testing.

virtual AutomationConfig	Telemetry (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

Executes scripted commands.

AutomationTool.exe [-verbose] [-compileonly] [-p4] Command0 [-Arg0 -Arg1 -Arg2 ...] Command1 [-Arg0 -Arg1 ...] Command2 [-Arg0 ...] Commandn ... [EnvVar0=MyValue0 ... EnvVarn=MyValuen]

Definition at line 4763 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Compile()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Compile ( params object[] values )

virtual

Dynamically compiles all commands (otherwise assumes they are already built)

Definition at line 4846 of file UatConfigGenerated.cs.

◆ Compileonly()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Compileonly ( params object[] values )

virtual

Does not run any commands, only compiles them.

Definition at line 4827 of file UatConfigGenerated.cs.

◆ Help()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Help ( params object[] values )

virtual

Displays help.

Definition at line 4865 of file UatConfigGenerated.cs.

◆ Ignorejunk()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Ignorejunk ( params object[] values )

virtual

Prevents UBT from cleaning junk files.

Definition at line 4960 of file UatConfigGenerated.cs.

◆ List()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.List ( params object[] values )

virtual

Lists all available commands.

Definition at line 4884 of file UatConfigGenerated.cs.

◆ Nokill()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Nokill ( params object[] values )

virtual

Does not kill any spawned processes on exit.

Definition at line 4941 of file UatConfigGenerated.cs.

◆ Nop4()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Nop4 ( params object[] values )

virtual

Disables Perforce functionality (default if not run on a build machine)

Definition at line 4789 of file UatConfigGenerated.cs.

◆ Nosubmit()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Nosubmit ( params object[] values )

virtual

Prevents any submit attempts.

Definition at line 4922 of file UatConfigGenerated.cs.

◆ P4()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.P4 ( params object[] values )

virtual

Enables Perforce functionality (default if run on a build machine)

Definition at line 4808 of file UatConfigGenerated.cs.

◆ Submit()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Submit ( params object[] values )

virtual

Allows UAT command to submit changes.

Definition at line 4903 of file UatConfigGenerated.cs.

◆ Telemetry()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Telemetry ( params object[] values )

virtual

Definition at line 4998 of file UatConfigGenerated.cs.

◆ UseLocalBuildStorage()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.UseLocalBuildStorage ( params object[] values )

virtual

Allows you to use local storage for your root build storage dir (default of P:\Builds (on PC) is changed to Engine\Saved\LocalBuilds). Used for local testing.

Definition at line 4979 of file UatConfigGenerated.cs.

◆ Verbose()

virtual AutomationConfig Nuke.Unreal.Tools.UatConfigGenerated.AutomationConfig.Verbose ( params object[] values )

virtual

Enables verbose logging.

Definition at line 4770 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 5016 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 4766 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 4767 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 5017 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ Compile()

◆ Compileonly()

◆ Help()

◆ Ignorejunk()

◆ List()

◆ Nokill()

◆ Nop4()

◆ Nosubmit()

◆ P4()

◆ Submit()

◆ Telemetry()

◆ UseLocalBuildStorage()

◆ Verbose()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name