Class NetworkManager

Inheritance

Object

NetworkManager

NetworkRoomManager

Namespace: Mirror

Assembly: doc.dll

Syntax

public class NetworkManager : MonoBehaviour

Fields

authenticator

Declaration

public NetworkAuthenticator authenticator

Field Value

Type	Description
NetworkAuthenticator

autoCreatePlayer

A flag to control whether or not player objects are automatically created on connect, and on scene change.

Declaration

public bool autoCreatePlayer

Field Value

Type	Description
Boolean

autoStartServerBuild

Automatically invoke StartServer()

If the application is a Server Build, StartServer is automatically invoked.

Server build is true when "Server build" is checked in build menu, or BuildOptions.EnableHeadlessMode flag is in BuildOptions

Declaration

public bool autoStartServerBuild

Field Value

Type	Description
Boolean

clientLoadedScene

This is true if the client loaded a new scene when connecting to the server.

This is set before OnClientConnect is called, so it can be checked there to perform different logic if a scene load occurred.

Declaration

public bool clientLoadedScene

Field Value

Type	Description
Boolean

disconnectInactiveConnections

Should the server disconnect remote connections that have gone silent for more than Server Idle Timeout?

Declaration

public bool disconnectInactiveConnections

Field Value

Type	Description
Boolean

disconnectInactiveTimeout

Timeout in seconds since last message from a client after which server will auto-disconnect.

By default, clients send at least a Ping message every 2 seconds.

The Host client is immune from idle timeout disconnection.

Default value is 60 seconds.

Declaration

public float disconnectInactiveTimeout

Field Value

Type	Description
Single

dontDestroyOnLoad

A flag to control whether the NetworkManager object is destroyed when the scene changes.

This should be set if your game has a single NetworkManager that exists for the lifetime of the process. If there is a NetworkManager in each scene, then this should not be set.

Declaration

public bool dontDestroyOnLoad

Field Value

Type	Description
Boolean

isNetworkActive

True if the server or client is started and running

This is set True in StartServer / StartClient, and set False in StopServer / StopClient

Declaration

public bool isNetworkActive

Field Value

Type	Description
Boolean

loadingSceneAsync

Declaration

public static UnityEngine.AsyncOperation loadingSceneAsync

Field Value

Type	Description
UnityEngine.AsyncOperation

maxConnections

The maximum number of concurrent network connections to support.

This effects the memory usage of the network layer.

Declaration

public int maxConnections

Field Value

Type	Description
Int32

networkAddress

The network address currently in use.

For clients, this is the address of the server that is connected to. For servers, this is the local address.

Declaration

public string networkAddress

Field Value

Type	Description
String

offlineScene

The scene to switch to when offline.

Setting this makes the NetworkManager do scene management. This scene will be switched to when a network session is completed - such as a client disconnect, or a server shutdown.

Declaration

public string offlineScene

Field Value

Type	Description
String

onlineScene

The scene to switch to when online.

Setting this makes the NetworkManager do scene management. This scene will be switched to when a network session is started - such as a client connect, or a server listen.

Declaration

public string onlineScene

Field Value

Type	Description
String

playerPrefab

The default prefab to be used to create player objects on the server.

Player objects are created in the default handler for AddPlayer() on the server. Implementing OnServerAddPlayer overrides this behaviour.

Declaration

public GameObject playerPrefab

Field Value

Type	Description
GameObject

playerSpawnMethod

The current method of spawning players used by the NetworkManager.

Declaration

public PlayerSpawnMethod playerSpawnMethod

Field Value

Type	Description
PlayerSpawnMethod

runInBackground

Controls whether the program runs when it is in the background.

This is required when multiple instances of a program using networking are running on the same machine, such as when testing using localhost. But this is not recommended when deploying to mobile platforms.

Declaration

public bool runInBackground

Field Value

Type	Description
Boolean

serverTickRate

Server Update frequency, per second. Use around 60Hz for fast paced games like Counter-Strike to minimize latency. Use around 30Hz for games like WoW to minimize computations. Use around 1-10Hz for slow paced games like EVE.

Declaration

public int serverTickRate

Field Value

Type	Description
Int32

showDebugMessages

Enables verbose debug messages in the console

Declaration

public bool showDebugMessages

Field Value

Type	Description
Boolean

spawnPrefabs

List of prefabs that will be registered with the spawning system.

For each of these prefabs, ClientScene.RegisterPrefab() will be automatically invoked.

Declaration

public List<GameObject> spawnPrefabs

Field Value

Type	Description
List<GameObject>

startPositionIndex

Declaration

public static int startPositionIndex

Field Value

Type	Description
Int32

