Mirror.NetworkManager Class Reference

Inheritance diagram for Mirror.NetworkManager:

Public Member Functions
virtual void	OnValidate ()
virtual void	Reset ()
virtual void	Awake ()
virtual void	Start ()
virtual void	LateUpdate ()
void	StartServer ()
	Starts the server, listening for incoming connections. More...
void	StartClient ()
	Starts the client, connects it to the server with networkAddress. More...
void	StartClient (Uri uri)
	Starts the client, connects it to the server via Uri More...
void	StartHost ()
	Starts a network "host" - a server and client in the same application. More...
void	StopHost ()
	This stops both the client and the server that the manager is using. More...
void	StopServer ()
	Stops the server from listening and simulating the game. More...
void	StopClient ()
	Stops and disconnects the client. More...
virtual void	OnApplicationQuit ()
virtual void	ConfigureHeadlessFrameRate ()
	Set the frame rate for a headless builds. Override to disable or modify. More...
virtual void	OnDestroy ()
virtual void	ServerChangeScene (string newSceneName)
	Change the server scene and all client's scenes across the network. More...
Transform	GetStartPosition ()
	Get the next NetworkStartPosition based on the selected PlayerSpawnMethod. More...
virtual void	OnServerConnect (NetworkConnectionToClient conn)
	Called on the server when a new client connects. More...
virtual void	OnServerDisconnect (NetworkConnectionToClient conn)
	Called on the server when a client disconnects. More...
virtual void	OnServerReady (NetworkConnectionToClient conn)
	Called on the server when a client is ready (= loaded the scene) More...
virtual void	OnServerAddPlayer (NetworkConnectionToClient conn)
	Called on server when a client requests to add the player. Adds playerPrefab by default. Can be overwritten. More...
virtual void	OnServerError (NetworkConnectionToClient conn, Exception exception)
virtual void	OnServerError (NetworkConnectionToClient conn, TransportError error, string reason)
	Called on server when transport raises an exception. NetworkConnection may be null. More...
virtual void	OnServerChangeScene (string newSceneName)
	Called from ServerChangeScene immediately before SceneManager.LoadSceneAsync is executed More...
virtual void	OnServerSceneChanged (string sceneName)
	Called on server after a scene load with ServerChangeScene() is completed. More...
virtual void	OnClientConnect ()
	Called on the client when connected to a server. By default it sets client as ready and adds a player. More...
virtual void	OnClientDisconnect ()
	Called on clients when disconnected from a server. More...
virtual void	OnClientError (Exception exception)
virtual void	OnClientError (TransportError error, string reason)
	Called on client when transport raises an exception. More...
virtual void	OnClientNotReady ()
	Called on clients when a servers tells the client it is no longer ready, e.g. when switching scenes. More...
virtual void	OnClientChangeScene (string newSceneName, SceneOperation sceneOperation, bool customHandling)
	Called from ClientChangeScene immediately before SceneManager.LoadSceneAsync is executed More...
virtual void	OnClientSceneChanged ()
	Called on clients when a scene has completed loaded, when the scene load was initiated by the server. More...
virtual void	OnStartHost ()
	This is invoked when a host is started. More...
virtual void	OnStartServer ()
	This is invoked when a server is started - including when a host is started. More...
virtual void	OnStartClient ()
	This is invoked when the client is started. More...
virtual void	OnStopServer ()
	This is called when a server is stopped - including when a host is stopped. More...
virtual void	OnStopClient ()
	This is called when a client is stopped. More...
virtual void	OnStopHost ()
	This is called when a host is stopped. More...

Static Public Member Functions
static bool	IsSceneActive (string scene)
static void	ResetStatics ()
static void	RegisterStartPosition (Transform start)
	Registers the transform of a game object as a player spawn location. More...
static void	UnRegisterStartPosition (Transform start)
	Unregister a Transform from start positions. More...

Public Attributes
bool	dontDestroyOnLoad = true
	Enable to keep NetworkManager alive when changing scenes. More...
bool	runInBackground = true
	Multiplayer games should always run in the background so the network doesn't time out. More...
bool	autoStartServerBuild = true
	Should the server auto-start when 'Server Build' is checked in build settings More...
int	serverTickRate = 30
	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. More...
string	offlineScene = ""
	Automatically switch to this scene upon going offline (on start / on disconnect / on shutdown). More...
string	onlineScene = ""
	Automatically switch to this scene upon going online (after connect/startserver). More...
