Interface IServerQueryHandler#

The interface for setting the current data supplied to the Multiplay Service via the Server Query Handler.

Namespace: Unity.Services.Multiplay#

Syntax#

public interface IServerQueryHandler : IDisposable

Properties#

BuildId#

The version of the game.

Declaration#

string BuildId { get; set; }

Property Value#

CurrentPlayers#

The number of players currently on the server.

Declaration#

ushort CurrentPlayers { get; set; }

Property Value#

GameType#

The name or identifier of the game type the server is running.

Declaration#

string GameType { get; set; }

Property Value#

Map#

The map or world the server is running for the game.

Declaration#

string Map { get; set; }

Property Value#

MaxPlayers#

The maximum number of players on the server.

Declaration#

ushort MaxPlayers { get; set; }

Property Value#

Port#

The game port that game clients connect to.

Declaration#

ushort Port { get; set; }

Property Value#

ServerName#

The name for the server.

Declaration#

string ServerName { get; set; }

Property Value#

Methods#

UpdateServerCheck()#

Updates the servercheck values for the server. This is expected to be called in an update loop.

Declaration#

void UpdateServerCheck()