startPositions

List of transforms populted by NetworkStartPosition components found in the scene.

Declaration

public static List<Transform> startPositions

Field Value

Type	Description
List<Transform>

transport

Declaration

protected Transport transport

Field Value

Type	Description
Transport

Properties

mode

Declaration

public NetworkManagerMode mode { get; }

Property Value

Type	Description
NetworkManagerMode

networkSceneName

The name of the current network scene.

Declaration

public static string networkSceneName { get; protected set; }

Property Value

Type	Description
String

Remarks

This is populated if the NetworkManager is doing scene management. Calls to ServerChangeScene() cause this to change. New clients that connect to a server will automatically load this scene.

This is used to make sure that all scene changes are initialized by Mirror.

Loading a scene manually wont set networkSceneName, so Mirror would still load it again on start.

numPlayers

Number of active player objects across all connections on the server.

This is only valid on the host / server.

Declaration

public int numPlayers { get; }

Property Value

Type	Description
Int32

singleton

NetworkManager singleton

Declaration

public static NetworkManager singleton { get; }

Property Value

Type	Description
NetworkManager

Methods

Awake()

virtual so that inheriting classes' Awake() can call base.Awake() too

Declaration

public virtual void Awake()

ConfigureServerFrameRate()

Set the frame rate for a headless server.

Override if you wish to disable the behavior or set your own tick rate.

Declaration

public virtual void ConfigureServerFrameRate()

GetStartPosition()

This finds a spawn position based on NetworkStartPosition objects in the scene.

This is used by the default implementation of OnServerAddPlayer.

Declaration

public Transform GetStartPosition()

Returns

Type	Description
Transform	Returns the transform to spawn a player at, or null.

IsSceneActive(String)

Declaration

public static bool IsSceneActive(string scene)

Parameters

Type	Name	Description
String	scene

Returns

Type	Description
Boolean

LateUpdate()

virtual so that inheriting classes' LateUpdate() can call base.LateUpdate() too

Declaration

public virtual void LateUpdate()

OnApplicationQuit()

called when quitting the application by closing the window / pressing stop in the editor

virtual so that inheriting classes' OnApplicationQuit() can call base.OnApplicationQuit() too

Declaration

public virtual void OnApplicationQuit()

OnClientChangeScene(String, SceneOperation, Boolean)

Called from ClientChangeScene immediately before SceneManager.LoadSceneAsync is executed

This allows client to do work / cleanup / prep before the scene changes.

Declaration

public virtual void OnClientChangeScene(string newSceneName, SceneOperation sceneOperation, bool customHandling)

Parameters

Type	Name	Description
String	newSceneName	Name of the scene that's about to be loaded
SceneOperation	sceneOperation	Scene operation that's about to happen
Boolean	customHandling	true to indicate that scene loading will be handled through overrides

OnClientConnect(NetworkConnection)

Called on the client when connected to a server.

The default implementation of this function sets the client as ready and adds a player. Override the function to dictate what happens when the client connects.

Declaration