string	networkAddress = "localhost"
	Server's address for clients to connect to. More...
int	maxConnections = 100
	The maximum number of concurrent network connections to support. More...
NetworkAuthenticator	authenticator
GameObject	playerPrefab
	The default prefab to be used to create player objects on the server. More...
bool	autoCreatePlayer = true
	Enable to automatically create player objects on connect and on scene change. More...
PlayerSpawnMethod	playerSpawnMethod
	Where to spawn players. More...
List< GameObject >	spawnPrefabs = new List<GameObject>()
	Prefabs that can be spawned over the network need to be registered here. More...

Static Public Attributes
static List< Transform >	startPositions = new List<Transform>()
	List of transforms populated by NetworkStartPositions More...
static int	startPositionIndex
static AsyncOperation	loadingSceneAsync

Protected Member Functions
void	FinishLoadScene ()

Protected Attributes
Transport	transport
bool	clientLoadedScene
	True if the client loaded a new scene when connecting to the server. More...

Properties
static NetworkManager	singleton [get, set]
	The one and only NetworkManager More...
int	numPlayers [get]
	Number of active player objects across all connections on the server. More...
bool	isNetworkActive [get]
	True if the server is running or client is connected/connecting. More...
NetworkManagerMode	mode [get]
static string	networkSceneName = "" [get, protected set]
	The name of the current network scene. More...

Detailed Description

Definition at line 17 of file NetworkManager.cs.

Member Function Documentation

Awake()

virtual void Mirror.NetworkManager.Awake ( )

virtual

Definition at line 185 of file NetworkManager.cs.

        {
            // Don't allow collision-destroyed second instance to continue.
            if (!InitializeSingleton()) return;
 
            Debug.Log("Mirror | mirror-networking.com | discord.gg/N9QVxbM");
 
            // Set the networkSceneName to prevent a scene reload
            // if client connection to server fails.
            networkSceneName = offlineScene;
 
            // setup OnSceneLoaded callback
            SceneManager.sceneLoaded += OnSceneLoaded;
        }

ConfigureHeadlessFrameRate()

virtual void Mirror.NetworkManager.ConfigureHeadlessFrameRate ( )

virtual

Set the frame rate for a headless builds. Override to disable or modify.

Definition at line 642 of file NetworkManager.cs.

        {
#if UNITY_SERVER
            Application.targetFrameRate = serverTickRate;
            // Debug.Log($"Server Tick Rate set to {Application.targetFrameRate} Hz.");
#endif
        }

FinishLoadScene()

void Mirror.NetworkManager.FinishLoadScene ( )

protected

Definition at line 919 of file NetworkManager.cs.

        {
            // NOTE: this cannot use NetworkClient.allClients[0] - that client may be for a completely different purpose.
 
            // process queued messages that we received while loading the scene
            //Debug.Log("FinishLoadScene: resuming handlers after scene was loading.");
            NetworkServer.isLoadingScene = false;
            NetworkClient.isLoadingScene = false;
 
            // host mode?
            if (mode == NetworkManagerMode.Host)
            {
                FinishLoadSceneHost();
            }
            // server-only mode?
            else if (mode == NetworkManagerMode.ServerOnly)
            {
                FinishLoadSceneServerOnly();
            }
            // client-only mode?
            else if (mode == NetworkManagerMode.ClientOnly)
            {
                FinishLoadSceneClientOnly();
            }
            // otherwise we called it after stopping when loading offline scene.
            // do nothing then.
        }

GetStartPosition()

Transform Mirror.NetworkManager.GetStartPosition

(

)

Get the next NetworkStartPosition based on the selected PlayerSpawnMethod.

Definition at line 1056 of file NetworkManager.cs.

        {
            // first remove any dead transforms
            startPositions.RemoveAll(t => t == null);
 
            if (startPositions.Count == 0)
                return null;
 
            if (playerSpawnMethod == PlayerSpawnMethod.Random)
            {
                return startPositions[UnityEngine.Random.Range(0, startPositions.Count)];
            }
            else
            {
                Transform startPosition = startPositions[startPositionIndex];
                startPositionIndex = (startPositionIndex + 1) % startPositions.Count;
                return startPosition;
            }
        }

IsSceneActive()

static bool Mirror.NetworkManager.IsSceneActive ( string  scene )

static

Definition at line 229 of file NetworkManager.cs.

        {
            Scene activeScene = SceneManager.GetActiveScene();
            return activeScene.path == scene || activeScene.name == scene;
        }

