Nuke.Unreal.Tools.UatConfigGenerated.SyncSourceConfig Class Reference

Helper command to sync only source code + engine files from P4. More...

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

Public Member Functions
virtual SyncSourceConfig	Branch (params object[] values)
	Optional branch depot path, default is: -Branch=//depot/UE4.
virtual SyncSourceConfig	CL (params object[] values)
	Optional changelist to sync (default is latest), -CL=1234567.
virtual SyncSourceConfig	Sync (params object[] values)
	Optional list of branch subforlders to always sync separated with '+', default is: -Sync=Engine/Binaries/ThirdParty+Engine/Content.
virtual SyncSourceConfig	Exclude (params object[] values)
	Optional list of folder names to exclude from syncing, separated with '+', default is: -Exclude=Binaries+Content+Documentation+DataTables.
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

Helper command to sync only source code + engine files from P4.

WARNING: This command might require Perforce

Definition at line 24738 of file UatConfigGenerated.cs.

Member Function Documentation

Branch()

virtual SyncSourceConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncSourceConfig.Branch ( params object[] values )

virtual

Optional branch depot path, default is: -Branch=//depot/UE4.

Definition at line 24745 of file UatConfigGenerated.cs.

CL()

virtual SyncSourceConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncSourceConfig.CL ( params object[] values )

virtual

Optional changelist to sync (default is latest), -CL=1234567.

Definition at line 24764 of file UatConfigGenerated.cs.

Exclude()

virtual SyncSourceConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncSourceConfig.Exclude ( params object[] values )

virtual

Optional list of folder names to exclude from syncing, separated with '+', default is: -Exclude=Binaries+Content+Documentation+DataTables.

Definition at line 24802 of file UatConfigGenerated.cs.

Sync()

virtual SyncSourceConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncSourceConfig.Sync ( params object[] values )

virtual

Optional list of branch subforlders to always sync separated with '+', default is: -Sync=Engine/Binaries/ThirdParty+Engine/Content.

Definition at line 24783 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

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

private

Definition at line 24820 of file UatConfigGenerated.cs.

Property Documentation

CliName

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

get

Definition at line 24741 of file UatConfigGenerated.cs.

Compatibility

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

get

Definition at line 24742 of file UatConfigGenerated.cs.

Configs

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

getprotected

Definition at line 24821 of file UatConfigGenerated.cs.

Name

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

get

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