PICO Platform Unity SDK
MatchmakingOptions Class Reference

Public Member Functions

void SetCreateRoomDataStore (string key, string value)
 Sets the data store for a room. More...
 
void ClearCreateRoomDataStore ()
 Clears the data store for a room.
 
void SetCreateRoomJoinPolicy (RoomJoinPolicy value)
 Sets a join policy for a room. More...
 
void SetCreateRoomMaxUsers (uint value)
 Sets the maximum number of users allowed for a room. More...
 
void SetEnqueueDataSettings (string key, int value)
 Sets an integer data setting for a query of a matchmaking pool. More...
 
void SetEnqueueDataSettings (string key, double value)
 Sets a float data setting for a query of a matchmaking pool. More...
 
void SetEnqueueDataSettings (string key, string value)
 Sets a string data setting for a query of a matchmaking pool. More...
 
void ClearEnqueueDataSettings ()
 Clears data settings for a query of a matchmaking pool.
 
void SetEnqueueIsDebug (bool value)
 Sets whether to return the debugging information. More...
 
void SetEnqueueQueryKey (string value)
 Sets the query for a matchmaking. More...
 
IntPtr GetHandle ()
 

Static Public Member Functions

static operator IntPtr (MatchmakingOptions matchmakingOptions)
 For passing to native C.
 

Member Function Documentation

◆ SetCreateRoomDataStore()

void SetCreateRoomDataStore ( string  key,
string  value 
)
inline

Sets the data store for a room.

Parameters
keyA unique identifier that maps to a value.
valueThe data.

◆ SetCreateRoomJoinPolicy()

void SetCreateRoomJoinPolicy ( RoomJoinPolicy  value)
inline

Sets a join policy for a room.

Parameters
valueThe enumerations of join policy:
  • 0: None
  • 1: Everyone
  • 2: FriendsOfMembers
  • 3: FriendsOfOwner
  • 4: InvitedUsers
  • 5: Unknown

◆ SetCreateRoomMaxUsers()

void SetCreateRoomMaxUsers ( uint  value)
inline

Sets the maximum number of users allowed for a room.

Parameters
valueThe maximum number of users.

◆ SetEnqueueDataSettings() [1/3]

void SetEnqueueDataSettings ( string  key,
int  value 
)
inline

Sets an integer data setting for a query of a matchmaking pool.

Parameters
keyA unique identifier that maps a value.
valueThe data (integer).

◆ SetEnqueueDataSettings() [2/3]

void SetEnqueueDataSettings ( string  key,
double  value 
)
inline

Sets a float data setting for a query of a matchmaking pool.

Parameters
keyA unique identifier that maps a value.
valueThe data.

◆ SetEnqueueDataSettings() [3/3]

void SetEnqueueDataSettings ( string  key,
string  value 
)
inline

Sets a string data setting for a query of a matchmaking pool.

Parameters
keyA unique identifier that maps a value.
valueThe data.

◆ SetEnqueueIsDebug()

void SetEnqueueIsDebug ( bool  value)
inline

Sets whether to return the debugging information.

Parameters
value
  • true: return the debugging information with the response payload
  • false: do not return the debugging information

◆ SetEnqueueQueryKey()

void SetEnqueueQueryKey ( string  value)
inline

Sets the query for a matchmaking.

Parameters
valueThe key of the target query.

One matchmaking pool can include multiple queries which are created on the PICO Developer Platform. You can choose which query to use before starting a matchmaking.