LateUpdate()

virtual void Mirror.NetworkManager.LateUpdate ( )

virtual

Definition at line 217 of file NetworkManager.cs.

        {
            UpdateScene();
        }

OnApplicationQuit()

virtual void Mirror.NetworkManager.OnApplicationQuit ( )

virtual

Definition at line 617 of file NetworkManager.cs.

        {
            // stop client first
            // (we want to send the quit packet to the server instead of waiting
            //  for a timeout)
            if (NetworkClient.isConnected)
            {
                StopClient();
                //Debug.Log("OnApplicationQuit: stopped client");
            }
 
            // stop server after stopping client (for proper host mode stopping)
            if (NetworkServer.active)
            {
                StopServer();
                //Debug.Log("OnApplicationQuit: stopped server");
            }
 
            // Call ResetStatics to reset statics and singleton
            ResetStatics();
        }

OnClientChangeScene()

virtual void Mirror.NetworkManager.OnClientChangeScene ( string  newSceneName, SceneOperation  sceneOperation, bool  customHandling  )

virtual

Called from ClientChangeScene immediately before SceneManager.LoadSceneAsync is executed

Definition at line 1306 of file NetworkManager.cs.

{}

OnClientConnect()

virtual void Mirror.NetworkManager.OnClientConnect ( )

virtual

Called on the client when connected to a server. By default it sets client as ready and adds a player.

Definition at line 1264 of file NetworkManager.cs.

        {
            // OnClientConnect by default calls AddPlayer but it should not do
            // that when we have online/offline scenes. so we need the
            // clientLoadedScene flag to prevent it.
            if (!clientLoadedScene)
            {
                // Ready/AddPlayer is usually triggered by a scene load completing.
                // if no scene was loaded, then Ready/AddPlayer it here instead.
                if (!NetworkClient.ready)
                    NetworkClient.Ready();
 
                if (autoCreatePlayer)
                    NetworkClient.AddPlayer();
            }
        }

OnClientDisconnect()

virtual void Mirror.NetworkManager.OnClientDisconnect ( )

virtual

Called on clients when disconnected from a server.

Definition at line 1282 of file NetworkManager.cs.

        {
            if (mode == NetworkManagerMode.Offline)
                return;
 
            StopClient();
        }

OnClientError() [1/2]

virtual void Mirror.NetworkManager.OnClientError ( Exception  exception )

virtual

Definition at line 1292 of file NetworkManager.cs.

{}

OnClientError() [2/2]

virtual void Mirror.NetworkManager.OnClientError ( TransportError  error, string  reason  )

virtual

Called on client when transport raises an exception.

Definition at line 1294 of file NetworkManager.cs.

        {
#pragma warning disable CS0618
            OnClientError(new Exception(reason));
#pragma warning restore CS0618
        }

OnClientNotReady()

virtual void Mirror.NetworkManager.OnClientNotReady ( )

virtual

Called on clients when a servers tells the client it is no longer ready, e.g. when switching scenes.

Definition at line 1302 of file NetworkManager.cs.

{}

OnClientSceneChanged()

virtual void Mirror.NetworkManager.OnClientSceneChanged ( )

virtual

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

Definition at line 1312 of file NetworkManager.cs.

        {
            // always become ready.
            if (!NetworkClient.ready) NetworkClient.Ready();
 
            // Only call AddPlayer for normal scene changes, not additive load/unload
            if (clientSceneOperation == SceneOperation.Normal && autoCreatePlayer && NetworkClient.localPlayer == null)
            {
                // add player if existing one is null
                NetworkClient.AddPlayer();
            }
        }

OnDestroy()

virtual void Mirror.NetworkManager.OnDestroy ( )

virtual

Definition at line 734 of file NetworkManager.cs.

        {
            //Debug.Log("NetworkManager destroyed");
        }

OnServerAddPlayer()

virtual void Mirror.NetworkManager.OnServerAddPlayer ( NetworkConnectionToClient  conn )

virtual

Called on server when a client requests to add the player. Adds playerPrefab by default. Can be overwritten.

Definition at line 1233 of file NetworkManager.cs.

        {
            Transform startPos = GetStartPosition();
            GameObject player = startPos != null
                ? Instantiate(playerPrefab, startPos.position, startPos.rotation)
                : Instantiate(playerPrefab);
 
            // instantiating a "Player" prefab gives it the name "Player(clone)"
            // => appending the connectionId is WAY more useful for debugging!
            player.name = $"{playerPrefab.name} [connId={conn.connectionId}]";
            NetworkServer.AddPlayerForConnection(conn, player);
        }

