CreateMatchRequest

class in UnityEngine.Networking.Match

/

Inherits from: Networking.Match.Request

Suggest a change

Description

JSON object to request a UNET match creation.

Variables

advertise	Bool to describe if the created match should be advertised.
eloScore	The optional game defined Elo score for the client making the request. The Elo score is averaged against all clients in a match and that value is used to produce better search results when listing available matches. If the Elo is provided the result set will be ordered according to the magnitude of the absoloute value of the difference of the a client searching for a match and the network average for all clients in each match. If the Elo score is not provided (and therefore 0 for all matches) the Elo score will not affect the search results. Each game can calculate this value as they wish according to whatever scale is best for that game.
matchAttributes	Match attributes describing game specific features for this match. Each attribute is a key/value pair of a string key with a long value. Each match may have up to 10 of these values. The game is free to use this as desired to assist in finding better match results when clients search for matches to join.
name	Name of the match to create.
password	Password for the match to create. Leave blank for no password. Cannot be null.
privateAddress	The (optional) private network address for the client making the request. This is the local network available private address another client on the same network could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional.
publicAddress	The (optional) public network address for the client making the request. This is the internet available public address another client on the internet (but not the local network) could use to connect directly to the client making the request and may be used to better connect multiple clients. If it is not supplied the networking layer will still be completely functional.
size	Max number of clients that may join the match to create, including the host.

Constructors

CreateMatchRequest

Class constructor.

Public Functions

IsValid	Accessor to verify if the contained data is a valid request with respect to initialized variables and accepted parameters.
ToString	Provides string description of current class data.

Inherited members

Variables

accessTokenString	The JSON encoded binary access token this client uses to authenticate its session for future commands.
appId	AppID for the current game, required in every request. This is generated from the Cloud API.
domain	Domain for the request. All commands will be sandboxed to their own domain; For example no clients with domain 1 will see matches with domain 2. This can be used to prevent incompatible client versions from communicating.
projectId	The Cloud Project Id for this game, required in every request. This is used to match games of the same type.
sourceId	SourceID for the current client, required in every request. This is generated from the Cloud API.
version	Matchmaker protocol version info.