Network Manager
| Note: UNet is deprecated, and will be removed from Unity in the future. A new system is under development. For more information and next steps see this blog post. |
The Network ManagerA Networking component that manages the network state of a Project. More info
See in Glossary component allows you to control the state of a networked game. It provides an interface in the Editor for you to configure the network, the PrefabsAn asset type that allows you to store a GameObject complete with components and properties. The prefab acts as a template from which you can create new object instances in the scene. More info
See in Glossary you use for spawning GameObjectsThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary, and the ScenesA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary you use for different game states.
For more details on implementing the Network Manager in your game, see documentation on Using the Network Manager.
| Property | Function |
|---|---|
| Dont Destroy On Load | Use this property to control whether or not Unity should destroy the GameObject with the Network Manager when the Scene changes. Tick this checkbox to ensure Unity does not destroy your Network Manager GameObject when the Scene changes in your game. Untick the checkbox if you want Unity to destroy the GameObject when the Scene it exists in is no longer the active Scene. This is useful if you want to manage multiple, separate Network Manager GameObjects in each of your Scenes. This checkbox is ticked by default. |
| Run In Background | Use this property to control whether the networked game runs when the window it is running in is not focused. Tick the checkbox if you want it to run; untick it if you want the game to stop running when the window is not focused. This checkbox is ticked by default. You need to enable this property if you want to run multiple instances of a program on the same machine, such as when testing using localhost. You should disable it when deploying to mobile platforms. When enabled, it sets Application.runInBackground to true when the Network Manager starts up. You can also set this property from the Unity menu: Edit > Project Settings, then select the Player category, and navigate to the Resolution and Presentation panel. |
| Log Level | Use this property to control the amount of information Unity outputs to the console windowA Unity Editor window that shows errors, warnings and other messages generated by Unity, or your own scripts. More info See in Glossary. A low level results in more information; a high level results in less information. Each level includes message from all the levels higher than itself (for example, if you select “Warn”, the console also prints outputs all “Error” and “Fatal” log messages). The drop-down lists the levels from low to high. This property is set to Info by default. You can set Log Level to Set in Scripting to prevent the Network Manager from setting the log level at all. This means you can control the level from your own scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info See in Glossary instead. |
| Offline Scene | If you assign a Scene to this field, the Network Manager automatically switches to the specified Scene when a network session stops - for example, when the client disconnects, or when the server shuts down. |
| Online Scene | If you assign a Scene to this field, the Network Manager automatically switches to the specified Scene when a network session starts - for example, when the client connects to a server, or when the server starts listening for connections. |
| Network Info | You can expand this section of the inspectorA Unity window that displays information about the currently selected GameObject, Asset or Project Settings, allowing you to inspect and edit the values. More info See in Glossary to access network-related settings, listed below |
| Use Web Sockets | When running as a host, enable this setting to make the host listen for WebSocket connections instead of normal transport layer connections, so that WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity WebGL build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info See in Glossary clients can connect to it (if you build your game for the WebGL platform). These WebGL instances of your game cannot act as a host (in either peer-hosted or server-only mode). Therefore, for WebGL instances of your multiplayer game to be able to find each other and play together, you must host a server-only instance of your game running in LAN mode, with a publicly reachable IP address, and it must have this option enabled. This checkbox is unticked by default. |
| Network Address | 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. This is set to ‘localhost’ by default. |
| Network Port | The network port currently in use. For clients, this is the port of the server connected to. For servers, this is the listen port. This is set to 7777 by default. |
| Server Bind To IP | Allows you to tell the server whether to bind to a specific IP address. If this checkbox is not ticked, then there is no specific IP address bound to (IP_ANY). This checkbox is unticked by default. Use this if your server has multiple network addresses (eg, internal LAN, external internet, VPN) and you want to specific the IP address to serve your game on. |
| Server Bind Address | This field is only visible when the Server Bind To IP checkbox is ticked. Use this to enter the specific IP address that the server should bind to. |
| Script CRC Check | When this is enabled, Unity checks that the clients and the server are using matching scripts. This is useful to make sure outdated versions of your client are not connecting to the latest (updated) version of your server. This checkbox is ticked by default. It does this by performing a (CRC check)[https://en.wikipedia.org/wiki/Cyclic_redundancy_check] between the server and client that ensures the NetworkBehaviour scripts match. This may not be appropriate in some cases, such as when you are intentionally using different Unity projects for the client and server. In most other cases however, you should leave it enabled. |
| Max Delay | The maximum time in seconds to delay buffered messages. The default of 0.01 seconds means packets are delayed at most by 10 milliseconds. Setting this to zero disables HLAPI connection buffering. This is set to 0.01 by default. |
| Max Buffered Packets | The maximum number of packets that a NetworkConnection can buffer for each channel. This corresponds to the ChannelOption.MaxPendingBuffers channel option. This is set to 16 by default. |
| Packet Fragmentation | This allows the NetworkConnection instances to fragment packets that are larger than maxPacketSize, to up a maximum of 64K. This can cause delays in sending large packets. This checkbox is ticked by default. |
| MatchMaker Host URI | The host address for the MatchMaker server. By default this points to the global Unity Multiplayer Service at mm.unet.unity3d.com, and usually you should not need to change this. Unity automatically groups players of your game into regional servers around the world, which ensures fast multiplayer response times between players in the same region. This means, for example, that players from Europe, the US, and Asia generally end up playing with other players from their same global region. You can override this value to explicitly control which regional server your game connects to. You might want to do this via scripting if you want to give your players the option of joining a server outside of their global region. For example, if “Player A” (in the US) wanted to connect to a match created via matchmaker by “Player B” (in Europe), they would need to be able to set their desired global region in your game. Therefore you would need to write a UI(User Interface) Allows a user to interact with your application. More info See in Glossary feature which allows them to select this. See API reference documentation on NetworkMatch.baseUri for more information, and for the regional server URIs. |
| MatchMaker Port | The host port for the Matchmaker server. By default this points to port 443, and usually you should not need to change this. |
| Match Name | Define the name of the current match. This is set to “default” by default. |
| Maximum Match Size | Define the maximum number of players in the current match. This is set to 4 by default. |
| SpawnInfo | You can expand this section of the inspector to access spawn-related settings, listed below |
| Player Prefab | Define the default prefab Unity should use to create player GameObjects on the server. Unity creates Player GameObjects in the default handler for AddPlayer on the server. Implement (OnServerAddPlayer)[https://docs.unity3d.com/ScriptReference/Networking.NetworkManager.OnServerAddPlayer.html] to override this behaviour. |
| Auto Create Player | Tick this checkbox if you want Unity to automatically create player GameObjects on connect, and when the Scene changes. This checkbox is ticked by default. Note that if you are using the MigrationManager and you do not enable Auto Create Player, you need to call ClientScene.SendReconnectMessage when your client reconnects. |
| Player Spawn Method | Define how Unity should decide where to spawn new player GameObjects. This is set to Random by default. |
| Random | Choose Random to spawn players at randomly chosen startPositions. |
| Round Robin | Choose Round Robin to cycle through startPositions in a set list. |
| Registered Spawnable Prefabs | Use this list to add prefabs that you want the Network Manager to be aware of, so that it can spawn them. You can also add and remove them via scripting. |
| Advanced Configuration | Tick this checkbox to reveal advanced configuration options in the Network Manager Inspector window. |
| Max Connections | Define the maximum number of concurrent network connections to support. This is set to 4 by default. |
| Qos Channels | A list containing the different communication channels the current Network Manager has, and the Quality Of Service (QoS) setting for each channel. Use this list to add or remove channels, and adjust their QoS setting. You can also configure the channels via scripting. For the descriptions of each QoS option, see QosType. |
| Timeouts | |
| Min Update Timeout | Set the minimum time (in milliseconds) the network thread waits between sending network messages. The network thread doesn’t send multiplayer network messages immediately. Instead, it check each connection periodically at a fixed rate to see if it has something to send. This is set to 10ms by default. See API reference documentation on MinUpdateTimeout for more information. |
| Connect Timeout | Define the amount of time (in milliseconds) Unity should wait while trying to connect before attempting the connection again. This is set to 2000ms by default. See API reference documentation on ConnectTimeout for more information. |
| Disconnect Timeout | The amount of time (in milliseconds) before Unity considers a connection to be disconnected. This is set to 2000ms by default. See API reference documentation on DisconnectTimeout for more information. |
| Ping Timeout | The amount of time (in milliseconds) between sending pings (also known as “keep-alive” packets). The ping timeout duration should be approximately one-third to one-quarter of the Disconnect Timeout duration, so that Unity doesn’t assume that clients are disconnected until the server has failed to receive at least three pings from the client. This is set to 500ms by default. See API reference documentation on ConnectionConfig.PingTimeout for more information. |
| Global Config | These settings relate to the Reactor. The Reactor is the part of the multiplayer system which receives network packets from the underlying operating system, and passes them into the multiplayer system for processing. |
| Thread Awake Timeout | The timeout duration in milliseconds, used by the Reactor. How the Reactor uses this value depends on which Reactor Model you select (see below). This is set to 1ms by default. |
| Reactor Model | Choose which type of reactor to use. The reactor model defines how Unity reads incoming packets. For most games and applications, the default Select reactor is appropriate. If you want to trade a small delay in the processing of network messages for lower CPU usage and improved battery life, use the Fix Rate reactor. |
| Select Reactor | This model uses the select() API which means that the network thread “awakens” (becomes active) as soon as a packet is available. Using this method means your game gets the data as fast as possible. This is the default Reactor Model setting. |
| Fix Rate Reactor | This model lets the network thread sleep manually for a given amount of time (defined by the value in Thread Awake Timeout) before checking whether there are incoming packets waiting to be processed. |
| Reactor Max Recv Messages | Set the maximum number of messages stored in the receive queue. This is set to 1024 messages by default. |
| Reactor Max Sent Messages | Set the maximum number of messages stored in the send queue. This is set to 1024 messages by default. |
| Use Network Simulator | Tick this checkbox to enable the usage of the network simulator. The network simulator introduces simulated latency and packet loss based on the following settings: |
| Simulated Average Latency | The amount of delay in milliseconds to simulate. |
| Simulated Packet Loss | The amount of packet loss to simulate in percent. |