OnServerChangeScene()

virtual void Mirror.NetworkManager.OnServerChangeScene ( string  newSceneName )

virtual

Called from ServerChangeScene immediately before SceneManager.LoadSceneAsync is executed

Definition at line 1258 of file NetworkManager.cs.

{}

OnServerConnect()

virtual void Mirror.NetworkManager.OnServerConnect ( NetworkConnectionToClient  conn )

virtual

Called on the server when a new client connects.

Definition at line 1207 of file NetworkManager.cs.

{}

OnServerDisconnect()

virtual void Mirror.NetworkManager.OnServerDisconnect ( NetworkConnectionToClient  conn )

virtual

Called on the server when a client disconnects.

Definition at line 1211 of file NetworkManager.cs.

        {
            // by default, this function destroys the connection's player.
            // can be overwritten for cases like delayed logouts in MMOs to
            // avoid players escaping from PvP situations by logging out.
            NetworkServer.DestroyPlayerForConnection(conn);
            //Debug.Log("OnServerDisconnect: Client disconnected.");
        }

OnServerError() [1/2]

virtual void Mirror.NetworkManager.OnServerError ( NetworkConnectionToClient  conn, Exception  exception  )

virtual

Definition at line 1248 of file NetworkManager.cs.

{}

OnServerError() [2/2]

virtual void Mirror.NetworkManager.OnServerError ( NetworkConnectionToClient  conn, TransportError  error, string  reason  )

virtual

Called on server when transport raises an exception. NetworkConnection may be null.

Definition at line 1250 of file NetworkManager.cs.

        {
#pragma warning disable CS0618
            OnServerError(conn, new Exception(reason));
#pragma warning restore CS0618
        }

OnServerReady()

virtual void Mirror.NetworkManager.OnServerReady ( NetworkConnectionToClient  conn )

virtual

Called on the server when a client is ready (= loaded the scene)

Definition at line 1221 of file NetworkManager.cs.

        {
            if (conn.identity == null)
            {
                // this is now allowed (was not for a while)
                //Debug.Log("Ready with no player object");
            }
            NetworkServer.SetClientReady(conn);
        }

OnServerSceneChanged()

virtual void Mirror.NetworkManager.OnServerSceneChanged ( string  sceneName )

virtual

Called on server after a scene load with ServerChangeScene() is completed.

Definition at line 1261 of file NetworkManager.cs.

{}

OnStartClient()

virtual void Mirror.NetworkManager.OnStartClient ( )

virtual

This is invoked when the client is started.

Definition at line 1337 of file NetworkManager.cs.

{}

OnStartHost()

virtual void Mirror.NetworkManager.OnStartHost ( )

virtual

This is invoked when a host is started.

Definition at line 1331 of file NetworkManager.cs.

{}

OnStartServer()

virtual void Mirror.NetworkManager.OnStartServer ( )

virtual

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

Definition at line 1334 of file NetworkManager.cs.

{}

OnStopClient()

virtual void Mirror.NetworkManager.OnStopClient ( )

virtual

This is called when a client is stopped.

Definition at line 1343 of file NetworkManager.cs.

{}

OnStopHost()

virtual void Mirror.NetworkManager.OnStopHost ( )

virtual

This is called when a host is stopped.

Definition at line 1346 of file NetworkManager.cs.

{}

OnStopServer()

virtual void Mirror.NetworkManager.OnStopServer ( )

virtual

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

Definition at line 1340 of file NetworkManager.cs.

{}

OnValidate()

virtual void Mirror.NetworkManager.OnValidate ( )

virtual

Definition at line 126 of file NetworkManager.cs.

        {
            // always >= 0
            maxConnections = Mathf.Max(maxConnections, 0);
 
            if (playerPrefab != null && playerPrefab.GetComponent<NetworkIdentity>() == null)
            {
                Debug.LogError("NetworkManager - Player Prefab must have a NetworkIdentity.");
                playerPrefab = null;
            }
 
            // This avoids the mysterious "Replacing existing prefab with assetId ... Old prefab 'Player', New prefab 'Player'" warning.
            if (playerPrefab != null && spawnPrefabs.Contains(playerPrefab))
            {
                Debug.LogWarning("NetworkManager - Player Prefab should not be added to Registered Spawnable Prefabs list...removed it.");
                spawnPrefabs.Remove(playerPrefab);
            }
        }

RegisterStartPosition()

static void Mirror.NetworkManager.RegisterStartPosition ( Transform  start )

static

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.

Parameters

start

Transform to register.

Definition at line 1034 of file NetworkManager.cs.

        {
            // Debug.Log($"RegisterStartPosition: {start.gameObject.name} {start.position}");
            startPositions.Add(start);
 
            // reorder the list so that round-robin spawning uses the start positions
            // in hierarchy order.  This assumes all objects with NetworkStartPosition
            // component are siblings, either in the scene root or together as children
            // under a single parent in the scene.
            startPositions = startPositions.OrderBy(transform => transform.GetSiblingIndex()).ToList();
        }

Reset()

virtual void Mirror.NetworkManager.Reset ( )

virtual

Definition at line 149 of file NetworkManager.cs.

        {
            // make sure someone doesn't accidentally add another NetworkManager
            // need transform.root because when adding to a child, the parent's
            // Reset isn't called.
            foreach (NetworkManager manager in transform.root.GetComponentsInChildren<NetworkManager>())
            {
                if (manager != this)
                {
                    Debug.LogError($"{name} detected another component of type {typeof(NetworkManager)} in its hierarchy on {manager.name}. There can only be one, please remove one of them.");
                    // return early so that transport component isn't auto-added
                    // to the duplicate NetworkManager.
                    return;
                }
            }
 
            // add transport if there is none yet. makes upgrading easier.
            if (transport == null)
            {
#if UNITY_EDITOR
                // RecordObject needs to be called before we make the change
                UnityEditor.Undo.RecordObject(gameObject, "Added default Transport");
#endif
 
                transport = GetComponent<Transport>();
 
                // was a transport added yet? if not, add one
                if (transport == null)
                {
                    transport = gameObject.AddComponent<KcpTransport>();
                    Debug.Log("NetworkManager: added default Transport because there was none yet.");
                }
            }
        }

ResetStatics()

static void Mirror.NetworkManager.ResetStatics ( )

static

Definition at line 716 of file NetworkManager.cs.

        {
            // call StopHost if we have a singleton
            if (singleton)
                singleton.StopHost();
 
            // reset all statics
            startPositions.Clear();
            startPositionIndex = 0;
            clientReadyConnection = null;
            loadingSceneAsync = null;
            networkSceneName = string.Empty;
 
            // and finally (in case it isn't null already)...
            singleton = null;
        }

ServerChangeScene()

virtual void Mirror.NetworkManager.ServerChangeScene ( string  newSceneName )

virtual

Change the server scene and all client's scenes across the network.

Definition at line 752 of file NetworkManager.cs.

        {
            if (string.IsNullOrWhiteSpace(newSceneName))
            {
                Debug.LogError("ServerChangeScene empty scene name");
                return;
            }
 
            if (NetworkServer.isLoadingScene && newSceneName == networkSceneName)
            {
                Debug.LogError($"Scene change is already in progress for {newSceneName}");
                return;
            }
 
            // Debug.Log($"ServerChangeScene {newSceneName}");
            NetworkServer.SetAllClientsNotReady();
            networkSceneName = newSceneName;
 
            // Let server prepare for scene change
            OnServerChangeScene(newSceneName);
 
            // set server flag to stop processing messages while changing scenes
            // it will be re-enabled in FinishLoadScene.
            NetworkServer.isLoadingScene = true;
 
            loadingSceneAsync = SceneManager.LoadSceneAsync(newSceneName);
 
            // ServerChangeScene can be called when stopping the server
            // when this happens the server is not active so does not need to tell clients about the change
            if (NetworkServer.active)
            {
                // notify all clients about the new scene
                NetworkServer.SendToAll(new SceneMessage { sceneName = newSceneName });
            }
 
            startPositionIndex = 0;
            startPositions.Clear();
        }

Start()

virtual void Mirror.NetworkManager.Start ( )

virtual

Definition at line 201 of file NetworkManager.cs.

        {
            // headless mode? then start the server
            // can't do this in Awake because Awake is for initialization.
            // some transports might not be ready until Start.
            //
            // (tick rate is applied in StartServer!)
#if UNITY_SERVER
            if (autoStartServerBuild)
            {
                StartServer();
            }
#endif
        }

