Nuke.Unreal.Tools.ToolConfig Class Reference

The base class for generated strongly typed tool configurators providing base functionalities like argument and subtool management. More...

Inheritance diagram for Nuke.Unreal.Tools.ToolConfig:

Public Member Functions
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.

Protected Attributes
List< UnrealToolArgument >	UsingArguments = []
readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Properties
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]

Detailed Description

The base class for generated strongly typed tool configurators providing base functionalities like argument and subtool management.

Definition at line 15 of file ToolConfig.cs.

Member Function Documentation

AppendArgument() [1/2]

virtual void Nuke.Unreal.Tools.ToolConfig.AppendArgument ( string arg, UnrealToolArgumentMeta? meta = null )

virtual

Definition at line 52 of file ToolConfig.cs.

AppendArgument() [2/2]

virtual void Nuke.Unreal.Tools.ToolConfig.AppendArgument ( UnrealToolArgument arg )

virtual

Definition at line 39 of file ToolConfig.cs.

AppendSubtool()

virtual void Nuke.Unreal.Tools.ToolConfig.AppendSubtool ( ToolConfig subtool )

virtual

Definition at line 57 of file ToolConfig.cs.

Gather()

virtual string Nuke.Unreal.Tools.ToolConfig.Gather ( EngineVersion ueVersion )

virtual

Gether the arguments and subtools and render a command line output.

Parameters

ueVersion

Returns

The command line output to be passed to the wrapped tool

Definition at line 67 of file ToolConfig.cs.

Member Data Documentation

UsingArguments

List<UnrealToolArgument> Nuke.Unreal.Tools.ToolConfig.UsingArguments = []

protected

Definition at line 34 of file ToolConfig.cs.

UsingSubtools

readonly Dictionary<string, ToolConfig> Nuke.Unreal.Tools.ToolConfig.UsingSubtools = []

protected

Definition at line 35 of file ToolConfig.cs.

Property Documentation

CliName

string Nuke.Unreal.Tools.ToolConfig.CliName

getabstract

The name which will be rendered onto command line.

Definition at line 25 of file ToolConfig.cs.

Compatibility

UnrealCompatibility Nuke.Unreal.Tools.ToolConfig.Compatibility

getabstract

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.

Definition at line 32 of file ToolConfig.cs.

Configs

virtual ToolConfig [] Nuke.Unreal.Tools.ToolConfig.Configs

getprotected

Definition at line 37 of file ToolConfig.cs.

Name

string Nuke.Unreal.Tools.ToolConfig.Name

getabstract

The C# friendly name of the tool which will be used inside configurators.

Definition at line 20 of file ToolConfig.cs.

---

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

• /home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/ToolConfig.cs