ListMatchRequest

class in UnityEngine.Networking.Match

/

Inherits from: Networking.Match.Request

Suggest a change

Description

JSON object to request a list of UNET matches. This list is page based with a 1 index.

Variables

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.
includePasswordMatches	Only return matches that have a password if this is true, only return matches without a password if this is false.
matchAttributeFilterEqualTo	List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is equal to the attribute value for the matching name. No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists.
matchAttributeFilterGreaterThan	List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is greater than the attribute value for the matching name. No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists.
matchAttributeFilterLessThan	List of match attributes to filter against. This will filter down to matches that both have a name that contains the entire text string provided and the value specified in the filter is less than the attribute value for the matching name. No additional wildcards are allowed in the name. A maximum of 10 filters can be specified between all 3 filter lists.
nameFilter	Name filter to apply to the match list.
pageNum	1 based page number requested.
pageSize	Number of results per page to be returned.

Constructors

ListMatchRequest

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.