StartClient() [1/2]

void Mirror.NetworkManager.StartClient

(

)

Starts the client, connects it to the server with networkAddress.

Definition at line 311 of file NetworkManager.cs.

        {
            if (NetworkClient.active)
            {
                Debug.LogWarning("Client already started.");
                return;
            }
 
            mode = NetworkManagerMode.ClientOnly;
 
            InitializeSingleton();
 
            if (runInBackground)
                Application.runInBackground = true;
 
            if (authenticator != null)
            {
                authenticator.OnStartClient();
                authenticator.OnClientAuthenticated.AddListener(OnClientAuthenticated);
            }
 
            // In case this is a headless client...
            ConfigureHeadlessFrameRate();
 
            RegisterClientMessages();
 
            if (string.IsNullOrWhiteSpace(networkAddress))
            {
                Debug.LogError("Must set the Network Address field in the manager");
                return;
            }
            // Debug.Log($"NetworkManager StartClient address:{networkAddress}");
 
            NetworkClient.Connect(networkAddress);
 
            OnStartClient();
        }

StartClient() [2/2]

void Mirror.NetworkManager.StartClient

(

Uri

uri

)

Starts the client, connects it to the server via Uri

Definition at line 350 of file NetworkManager.cs.

        {
            if (NetworkClient.active)
            {
                Debug.LogWarning("Client already started.");
                return;
            }
 
            mode = NetworkManagerMode.ClientOnly;
 
            InitializeSingleton();
 
            if (runInBackground)
                Application.runInBackground = true;
 
            if (authenticator != null)
            {
                authenticator.OnStartClient();
                authenticator.OnClientAuthenticated.AddListener(OnClientAuthenticated);
            }
 
            RegisterClientMessages();
 
            // Debug.Log($"NetworkManager StartClient address:{uri}");
            networkAddress = uri.Host;
 
            NetworkClient.Connect(uri);
 
            OnStartClient();
        }

StartHost()

void Mirror.NetworkManager.StartHost

(

)

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

Definition at line 382 of file NetworkManager.cs.

        {
            if (NetworkServer.active || NetworkClient.active)
            {
                Debug.LogWarning("Server or Client already started.");
                return;
            }
 
            mode = NetworkManagerMode.Host;
 
            // StartHost is inherently ASYNCHRONOUS (=doesn't finish immediately)
            //
            // Here is what it does:
            //   Listen
            //   ConnectHost
            //   if onlineScene:
            //       LoadSceneAsync
            //       ...
            //       FinishLoadSceneHost
            //           FinishStartHost
            //               SpawnObjects
            //               StartHostClient      <= not guaranteed to happen after SpawnObjects if onlineScene is set!
            //                   ClientAuth
            //                       success: server sends changescene msg to client
            //   else:
            //       FinishStartHost
            //
            // there is NO WAY to make it synchronous because both LoadSceneAsync
            // and LoadScene do not finish loading immediately. as long as we
            // have the onlineScene feature, it will be asynchronous!
 
            // setup server first
            SetupServer();
 
            // call OnStartHost AFTER SetupServer. this way we can use
            // NetworkServer.Spawn etc. in there too. just like OnStartServer
            // is called after the server is actually properly started.
            OnStartHost();
 
            // scene change needed? then change scene and spawn afterwards.
            // => BEFORE host client connects. if client auth succeeds then the
            //    server tells it to load 'onlineScene'. we can't do that if
            //    server is still in 'offlineScene'. so load on server first.
            if (IsServerOnlineSceneChangeNeeded())
            {
                // call FinishStartHost after changing scene.
                finishStartHostPending = true;
                ServerChangeScene(onlineScene);
            }
            // otherwise call FinishStartHost directly
            else
            {
                FinishStartHost();
            }
        }

StartServer()

void Mirror.NetworkManager.StartServer

(

)

Starts the server, listening for incoming connections.

Definition at line 270 of file NetworkManager.cs.

        {
            if (NetworkServer.active)
            {
                Debug.LogWarning("Server already started.");
                return;
            }
 
            mode = NetworkManagerMode.ServerOnly;
 
            // StartServer is inherently ASYNCHRONOUS (=doesn't finish immediately)
            //
            // Here is what it does:
            //   Listen
            //   if onlineScene:
            //       LoadSceneAsync
            //       ...
            //       FinishLoadSceneServerOnly
            //           SpawnObjects
            //   else:
            //       SpawnObjects
            //
            // there is NO WAY to make it synchronous because both LoadSceneAsync
            // and LoadScene do not finish loading immediately. as long as we
            // have the onlineScene feature, it will be asynchronous!
 
            SetupServer();
 
            // scene change needed? then change scene and spawn afterwards.
            if (IsServerOnlineSceneChangeNeeded())
            {
                ServerChangeScene(onlineScene);
            }
            // otherwise spawn directly
            else
            {
                NetworkServer.SpawnObjects();
            }
        }

