API reference
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.
Properties
bool IsConnected[Get]
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.
Member Functions
Task< RoomOperationResult > CreateRoom
( RoomCreationOptions options )
Creates a new room with the selected options .
Parameters
options
The selected options for creating a new room.
Returns
A task you should await for and receive a result with the information on the newly created room.
Task< RoomOperationResult > JoinRoom
( string roomToken,
string roomPassword )
Joins a room with the selected roomToken and roomPassword .
Parameters
roomToken
Unique identifier of the room you want to join. This is obtained from the RoomOperationResult obtained after doing a CreateRoom() operation.
roomPassword
Optional password for rooms that require one when joining. This is obtained from the RoomOperationResult obtained after doing a CreateRoom() operation.
Returns
A task you should await for and receive a result with the information on the newly joined room.
Task< RoomOperationResult > JoinOpenRoom
( string lobbyName )
Joins an open room with the selected lobbyName .
Parameters
lobbyName
Identifier of the lobby name containing the rooms you want to join. This is the same lobby name used during the CreateRoom() operation.
Returns
A task you should await for and receive a result with the information on the newly joined room.
void LeaveRoom ( )
Leaves the room you're currently connected to.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta