Skip to content

Mirror::Cloud::ListServerService::ServerJson

Inherits from ICanBeJson

Public Functions

Name
Uri GetServerUri()
Uri from address field
Uri GetCustomUri()
Uri from customAddress field
void SetCustomData(Dictionary< string, string > data)
Updates the customData array
bool Validate()

Public Attributes

Name
string protocol
int port
int playerCount
int maxPlayerCount
string displayName
optional
string address
Uri string of the ip and port of the server.
string customAddress
Can be used to set custom uri
KeyValue [] customData
Array of custom data, use SetCustomData to set values

Public Functions Documentation

function GetServerUri

Uri GetServerUri()

Uri from address field

Return:

function GetCustomUri

Uri GetCustomUri()

Uri from customAddress field

Return:

function SetCustomData

inline void SetCustomData(
    Dictionary< string, string > data
)

Updates the customData array

Parameters:

  • data

function Validate

inline bool Validate()

Public Attributes Documentation

variable protocol

string protocol;

variable port

int port;

variable playerCount

int playerCount;

variable maxPlayerCount

int maxPlayerCount;

variable displayName

string displayName;

optional

variable address

string address;

Uri string of the ip and port of the server.

The ip is calculated by the request to the API

This is returns from the api, any incoming address fields will be ignored

variable customAddress

string customAddress;

Can be used to set custom uri

optional

variable customData

KeyValue [] customData;

Array of custom data, use SetCustomData to set values

optional


Updated on 24 January 2021 at 23:47:09 UTC