StopClient()

void Mirror.NetworkManager.StopClient

(

)

Stops and disconnects the client.

Definition at line 568 of file NetworkManager.cs.

        {
            if (mode == NetworkManagerMode.Offline)
                return;
 
            if (authenticator != null)
            {
                authenticator.OnClientAuthenticated.RemoveListener(OnClientAuthenticated);
                authenticator.OnStopClient();
            }
 
            // Get Network Manager out of DDOL before going to offline scene
            // to avoid collision and let a fresh Network Manager be created.
            // IMPORTANT: .gameObject can be null if StopClient is called from
            //            OnApplicationQuit or from tests!
            if (gameObject != null
                && gameObject.scene.name == "DontDestroyOnLoad"
                && !string.IsNullOrWhiteSpace(offlineScene)
                && SceneManager.GetActiveScene().path != offlineScene)
                SceneManager.MoveGameObjectToScene(gameObject, SceneManager.GetActiveScene());
 
            OnStopClient();
 
            //Debug.Log("NetworkManager StopClient");
 
            // set offline mode BEFORE changing scene so that FinishStartScene
            // doesn't think we need initialize anything.
            // set offline mode BEFORE NetworkClient.Disconnect so StopClient
            // only runs once.
            mode = NetworkManagerMode.Offline;
 
            // shutdown client
            NetworkClient.Disconnect();
            NetworkClient.Shutdown();
 
            // If this is the host player, StopServer will already be changing scenes.
            // Check loadingSceneAsync to ensure we don't double-invoke the scene change.
            // Check if NetworkServer.active because we can get here via Disconnect before server has started to change scenes.
            if (!string.IsNullOrWhiteSpace(offlineScene) && !IsSceneActive(offlineScene) && loadingSceneAsync == null && !NetworkServer.active)
            {
                ClientChangeScene(offlineScene, SceneOperation.Normal);
            }
 
            networkSceneName = "";
        }

StopHost()

void Mirror.NetworkManager.StopHost

(

)

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

Definition at line 510 of file NetworkManager.cs.

        {
            OnStopHost();
 
            // calling OnTransportDisconnected was needed to fix
            // https://github.com/vis2k/Mirror/issues/1515
            // so that the host client receives a DisconnectMessage
            // TODO reevaluate if this is still needed after all the disconnect
            //      fixes, and try to put this into LocalConnection.Disconnect!
            NetworkServer.OnTransportDisconnected(NetworkConnection.LocalConnectionId);
 
            StopClient();
            StopServer();
        }

StopServer()

void Mirror.NetworkManager.StopServer

(

)

Stops the server from listening and simulating the game.

Definition at line 526 of file NetworkManager.cs.

        {
            // return if already stopped to avoid recursion deadlock
            if (!NetworkServer.active)
                return;
 
            if (authenticator != null)
            {
                authenticator.OnServerAuthenticated.RemoveListener(OnServerAuthenticated);
                authenticator.OnStopServer();
            }
 
            // Get Network Manager out of DDOL before going to offline scene
            // to avoid collision and let a fresh Network Manager be created.
            // IMPORTANT: .gameObject can be null if StopClient is called from
            //            OnApplicationQuit or from tests!
            if (gameObject != null
                && gameObject.scene.name == "DontDestroyOnLoad"
                && !string.IsNullOrWhiteSpace(offlineScene)
                && SceneManager.GetActiveScene().path != offlineScene)
                SceneManager.MoveGameObjectToScene(gameObject, SceneManager.GetActiveScene());
 
            OnStopServer();
 
            //Debug.Log("NetworkManager StopServer");
            NetworkServer.Shutdown();
 
            // set offline mode BEFORE changing scene so that FinishStartScene
            // doesn't think we need initialize anything.
            mode = NetworkManagerMode.Offline;
 
            if (!string.IsNullOrWhiteSpace(offlineScene))
            {
                ServerChangeScene(offlineScene);
            }
 
            startPositionIndex = 0;
 
            networkSceneName = "";
        }

