Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine.Networking
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.Close
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.Close
A client manager which contains static client information and functions.
This manager contains references to tracked static local objects such as spawner registrations. It also has the default message handlers used by clients when they registered none themselves. The manager handles adding/removing player objects to the game after a client connection has been set as ready.
The ClientScene is a singleton, and it has static convenience methods such as ClientScene.Ready().
The ClientScene is used by the NetworkManager, but it can be used by itself.
As the ClientScene manages player objects on the client, it is where clients request to add players. The NetworkManager does this via the ClientScene automatically when auto-add-players is set, but it can be done through code using the function ClientScene.AddPlayer(). This sends an AddPlayer message to the server and will cause a player object to be created for this client.
Like NetworkServer, the ClientScene understands the concept of the local client. The function ClientScene.ConnectLocalServer() is used to become a host by starting a local client (when a server is already running).
|localPlayers||A list of all players added to the game.|
|objects||This is a dictionary of networked objects that have been spawned on the client.|
|prefabs||This is a dictionary of the prefabs that are registered on the client with ClientScene.RegisterPrefab().|
|ready||Returns true when a client's connection has been set to ready.|
|readyConnection||The NetworkConnection object that is currently "ready". This is the connection to the server where objects are spawned from.|
|reconnectId||The reconnectId to use when a client reconnects to the new host of a game after the old host was lost.|
|ReconnectIdHost||A constant ID used by the old host when it reconnects to the new host.|
|ReconnectIdInvalid||An invalid reconnect Id.|
|spawnableObjects||This is dictionary of the disabled NetworkIdentity objects in the scene that could be spawned by messages from the server.|
|AddPlayer||This adds a player GameObject for this client. This causes an AddPlayer message to be sent to the server, and NetworkManager.OnServerAddPlayer is called. If an extra message was passed to AddPlayer, then OnServerAddPlayer will be called with a NetworkReader that contains the contents of the message.|
|ClearSpawners||This clears the registered spawn prefabs and spawn handler functions for this client.|
|ConnectLocalServer||Create and connect a local client instance to the local server. This makes the client into a "host" - a client and server in the same process.|
|DestroyAllClientObjects||Destroys all networked objects on the client.|
|FindLocalObject||This finds the local NetworkIdentity object with the specified network Id.|
|Ready||Signal that the client connection is ready to enter the game.|
|RegisterPrefab||Registers a prefab with the UNET spawning system.|
|RegisterSpawnHandler||This is an advanced spawning function that registers a custom assetId with the UNET spawning system.|
|RemovePlayer||Removes the specified player ID from the game.|
|SendReconnectMessage||Send a reconnect message to the new host, used during host migration.|
|SetLocalObject||NetId is a unique number assigned to all objects with NetworkIdentity components in a game.|
|SetReconnectId||Sets the Id that the ClientScene will use when reconnecting to a new host after host migration.|
|UnregisterPrefab||Removes a registered spawn prefab that was setup with ClientScene.RegisterPrefab.|
|UnregisterSpawnHandler||Removes a registered spawn handler function that was registered with ClientScene.RegisterHandler().|
Did you find this page useful? Please give it a rating: