Launches multiple server processes for a project using the MultiServerReplication plugin. Launches multiple server processes for a project using the MultiServerReplication plugin. More...

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

Public Member Functions
virtual LaunchMultiServerConfig	Project (params object[] values)
	Project to open. Will search current path and paths in ueprojectdirs. Project to open. Will search current path and paths in ueprojectdirs. Defaults to current project (in uShell).

virtual LaunchMultiServerConfig	Map (params object[] values)
	Map to load on startup.

virtual LaunchMultiServerConfig	Client (params object[] values)
	Specify the client type to connect with (proxy or direct or proxy,direct)

virtual LaunchMultiServerConfig	Proxyclientcount (params object[] values)
	Specify how many clients to launch PER SERVER in client=proxy mode.

virtual LaunchMultiServerConfig	Proxybotcount (params object[] values)
	Specify how many bots to launch PER SERVER in client=proxy mode.

virtual LaunchMultiServerConfig	Proxyservercount (params object[] values)
	Specify how many proxy servers to launch in client=proxy mode.

virtual LaunchMultiServerConfig	Nonewconsole (params object[] values)
	Disable launching the new style console.

virtual LaunchMultiServerConfig	Noconsole (params object[] values)
	Disable launching a console (not recommended, but may improve performance)

virtual LaunchMultiServerConfig	Logdebug (params object[] values)

virtual LaunchMultiServerConfig	Logdebugv (params object[] values)

virtual LaunchMultiServerConfig	Notimeouts (params object[] values)
	Disable timeouts (recommended for debugging)

virtual LaunchMultiServerConfig	Proxyclientprimary (params object[] values)
	Specify which game server to prefer as the initial proxy connection, as an integer or the string "random".

virtual LaunchMultiServerConfig	Proxycycleprimary (params object[] values)
	Specify that each subsequent proxy client should choose a different server.

virtual LaunchMultiServerConfig	Attachtoservers (params object[] values)
	Force Visual Studio to attach to the servers when launched (requires VS be launched or it will hang)

virtual LaunchMultiServerConfig	Attachtoclients (params object[] values)
	Force Visual Studio to attach to the clients when launched (requires VS be launched or it will hang)

virtual LaunchMultiServerConfig	CustomConfig (params object[] values)
	Read a different section of the Project's GameConfig for default values.

virtual LaunchMultiServerConfig	NumServers (params object[] values)
	Set the fleet size of servers (default: 2)

virtual LaunchMultiServerConfig	NonLocalServers (params object[] values)
	Specify servers that are not hosted locally but belong to the same fleet.

virtual LaunchMultiServerConfig	CommonArgs (params object[] values)
	Specify arguments that are run by all processes.

virtual LaunchMultiServerConfig	Matchmake (params object[] values)
	Project will use a matchmaking service to connect servers instead of passing the -MultiServerPeers and -ProxyGameServers options to servers.

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

Launches multiple server processes for a project using the MultiServerReplication plugin. Launches multiple server processes for a project using the MultiServerReplication plugin.

Example running 2 hosts locally with a single proxy server & client: -cook -notimeouts -numservers=2 -client=proxy -proxyclientcount=1 -proxycycleprimary

Example running 4 clients locally connecting to single proxy server w/ a non-local cluster of 3: -cook -notimeouts -client=proxy -proxyclientcount=4 -proxycycleprimary -nonlocalservers=172.27.63.109:9001,172.27.63.109:9002,172.27.63.109:9003

Definition at line 37550 of file UatConfigGenerated.cs.

Member Function Documentation

◆ Attachtoclients()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Attachtoclients ( params object[] values )

virtual

Force Visual Studio to attach to the clients when launched (requires VS be launched or it will hang)

Definition at line 37824 of file UatConfigGenerated.cs.

◆ Attachtoservers()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Attachtoservers ( params object[] values )

virtual

Force Visual Studio to attach to the servers when launched (requires VS be launched or it will hang)

Definition at line 37805 of file UatConfigGenerated.cs.

◆ Client()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Client ( params object[] values )

virtual

Specify the client type to connect with (proxy or direct or proxy,direct)

Definition at line 37596 of file UatConfigGenerated.cs.

◆ CommonArgs()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.CommonArgs ( params object[] values )

virtual

Specify arguments that are run by all processes.

