Class ClientServerBootstrap

ClientServerBootstrap is responsible to configure and create the Server and Client worlds at runtime when the game start (in the editor when entering PlayMode). The ClientServerBootstrap is meant to be a base class for your own custom boostrap code and provides utility methods that make it easy creating the client and server worlds. It also support connecting the client to server automatically, using the AutoConnectPort port and DefaultConnectAddress. For the server, it allow binding the server transport to a specific listening port and address (especially useful when running the server on some cloud provider) via DefaultListenAddress.

Inheritance

object

ClientServerBootstrap

Implements

ICustomBootstrap

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.NetCode

Assembly: solution.dll

Syntax

[Preserve]
public class ClientServerBootstrap : ICustomBootstrap

Remarks

We strongly recommend setting Application.runInBackground = true; (or project-wide via Project Settings) once you intend to connect to the server (or accept connections on said server). If you don't, your multiplayer will stall (and likely disconnect) if and when the application loses focus (e.g. by the player tabbing out), as netcode will be unable to tick (due to the application pausing). In fact, a Dedicated Server Build should probably always have Run in Background enabled. We provide suppressible error warnings for this case via WarnAboutApplicationRunInBackground.

Constructors

Name	Description
ClientServerBootstrap()	Initialize the bootstrap class and reset the static data everytime a new instance is created.

Fields

Name	Description
AutoConnectPort	The default port to use for auto connection. The default value is zero, which means do not auto connect. If this is set to a valid port any call to CreateClientWorld - including CreateDefaultWorlds and Initialize - will try to connect to the specified port and address - assuming DefaultConnectAddress is valid. Any call to CreateServerWorld - including CreateDefaultWorlds and Initialize - will listen on the specified port and listen address.
DefaultConnectAddress	The default address to connect to when using auto connect (`AutoConnectPort` is not zero). If this value is `NetworkEndPoint.AnyIpv4` auto connect will not be used, even if the port is specified. This is to allow auto listen without auto connect. The address specified in the `PlayMode Tools` window takes precedence over this when running in the editor (in `PlayType.Client`). If that address is not valid or you are running in a player, then `DefaultConnectAddress` will be used instead.
DefaultListenAddress	The default address to listen on when using auto connect (AutoConnectPort is not zero).
k_MaxNumThinClients	The maximum number of thin clients that can be created in the editor. Created to avoid self-inflicted long editor hangs, although removed as users should be able to test large player counts (e.g. for UTP reasons).

Properties

Name	Description
ClientWorld	A reference to the client world, assigned during the default client world creation. If there were multiple worlds created this will be the first one.
ClientWorlds	A list of all client worlds created during the default creation flow. If this type of world is created manually and not via the bootstrap APIs this list needs to be manually populated.
HasClientWorlds	Check if a world with a GameClient is present. If at least one world with GameClient flags has been created.
HasServerWorld	Check if a world with a GameServer is present. If at least one world with GameServer flags has been created.
RequestedPlayType	The current play mode, used to configure drivers and worlds.
ServerWorld	A reference to the server world, assigned during the default server world creation. If there were multiple worlds created this will be the first one.
ServerWorlds	A list of all server worlds created during the default creation flow. If this type of world is created manually and not via the bootstrap APIs this list needs to be manually populated.
ThinClientWorlds	A list of all thin client worlds created during the default creation flow. If this type of world is created manually and not via the bootstrap APIs this list needs to be manually populated.
WillServerAutoListen	Check if the server should start listening for incoming connection automatically after the world has been created. If the AutoConnectPort is set, the server should start listening for connection using the DefaultConnectAddress and AutoConnectPort.

Methods

Name	Description
CreateClientWorld(string)	Utility method for creating new clients worlds. Can be used in custom implementations of Initialize as well at runtime, to add new clients dynamically.
CreateDefaultClientServerWorlds()	Utility method for creating the default client and server worlds based on the settings in the playmode tools in the editor or client / server defined in a player. Should be used in custom implementations of Initialize.
CreateLocalWorld(string)	Utility method for creating a local world without any NetCode systems. Name of the world instantiated. World with default systems added, set to run as the Main Live world. See WorldFlags.Game
CreateServerWorld(string)	Utility method for creating a new server world. Can be used in custom implementations of Initialize as well as in your game logic (in particular client/server build) when you need to create server programmatically (ex: frontend that allow selecting the role or other logic).
CreateThinClientWorld()	Utility method for creating thin clients worlds. Can be used in custom implementations of Initialize as well at runtime, to add new clients dynamically.
Initialize(string)	Implement the ICustomBootstrap interface. Create the default client and server worlds based on the RequestedPlayType. In the editor, it also creates thin client worlds, if RequestedNumThinClients is not 0.