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. |