Definition at line 37900 of file UatConfigGenerated.cs.

◆ CustomConfig()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.CustomConfig ( params object[] values )

virtual

Read a different section of the Project's GameConfig for default values.

Definition at line 37843 of file UatConfigGenerated.cs.

◆ Logdebug()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Logdebug ( params object[] values )

virtual

Definition at line 37710 of file UatConfigGenerated.cs.

◆ Logdebugv()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Logdebugv ( params object[] values )

virtual

Definition at line 37729 of file UatConfigGenerated.cs.

◆ Map()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Map ( params object[] values )

virtual

Map to load on startup.

Definition at line 37577 of file UatConfigGenerated.cs.

◆ Matchmake()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Matchmake ( params object[] values )

virtual

Project will use a matchmaking service to connect servers instead of passing the -MultiServerPeers and -ProxyGameServers options to servers.

Definition at line 37919 of file UatConfigGenerated.cs.

◆ Noconsole()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Noconsole ( params object[] values )

virtual

Disable launching a console (not recommended, but may improve performance)

Definition at line 37691 of file UatConfigGenerated.cs.

◆ Nonewconsole()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Nonewconsole ( params object[] values )

virtual

Disable launching the new style console.

Definition at line 37672 of file UatConfigGenerated.cs.

◆ NonLocalServers()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.NonLocalServers ( params object[] values )

virtual

Specify servers that are not hosted locally but belong to the same fleet.

Definition at line 37881 of file UatConfigGenerated.cs.

◆ Notimeouts()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Notimeouts ( params object[] values )

virtual

Disable timeouts (recommended for debugging)

Definition at line 37748 of file UatConfigGenerated.cs.

◆ NumServers()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.NumServers ( params object[] values )

virtual

Set the fleet size of servers (default: 2)

Definition at line 37862 of file UatConfigGenerated.cs.

◆ Project()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Project ( params object[] values )

virtual

Project to open. Will search current path and paths in ueprojectdirs. Project to open. Will search current path and paths in ueprojectdirs. Defaults to current project (in uShell).

Definition at line 37558 of file UatConfigGenerated.cs.

◆ Proxybotcount()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Proxybotcount ( params object[] values )

virtual

Specify how many bots to launch PER SERVER in client=proxy mode.

Definition at line 37634 of file UatConfigGenerated.cs.

◆ Proxyclientcount()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Proxyclientcount ( params object[] values )

virtual

Specify how many clients to launch PER SERVER in client=proxy mode.

Definition at line 37615 of file UatConfigGenerated.cs.

◆ Proxyclientprimary()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Proxyclientprimary ( params object[] values )

virtual

Specify which game server to prefer as the initial proxy connection, as an integer or the string "random".

Definition at line 37767 of file UatConfigGenerated.cs.

◆ Proxycycleprimary()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Proxycycleprimary ( params object[] values )

virtual

Specify that each subsequent proxy client should choose a different server.

Definition at line 37786 of file UatConfigGenerated.cs.

◆ Proxyservercount()

virtual LaunchMultiServerConfig Nuke.Unreal.Tools.UatConfigGenerated.LaunchMultiServerConfig.Proxyservercount ( params object[] values )

virtual

Specify how many proxy servers to launch in client=proxy mode.

Definition at line 37653 of file UatConfigGenerated.cs.

Member Data Documentation

◆ _configs

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

private

Definition at line 37937 of file UatConfigGenerated.cs.

Property Documentation

◆ CliName

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

get

Definition at line 37553 of file UatConfigGenerated.cs.

◆ Compatibility

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

get

Definition at line 37554 of file UatConfigGenerated.cs.

◆ Configs

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

getprotected

Definition at line 37938 of file UatConfigGenerated.cs.

◆ Name

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

get

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

◆ Attachtoclients()

◆ Attachtoservers()

◆ Client()

◆ CommonArgs()

◆ CustomConfig()

◆ Logdebug()

◆ Logdebugv()

◆ Map()

◆ Matchmake()

◆ Noconsole()

◆ Nonewconsole()

◆ NonLocalServers()

◆ Notimeouts()

◆ NumServers()

◆ Project()

◆ Proxybotcount()

◆ Proxyclientcount()

◆ Proxyclientprimary()

◆ Proxycycleprimary()

◆ Proxyservercount()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name