public virtual void OnClientConnect(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection to the server.

OnClientDisconnect(NetworkConnection)

Called on clients when disconnected from a server.

This is called on the client when it disconnects from the server. Override this function to decide what happens when the client disconnects.

Declaration

public virtual void OnClientDisconnect(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection to the server.

OnClientError(NetworkConnection, Int32)

Called on clients when a network error occurs.

Declaration

public virtual void OnClientError(NetworkConnection conn, int errorCode)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection to a server.
Int32	errorCode	Error code.

OnClientNotReady(NetworkConnection)

Called on clients when a servers tells the client it is no longer ready.

This is commonly used when switching scenes.

Declaration

public virtual void OnClientNotReady(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection to the server.

OnClientSceneChanged(NetworkConnection)

Called on clients when a scene has completed loaded, when the scene load was initiated by the server.

Scene changes can cause player objects to be destroyed. The default implementation of OnClientSceneChanged in the NetworkManager is to add a player object for the connection if no player object exists.

Declaration

public virtual void OnClientSceneChanged(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	The network connection that the scene change message arrived on.

OnDestroy()

virtual so that inheriting classes' OnDestroy() can call base.OnDestroy() too

Declaration

public virtual void OnDestroy()

OnServerAddPlayer(NetworkConnection)

Called on the server when a client adds a new player with ClientScene.AddPlayer.

The default implementation for this function creates a new player object from the playerPrefab.

Declaration

public virtual void OnServerAddPlayer(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection from client.

OnServerChangeScene(String)

Called from ServerChangeScene immediately before SceneManager.LoadSceneAsync is executed

This allows server to do work / cleanup / prep before the scene changes.

Declaration

public virtual void OnServerChangeScene(string newSceneName)

Parameters

Type	Name	Description
String	newSceneName	Name of the scene that's about to be loaded

OnServerConnect(NetworkConnection)

Called on the server when a new client connects.

Unity calls this on the Server when a Client connects to the Server. Use an override to tell the NetworkManager what to do when a client connects to the server.

Declaration

public virtual void OnServerConnect(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection from client.

OnServerDisconnect(NetworkConnection)

Called on the server when a client disconnects.

This is called on the Server when a Client disconnects from the Server. Use an override to decide what should happen when a disconnection is detected.

Declaration

public virtual void OnServerDisconnect(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection from client.

OnServerError(NetworkConnection, Int32)

Called on the server when a network error occurs for a client connection.

Declaration

public virtual void OnServerError(NetworkConnection conn, int errorCode)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection from client.
Int32	errorCode	Error code.

OnServerReady(NetworkConnection)

Called on the server when a client is ready.

The default implementation of this function calls NetworkServer.SetClientReady() to continue the network setup process.

Declaration

public virtual void OnServerReady(NetworkConnection conn)

Parameters

Type	Name	Description
NetworkConnection	conn	Connection from client.

OnServerSceneChanged(String)

Called on the server when a scene is completed loaded, when the scene load was initiated by the server with ServerChangeScene().

Declaration

public virtual void OnServerSceneChanged(string sceneName)

Parameters

Type	Name	Description
String	sceneName	The name of the new scene.

OnStartClient()

This is invoked when the client is started.

Declaration

public virtual void OnStartClient()

OnStartHost()

This is invoked when a host is started.

StartHost has multiple signatures, but they all cause this hook to be called.

Declaration

public virtual void OnStartHost()

OnStartServer()

This is invoked when a server is started - including when a host is started.

StartServer has multiple signatures, but they all cause this hook to be called.

Declaration

public virtual void OnStartServer()

OnStopClient()

This is called when a client is stopped.

Declaration

public virtual void OnStopClient()

OnStopHost()

This is called when a host is stopped.

Declaration

public virtual void OnStopHost()

OnStopServer()

This is called when a server is stopped - including when a host is stopped.

Declaration

public virtual void OnStopServer()

OnValidate()

virtual so that inheriting classes' OnValidate() can call base.OnValidate() too

Declaration

public virtual void OnValidate()

RegisterStartPosition(Transform)

Registers the transform of a game object as a player spawn location.

This is done automatically by NetworkStartPosition components, but can be done manually from user script code.

Declaration

public static void RegisterStartPosition(Transform start)

Parameters

Type	Name	Description
Transform	start	Transform to register.

ServerChangeScene(String)

This causes the server to switch scenes and sets the networkSceneName.

Clients that connect to this server will automatically switch to this scene. This is called autmatically if onlineScene or offlineScene are set, but it can be called from user code to switch scenes again while the game is in progress. This automatically sets clients to be not-ready during the change and ready again to participate in the new scene.

Declaration

public virtual void ServerChangeScene(string newSceneName)

Parameters

Type	Name	Description
String	newSceneName

Shutdown()

This is the only way to clear the singleton, so another instance can be created.

Declaration

public static void Shutdown()

Start()

virtual so that inheriting classes' Start() can call base.Start() too

Declaration

public virtual void Start()

StartClient()

This starts a network client. It uses the networkAddress property as the address to connect to.

This makes the newly created client connect to the server immediately.

Declaration

public void StartClient()

StartClient(Uri)

This starts a network client. It uses the Uri parameter as the address to connect to.

This makes the newly created client connect to the server immediately.

Declaration

public void StartClient(Uri uri)

Parameters

Type	Name	Description
Uri	uri	location of the server to connect to

StartHost()

This starts a network "host" - a server and client in the same application.

The client returned from StartHost() is a special "local" client that communicates to the in-process server using a message queue instead of the real network. But in almost all other cases, it can be treated as a normal client.

Declaration

public void StartHost()

StartServer()

This starts a new server.

Declaration

public void StartServer()

StopClient()

Stops the client that the manager is using.

Declaration

public void StopClient()

StopHost()

This stops both the client and the server that the manager is using.

Declaration

public void StopHost()

StopServer()

Stops the server that the manager is using.

Declaration

public void StopServer()

UnRegisterStartPosition(Transform)

Unregisters the transform of a game object as a player spawn location.

This is done automatically by the NetworkStartPosition component, but can be done manually from user code.

Declaration

public static void UnRegisterStartPosition(Transform start)

Parameters

Type	Name	Description
Transform	start	Transform to unregister.