MasterServer

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.

Messages Sent
OnFailedToConnectToMasterServer

Called on clients or servers when there is a problem connecting to the master server.

OnMasterServerEvent

Called on clients or servers when reporting events from the MasterServer.

Class Variables
ipAddress

The IP address of the master server.

port

The connection port of the master server.

updateRate

Set the minimum update rate for master server host information update.

dedicatedServer

Report this machine as a dedicated server.

Class Functions
RequestHostList

Request a host list from the master server.

PollHostList

Check for the latest host list received by using MasterServer.RequestHostList.

RegisterHost

Register this server on the master server.

UnregisterHost

Unregister this server from the master server.

ClearHostList

Clear the host list which was received by MasterServer.PollHostList.