It implements the CustomMatchmaking.ICustomMatchmakingBehaviour interface and is used by CustomMatchmaking class which handles the non-networking logic.

Fields

automaticallySignIn : bool

Indicates whether this component should do the Unity Services login automatically using the SignIn method.

Signature

bool automaticallySignIn

Properties

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

Protected Methods

SignIn ()

Signs the player in to the Unity Services.

This method is called on awake if automaticallySignIn is set to true.

This method may be overriden if the developer wants the sign-in process to be done in a different way.

Signature

virtual async Task SignIn()

Returns

async Task

Methods

CreateRoom ( roomCreationOptions )	Creates a new room with the selected roomCreationOptions . An implementation of the CustomMatchmaking.ICustomMatchmakingBehaviour interface. Signature async Task< CustomMatchmaking.RoomOperationResult > CreateRoom(CustomMatchmaking.RoomCreationOptions roomCreationOptions) Parameters `roomCreationOptions: 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`