Syncs a clean clientspec (should NOT be the client you are running this out of), and mirrors it into another p4 server via 3 streams. See the SyncPerforceServers.cs for details. More...

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

Public Member Functions
virtual SyncPerforceServersConfig	SourceClient (params object[] values)
	p4 client on the source server (which is the active server that normal UAT p4 scripts would use

virtual SyncPerforceServersConfig	Server (params object[] values)
	p4 server for the target (in the format server:port). There needs to be a client mapped to same directory as SourceClient is mapped to

virtual SyncPerforceServersConfig	User (params object[] values)
	(optional) p4 username on the target server

virtual SyncPerforceServersConfig	SyncList (params object[] values)
	(optional) a + separated list of p4 file paths to sync when getting latest from source stream (//Server/UE5/Engine/...+//Server/UE5/Templates/...

virtual SyncPerforceServersConfig	SyncListFile (params object[] values)
	(optional) a text file that contains a list of p4 paths to sync, one per line. It can contain - prefixed lines to remove subpaths from being copied to target server

virtual SyncPerforceServersConfig	Submit (params object[] values)
	REQUIRED for this script to work (it's actually processed by different code, so it must be specified)

virtual SyncPerforceServersConfig	HideSpew (params object[] values)
	If specified, this command will not list the file outputs in each command.

virtual SyncPerforceServersConfig	SkipSync (params object[] values)
	If specified, the sync from SourceClient will not be preformed.

virtual SyncPerforceServersConfig	SkipReconcile (params object[] values)
	If specified, the reconcile into the target server's incoming stream will not be performed.

virtual SyncPerforceServersConfig	SkipMergeToStaging (params object[] values)
	If specified, the merge from Incoming and Main streams into the Staging stream will not be performed.

virtual SyncPerforceServersConfig	SkipCopyToMain (params object[] values)
	If specified, the final copy from Staging to Main will not be performed.

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

Syncs a clean clientspec (should NOT be the client you are running this out of), and mirrors it into another p4 server via 3 streams. See the SyncPerforceServers.cs for details.

WARNING: This command might require Perforce

Definition at line 35597 of file UatConfigGenerated.cs.

Member Function Documentation

◆ HideSpew()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.HideSpew ( params object[] values )

virtual

If specified, this command will not list the file outputs in each command.

Definition at line 35718 of file UatConfigGenerated.cs.

◆ Server()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.Server ( params object[] values )

virtual

p4 server for the target (in the format server:port). There needs to be a client mapped to same directory as SourceClient is mapped to

Definition at line 35623 of file UatConfigGenerated.cs.

◆ SkipCopyToMain()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SkipCopyToMain ( params object[] values )

virtual

If specified, the final copy from Staging to Main will not be performed.

Definition at line 35794 of file UatConfigGenerated.cs.

◆ SkipMergeToStaging()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SkipMergeToStaging ( params object[] values )

virtual

If specified, the merge from Incoming and Main streams into the Staging stream will not be performed.

Definition at line 35775 of file UatConfigGenerated.cs.

◆ SkipReconcile()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SkipReconcile ( params object[] values )

virtual

If specified, the reconcile into the target server's incoming stream will not be performed.

Definition at line 35756 of file UatConfigGenerated.cs.

◆ SkipSync()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SkipSync ( params object[] values )

virtual

If specified, the sync from SourceClient will not be preformed.

Definition at line 35737 of file UatConfigGenerated.cs.

◆ SourceClient()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SourceClient ( params object[] values )

virtual

p4 client on the source server (which is the active server that normal UAT p4 scripts would use

Definition at line 35604 of file UatConfigGenerated.cs.

◆ Submit()

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

virtual

REQUIRED for this script to work (it's actually processed by different code, so it must be specified)

Definition at line 35699 of file UatConfigGenerated.cs.

◆ SyncList()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SyncList ( params object[] values )

virtual

(optional) a + separated list of p4 file paths to sync when getting latest from source stream (//Server/UE5/Engine/...+//Server/UE5/Templates/...

Definition at line 35661 of file UatConfigGenerated.cs.

◆ SyncListFile()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.SyncListFile ( params object[] values )

virtual

(optional) a text file that contains a list of p4 paths to sync, one per line. It can contain - prefixed lines to remove subpaths from being copied to target server

Definition at line 35680 of file UatConfigGenerated.cs.

◆ User()

virtual SyncPerforceServersConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncPerforceServersConfig.User ( params object[] values )

virtual

(optional) p4 username on the target server

Definition at line 35642 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 35812 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 35600 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 35601 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 35813 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ HideSpew()

◆ Server()

◆ SkipCopyToMain()

◆ SkipMergeToStaging()

◆ SkipReconcile()

◆ SkipSync()

◆ SourceClient()

◆ Submit()

◆ SyncList()

◆ SyncListFile()

◆ User()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name