ConnectedRoomToken
: string
[Get] |
Indicates the token of the game room you're currently connected to.
If not connected this is null. An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
string ConnectedRoomToken |
GameMode
: GameMode
[Get][Set] |
Signature
GameMode GameMode |
IsConnected
: bool
[Get] |
Indicates whether you're currently connected to a game room.
An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
bool IsConnected |
SupportsRoomPassword
: bool
[Get] |
Indicates whether the implementation of this interface supports room passwords.
This is also used for controlling which fields are shown in the inspector UI of the CustomMatchmaking component. An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
bool SupportsRoomPassword |
SelectSessionToJoinFromList
(
sessionList
)
|
Signature
virtual SessionInfo SelectSessionToJoinFromList(List< SessionInfo > sessionList) Parameters sessionList: List< SessionInfo >Returns SessionInfo |
CreateRoom
(
options
)
|
Creates a new room with the selected options .
An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
async Task< CustomMatchmaking.RoomOperationResult > CreateRoom(CustomMatchmaking.RoomCreationOptions options) Parameters options: CustomMatchmaking.RoomCreationOptions
The selected options for creating a new room.
Returns async Task< CustomMatchmaking.RoomOperationResult >
A task you should await for and receive a result with the information on the newly created room.
|
JoinOpenRoom
(
lobbyName
)
|
Joins an open room with the selected lobbyName .
An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
async Task< CustomMatchmaking.RoomOperationResult > JoinOpenRoom(string lobbyName) Parameters lobbyName: string
Identifier of the lobby name containing the rooms you want to join. This is the same lobby name used during the CreateRoom(CustomMatchmaking.RoomCreationOptions) operation.
Returns async Task< CustomMatchmaking.RoomOperationResult >
A task you should await for and receive a result with the information on the newly joined room.
|
JoinRoom
(
roomToken
, roomPassword
)
|
Joins a room with the selected roomToken and roomPassword .
An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
async Task< CustomMatchmaking.RoomOperationResult > JoinRoom(string roomToken, string roomPassword=null) Parameters roomToken: string
Unique identifier of the room you want to join. This is obtained from the CustomMatchmaking.RoomOperationResult obtained after doing a CreateRoom operation.
roomPassword: string
Optional password for rooms that require one when joining. This is obtained from the CustomMatchmaking.RoomOperationResult obtained after doing a CreateRoom operation.
Returns async Task< CustomMatchmaking.RoomOperationResult >
A task you should await for and receive a result with the information on the newly joined room.
|
LeaveRoom
()
|
Leaves the room you're currently connected to.
An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface.
Signature
void LeaveRoom() Returns void |