Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

MasterServer

class in UnityEngine

Suggest a change

Success!

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The Master Server is used to make matchmaking between servers and clients easy.

You can advertise game hosts or fetch host lists for you game type. The functions here are used to communicate with the Master Server itself which resides on a separate server. If necessary the server itself can be customized. For an overview of the Master Server as well as a technical description see the Master Server manual page.

Static Variables

dedicatedServerReport this machine as a dedicated server.
ipAddressThe IP address of the master server.
portThe connection port of the master server.
updateRateSet the minimum update rate for master server host information update.

Static Functions

ClearHostListClear the host list which was received by MasterServer.PollHostList.
PollHostListCheck for the latest host list received by using MasterServer.RequestHostList.
RegisterHostRegister this server on the master server.
RequestHostListRequest a host list from the master server.
UnregisterHostUnregister this server from the master server.

Messages

OnFailedToConnectToMasterServerCalled on clients or servers when there is a problem connecting to the master server.
OnMasterServerEventCalled on clients or servers when reporting events from the MasterServer.