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

Execute a World Partition builder. More...

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

Public Member Functions

virtual WorldPartitionBuilderConfig Submit (params object[] values)
 If the files modified by the builder should be submitted at the end of the process.
 
virtual WorldPartitionBuilderConfig Builder (params object[] values)
 Name of the builder to run.
 
virtual WorldPartitionBuilderConfig CommandletArgs (params object[] values)
 Arguments to provide to the builder commandlet.
 
virtual WorldPartitionBuilderConfig ShelveUser (params object[] values)
 If provided (along with -ShelveWorkspace, modified files will be shelved for the P4 User in the specified Workspace.
 
virtual WorldPartitionBuilderConfig ShelveWorkspace (params object[] values)
 If provided (along with -ShelveUser, modified files will be shelved for the P4 User in the specified Workspace.
 
- 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

Execute a World Partition builder.

Definition at line 33442 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Builder()

virtual WorldPartitionBuilderConfig Nuke.Unreal.Tools.UatConfigGenerated.WorldPartitionBuilderConfig.Builder ( params object[] values)
virtual

Name of the builder to run.

Definition at line 33468 of file UatConfigGenerated.cs.

◆ CommandletArgs()

virtual WorldPartitionBuilderConfig Nuke.Unreal.Tools.UatConfigGenerated.WorldPartitionBuilderConfig.CommandletArgs ( params object[] values)
virtual

Arguments to provide to the builder commandlet.

Definition at line 33487 of file UatConfigGenerated.cs.

◆ ShelveUser()

virtual WorldPartitionBuilderConfig Nuke.Unreal.Tools.UatConfigGenerated.WorldPartitionBuilderConfig.ShelveUser ( params object[] values)
virtual

If provided (along with -ShelveWorkspace, modified files will be shelved for the P4 User in the specified Workspace.

Definition at line 33506 of file UatConfigGenerated.cs.

◆ ShelveWorkspace()

virtual WorldPartitionBuilderConfig Nuke.Unreal.Tools.UatConfigGenerated.WorldPartitionBuilderConfig.ShelveWorkspace ( params object[] values)
virtual

If provided (along with -ShelveUser, modified files will be shelved for the P4 User in the specified Workspace.

Definition at line 33525 of file UatConfigGenerated.cs.

◆ Submit()

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

If the files modified by the builder should be submitted at the end of the process.

Definition at line 33449 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

Definition at line 33543 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

Definition at line 33445 of file UatConfigGenerated.cs.

◆ Compatibility

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

Definition at line 33446 of file UatConfigGenerated.cs.

◆ Configs

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

Definition at line 33544 of file UatConfigGenerated.cs.

◆ Name

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

Definition at line 33444 of file UatConfigGenerated.cs.


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