ICustomMatchmakingBehaviour Interface
The interface used for implementing the matchmaking behaviour over different networking frameworks.
Currently there are implementations for Photon Fusion and Unity Netcode for Gameobjects but more may be added using this interface.
Indicates whether you're currently connected to a game room.
string ConnectedRoomToken[Get]
Indicates the token of the game room you're currently connected to.
If not connected this is null.
bool SupportsRoomPassword[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.
Creates a new room with the selected options .
ParametersoptionsThe selected options for creating a new room.
ReturnsA task you should await for and receive a result with the information on the newly created room.
Joins a room with the selected roomToken and roomPassword .
ParametersroomTokenUnique identifier of the room you want to join. This is obtained from the RoomOperationResult obtained after doing a CreateRoom() operation.
roomPasswordOptional password for rooms that require one when joining. This is obtained from the RoomOperationResult obtained after doing a CreateRoom() operation.
ReturnsA task you should await for and receive a result with the information on the newly joined room.
Joins an open room with the selected lobbyName .
ParameterslobbyNameIdentifier of the lobby name containing the rooms you want to join. This is the same lobby name used during the CreateRoom() operation.
ReturnsA task you should await for and receive a result with the information on the newly joined room.
Leaves the room you're currently connected to.