UnRegisterStartPosition()

static void Mirror.NetworkManager.UnRegisterStartPosition ( Transform  start )

static

Unregister a Transform from start positions.

Definition at line 1049 of file NetworkManager.cs.

        {
            //Debug.Log($"UnRegisterStartPosition: {start.name} {start.position}");
            startPositions.Remove(start);
        }

Member Data Documentation

authenticator

NetworkAuthenticator Mirror.NetworkManager.authenticator

Definition at line 71 of file NetworkManager.cs.

autoCreatePlayer

bool Mirror.NetworkManager.autoCreatePlayer = true

Enable to automatically create player objects on connect and on scene change.

Definition at line 84 of file NetworkManager.cs.

autoStartServerBuild

bool Mirror.NetworkManager.autoStartServerBuild = true

Should the server auto-start when 'Server Build' is checked in build settings

Definition at line 34 of file NetworkManager.cs.

clientLoadedScene

bool Mirror.NetworkManager.clientLoadedScene

protected

True if the client loaded a new scene when connecting to the server.

Definition at line 115 of file NetworkManager.cs.

dontDestroyOnLoad

bool Mirror.NetworkManager.dontDestroyOnLoad = true

Enable to keep NetworkManager alive when changing scenes.

Definition at line 24 of file NetworkManager.cs.

loadingSceneAsync

AsyncOperation Mirror.NetworkManager.loadingSceneAsync

static

Definition at line 745 of file NetworkManager.cs.

maxConnections

int Mirror.NetworkManager.maxConnections = 100

The maximum number of concurrent network connections to support.

Definition at line 67 of file NetworkManager.cs.

networkAddress

string Mirror.NetworkManager.networkAddress = "localhost"

Server's address for clients to connect to.

Definition at line 62 of file NetworkManager.cs.

offlineScene

string Mirror.NetworkManager.offlineScene = ""

Automatically switch to this scene upon going offline (on start / on disconnect / on shutdown).

Definition at line 45 of file NetworkManager.cs.

onlineScene

string Mirror.NetworkManager.onlineScene = ""

Automatically switch to this scene upon going online (after connect/startserver).

Definition at line 51 of file NetworkManager.cs.

playerPrefab

GameObject Mirror.NetworkManager.playerPrefab

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

Definition at line 79 of file NetworkManager.cs.

playerSpawnMethod

PlayerSpawnMethod Mirror.NetworkManager.playerSpawnMethod

Where to spawn players.

Definition at line 89 of file NetworkManager.cs.

runInBackground

bool Mirror.NetworkManager.runInBackground = true

Multiplayer games should always run in the background so the network doesn't time out.

Definition at line 29 of file NetworkManager.cs.

serverTickRate

int Mirror.NetworkManager.serverTickRate = 30

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.

Definition at line 38 of file NetworkManager.cs.

spawnPrefabs

List<GameObject> Mirror.NetworkManager.spawnPrefabs = new List<GameObject>()

Prefabs that can be spawned over the network need to be registered here.

Definition at line 93 of file NetworkManager.cs.

startPositionIndex

int Mirror.NetworkManager.startPositionIndex

static

Definition at line 97 of file NetworkManager.cs.

startPositions

List<Transform> Mirror.NetworkManager.startPositions = new List<Transform>()

static

List of transforms populated by NetworkStartPositions

Definition at line 96 of file NetworkManager.cs.

transport

Transport Mirror.NetworkManager.transport

protected

Definition at line 57 of file NetworkManager.cs.

Property Documentation

isNetworkActive

bool Mirror.NetworkManager.isNetworkActive

get

True if the server is running or client is connected/connecting.

Definition at line 106 of file NetworkManager.cs.

mode

NetworkManagerMode Mirror.NetworkManager.mode

get

Definition at line 123 of file NetworkManager.cs.

{ get; private set; }

networkSceneName

string Mirror.NetworkManager.networkSceneName = ""

staticgetprotected set

The name of the current network scene.

Definition at line 743 of file NetworkManager.cs.

{ get; protected set; } = "";

numPlayers

int Mirror.NetworkManager.numPlayers

get

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

Definition at line 103 of file NetworkManager.cs.

singleton

NetworkManager Mirror.NetworkManager.singleton

staticgetset

The one and only NetworkManager

Definition at line 100 of file NetworkManager.cs.

{ get; internal set; }