Class NetworkManager
The main component of the library
Implements
Inherited Members
Namespace: Unity.Netcode
Assembly: solution.dll
Syntax
[AddComponentMenu("Netcode/Network Manager", -100)]
public class NetworkManager : MonoBehaviour, INetworkUpdateSystemFields
| Name | Description |
|---|---|
| LogLevel | The log level to use |
| NetworkConfig | The current netcode project configuration |
| PendingClients | Gets a dictionary of the clients that have been accepted by the transport but are still pending by the Netcode. This is only populated on the server. |
| RunInBackground | Gets or sets if the application should be set to run in background |
| ServerClientId | The client id used to represent the server |
Properties
| Name | Description |
|---|---|
| ConnectedClients | Gets a dictionary of connected clients and their clientId keys. This is only accessible on the server. |
| ConnectedClientsIds | Gets a list of just the IDs of all connected clients. This is only accessible on the server. |
| ConnectedClientsList | Gets a list of connected clients. This is only accessible on the server. |
| ConnectedHostname | The current host name we are connected to, used to validate certificate |
| ConnectionApprovalCallback | The callback to invoke during connection approval. Allows client code to decide whether or not to allow incoming client connection |
| CustomMessagingManager | Gets the CustomMessagingManager for this NetworkManager |
| DisconnectReason | When disconnected from the server, the server may send a reason. If a reason was sent, this property will tell client code what the reason was. It should be queried after the OnClientDisconnectCallback is called |
| IsApproved | Is true when the client has been approved. |
| IsClient | Gets Whether or not a client is running |
| IsConnectedClient | When true, the client is connected, approved, and synchronized with
the server.
IsConnected |
| IsHost | Gets if we are running as host |
| IsListening | Is true when a server or host is listening for connections. Is true when a client is connecting or connected to a network session. Is false when not listening, connecting, or connected. |
| IsServer | Gets Whether or not a server is running |
| LocalClient | Gets the local NetworkClient for this client. |
| LocalClientId | Returns ServerClientId if IsServer or LocalClientId if not |
| LocalTime | The local NetworkTime |
| MaximumFragmentedMessageSize | Sets the maximum size of a message (or message batch) passed through the transport with the ReliableFragmented delivery. Warning: setting this value too low may result in the SDK becoming non-functional with projects that have a large number of NetworkBehaviours or NetworkVariables, as the SDK relies on the transport's ability to fragment some messages when they grow beyond the MTU size. |
| MaximumTransmissionUnitSize | Sets the maximum size of a single non-fragmented message (or message batch) passed through the transport. This should represent the transport's default MTU size, minus any transport-level overhead. This value will be used for any remote endpoints that haven't had per-endpoint MTUs set. This value is also used as the size of the temporary buffer used when serializing a single message (to avoid serializing multiple times when sending to multiple endpoints), and thus should be large enough to ensure it can hold each message type. This value defaults to 1296. |
| NetworkTickSystem | Accessor property for the NetworkTickSystem of the NetworkManager. |
| NetworkTimeSystem | Accessor property for the NetworkTimeSystem of the NetworkManager. Prefer the use of the LocalTime and ServerTime properties |
| PrefabHandler | The NetworkPrefabHandler instance created after starting the NetworkManager |
| SceneManager | The NetworkSceneManager instance created after starting the NetworkManager |
| ServerTime | The NetworkTime on the server |
| ShutdownInProgress | Can be used to determine if the NetworkManager is currently shutting itself down |
| Singleton | The singleton instance of the NetworkManager |
| SpawnManager | Gets the SpawnManager for this NetworkManager |
Methods
| Name | Description |
|---|---|
| AddNetworkPrefab(GameObject) | |
| DisconnectClient(ulong) | Disconnects the remote client. |
| DisconnectClient(ulong, string) | Disconnects the remote client. |
| GetNetworkPrefabOverride(GameObject) | |
| GetPeerMTU(ulong) | Queries the current MTU size for a client. If no MTU has been set for that client, will return MaximumTransmissionUnitSize |
| NetworkUpdate(NetworkUpdateStage) | The update method that is being executed in the context of related NetworkUpdateStage. |
| RemoveNetworkPrefab(GameObject) | |
| SetPeerMTU(ulong, int) | Set the maximum transmission unit for a specific peer. This determines the maximum size of a message batch that can be sent to that client. If not set for any given client, MaximumTransmissionUnitSize will be used instead. |
| SetSingleton() | Set this NetworkManager instance as the static NetworkManager singleton |
| Shutdown(bool) | Globally shuts down the library. Disconnects clients if connected and stops server if running. |
| StartClient() | Starts a client |
| StartHost() | Starts a Host |
| StartServer() | Starts a server |
Events
| Name | Description |
|---|---|
| OnClientConnectedCallback | The callback to invoke once a client connects. This callback is only ran on the server and on the local client that connects. |
| OnClientDisconnectCallback | The callback to invoke when a client disconnects. This callback is only ran on the server and on the local client that disconnects. |
| OnClientStarted | The callback to invoke once the local client is ready |
| OnClientStopped | The callback to invoke once the local client stops |
| OnServerStarted | This callback is invoked when the local server is started and listening for incoming connections. |
| OnServerStopped | This callback is invoked once the local server is stopped. |
| OnTransportFailure | The callback to invoke if the NetworkTransport fails. |