When using the Network Manager, a player is added by default when a client connects to the server. Players are represented by designated GameObjects (See Unity documentation on Player GameObjects to learn more). The player GameObject exists on both the Server and the Client instances.
Different callbacks are received depending on your game’s connection state. These can be set in the Network Manager HUD.
Three connection states are available:
Host: To set your game up in Host mode, select LAN Host(H).
Client: To set your game up in Client mode, select LAN Client(C) and enter the server IP into the text field or use the API function StartClient()
. Note that your server IP must be in the same local network - or you can type “localhost” if you are connecting to the same machine.
Server: To set your game up in Server mode, select LAN Server Only(S).
During run time, the Network Manager HUD’s controls are also available in the Network Manager HUD component’s Inspector window. Click Runtime Controls to access these.
The callbacks in this section are defined in the NetworkBehaviour class and are called only on the player GameObject. To learn more about setting up game states, see Using the Network Manager: Game state management.
Some callbacks require you to have multiple instances of the game running (for example, two Standalone instances, or one Standalone and one in the Editor). These instances can be on the same machine or on different machines, as long as those machines are connected through a local network. This also works in the same way for MatchMaker, but with MatchMaker your machines can also be connected via the Internet.
To get these callbacks you need to have two instances of the game, one running in Server mode and the other running in Client mode. These callbacks are only called on the player GameObject on the Server instance.
Launch the Server mode instance first, then start the Client instance to get the callbacks:
OnStartServer
OnRebuildObservers
(Start()
function is called)
To get these callbacks you need to have two instances of the game, one running in Server mode and the other running in Client mode. These callbacks are only called on the player GameObject on the Client instance.
Launch the Server mode instance first, then start the Client instance to get the callbacks:
OnStartClient
OnStartLocalPlayer
OnStartAuthority
(Start()
function is called)
To get these callbacks you need to have one instance of the game running in Host mode, either in the Editor or as a Standalone build. These callbacks are only called on the Player GameObject:
OnStartServer
OnStartClient
OnRebuildObservers
OnStartAuthority
OnStartLocalPlayer
(Start()
function is called)
OnSetLocalVisibility
To get the OnNetworkDestroy
callback you need to have three Standalone instances of the game, one running in Server mode and two running in Client mode.
Follow the instructions below to get the OnNetworkDestroy
callback:
Start Server instance
Start Client instance
Start a second Client instance
When both Client instances have automatically connected to the Server instance, stop one Client instance
OnNetworkDestroy
is then called on the remaining Client instance, but not on the Server instance
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.