Nav Logo
Why Meta Quest?
Design
Develop
API reference
Distribute
Blog
Support
Login
Nav Logo
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
Build with Meta
Social Technologies
Meta Horizon
AI
Horizon Worlds
About us
Careers
Research
Products
Virtual reality / Meta Horizon
Developer Blog
Download SDKs
Meta for Work
Programs
Start
Meta Horizon Creator Program
Discover
Why Meta Quest?
What is mixed reality?
Platforms and tools
2D apps for Meta Horizon OS
Devices
Meta Avatars
Success stories
Use cases
Support and legal
Developer policies
Legal
Privacy
Forums
Support
English (US)
© 2025 Meta
API reference
API reference
Select your platform
No SDKs available
No versions available
Overview
AlertViewHUD
Boundary
BoundaryTestResult
Fusion
AvatarBehaviourFusion
AvatarSpawnerFusion
CustomMatchmakingFusion
CustomNetworkObjectProvider
FusionBBEvents
FusionNetworkBootstrapper
LipSyncPhotonFix
PlayerNameTagFusion
PlayerNameTagSpawnerFusion
TransferOwnershipFusion
VoiceSetup
IOVRAnchorComponent
InlineLinkAttribute
Meta
XR
BuildingBlocks
BuildingBlocks
BuildingBlock
ControllerButtonsMapper
ControllerButtonsMapper
ButtonClickAction
InstallationRoutineCheckpoint
PassthroughProjectionSurfaceBuildingBlock
RoomMeshEvent
RunTimeUtils
SharedSpatialAnchorCore
SpatialAnchorCoreBuildingBlock
SpatialAnchorLoaderBuildingBlock
SpatialAnchorLocalStorageManagerBuildingBlock
SpatialAnchorSpawnerBuildingBlock
VariantCheckpoint
EnvironmentDepth
EnvironmentDepth
EnvironmentDepthManager
ImmersiveDebugger
ImmersiveDebugger
CustomIntegrationConfig
CustomIntegrationConfigBase
DebugData
DebugInspector
DebugMember
ExampleCustomIntegrationConfig
Gizmo
Gizmo
DebugGizmos
ICustomIntegrationConfig
InspectedData
RuntimeSettings
UserInterface
UserInterface
CategoryButton
Console
ConsoleLine
DebugBar
DebugInterface
DebugPanel
Generic
Generic
Background
Button
ButtonWithIcon
ButtonWithLabel
Controller
Cursor
Dropdown
Flex
Icon
Image
ImageStyle
InteractableController
Interface
Label
LayoutStyle
OverlayCanvas
OverlayCanvasPanel
Panel
PointerHandler
ScrollView
ScrollViewport
Slider
Style
Switch
TextArea
TextStyle
Toggle
PanelInputModule
Value
Values
InputActions
InputActions
InputActionDefinition
InputActionSet
RuntimeSettings
UserInputActionSet
MultiplayerBlocks
Colocation
Fusion
Fusion
AvatarBehaviourFusion
AvatarSpawnerFusion
CustomMatchmakingFusion
CustomNetworkObjectProvider
FusionBBEvents
FusionNetworkBootstrapper
LipSyncPhotonFix
PlayerNameTagFusion
PlayerNameTagSpawnerFusion
TransferOwnershipFusion
VoiceSetup
NGO
NGO
AutoMatchmakingNGO
AvatarBehaviourNGO
AvatarSpawnerNGO
ClientNetworkTransform
CustomMatchmakingNGO
NGONetworkBootstrapper
PlayerNameTagNGO
PlayerNameTagSpawnerNGO
TransferOwnershipNGO
Shared
Shared
ColocationController
CustomMatchmaking
CustomMatchmaking
ICustomMatchmakingBehaviour
RoomCreationOptions
RoomOperationResult
IAvatarBehaviour
IAvatarStreamConfig
INameTagSpawner
ITransferOwnership
PlayerNameTagSpawner
TransferOwnershipOnSelect
Samples
Telemetry
SampleTelemetryEvents
AnnotationTypes
EventTypes
Util
OVR
Scripts
Input
Input
UIButtonSquishHelper
OVRAnchor
OVRAnchor
FetchOptions
Tracker
TrackerConfiguration
OVRAnchorContainer
OVRAudioSourceTest
OVRAutoDestroyInMRC
OVRBody
OVRBone
OVRBoneCapsule
OVRBoundary
OVRBoundary
BoundaryTestResult
OVRBounded2D
OVRBounded3D
OVRBuildInfo
OVRCameraRig
OVRChromaticAberration
OVRColocationSession
OVRColocationSession
Data
OVRControllerDrivenHandPosesSample
OVRControllerHelper
OVRControllerTest
OVRControllerTest
BoolMonitor
OVRCubemapCapture
OVRCursor
OVRCustomFace
OVRCustomFaceExtensions
OVRCustomSkeleton
OVRDebugHeadController
OVRDebugInfo
OVRDisplay
OVRDisplay
EyeFov
EyeRenderDesc
LatencyData
OVRDynamicObject
OVREnumExtensions
OVRExtensions
OVREyeGaze
OVRFace
OVRFace
IMeshWeightsProvider
OVRFaceExpressions
OVRFaceExpressions
FaceExpressionsEnumerator
WeightProvider
OVRGLTFAccessor
OVRGLTFAnimatinonNode
OVRGLTFAnimationNodeMorphTargetHandler
OVRGLTFLoader
OVRGLTFScene
OVRGazePointer
OVRGrabbable
OVRGrabber
OVRGridCube
OVRHand
OVRHandTest
OVRHandTest
BoolMonitor
OVRHandTrackingWideMotionModeSample
OVRHaptics
OVRHaptics
Config
OVRHapticsChannel
OVRHapticsClip
OVRHeadsetEmulator
OVRHumanBodyBonesMappingsInterface
OVRInput
OVRInput
HapticsAmplitudeEnvelopeVibration
HapticsPcmVibration
OVRControllerBase
OVRControllerBase
VirtualAxis1DMap
VirtualAxis2DMap
VirtualButtonMap
VirtualNearTouchMap
VirtualTouchMap
OVRControllerGamepadPC
OVRControllerHands
OVRControllerLHand
OVRControllerLTouch
OVRControllerRHand
OVRControllerRemote
OVRControllerTouch
OpenVRControllerDetails
OVRInputRayData
OVRKeyboard
OVRKeyboard
TrackedKeyboardInfo
TrackedKeyboardState
OVRKtxTexture
OVRLayerAttribute
OVRLocatable
OVRLocatable
GetSceneAnchorPosesJob
GetSpatialAnchorPosesJob
SetLocalSpaceTransformsJob
SetWorldSpaceTransformsJob
TrackingSpacePose
TransformPosesJob
OVRManager
OVRManager
EventListener
PassthroughCapabilities
OVRMaterialData
OVRMesh
OVRMesh
IOVRMeshDataProvider
OVRMeshAttributes
OVRMeshData
OVRMeshJobs
OVRMeshJobs
NativeArrayHelper
TransformToUnitySpaceJob
TransformTrianglesJob
OVRMeshRenderer
OVRMeshRenderer
IOVRMeshRendererDataProvider
MeshRendererData
OVRMixedRealityCaptureTest
OVRModeParms
OVRMonoscopic
OVRNativeBuffer
OVRNativeList
OVRNativeList
CapacityHelper
OVRNetwork
OVRNetwork
OVRNetworkTcpClient
OVRNetworkTcpServer
OVRNodeStateProperties
OVROverlay
OVROverlay
LayerTexture
OVROverlayCanvas
OVROverlayCanvasSettings
OVROverlayMeshGenerator
OVRPassthroughColorLut
OVRPassthroughLayer
OVRPermissionsRequester
OVRPlatformMenu
OVRPlayerController
OVRPointerVisualizer
OVRPose
OVRProfile
OVRProgressIndicator
OVRRayHelper
OVRRayTransformer
OVRRaycaster
OVRResetOrientation
OVRResources
OVRResult
OVRRoomLayout
OVRRuntimeAssetsBase
OVRRuntimeController
OVRRuntimeSettings
OVRScene
OVRSceneAnchor
OVRSceneLoader
OVRSceneManager
OVRSceneManager
Classification
RoomLayoutInformation
OVRSceneModelLoader
OVRSceneObjectTransformType
OVRScenePlane
OVRScenePlaneMeshFilter
OVRScenePrefabOverride
OVRSceneRoom
OVRSceneSampleController
OVRSceneVolume
OVRSceneVolumeMeshFilter
OVRScreenFade
OVRSemanticClassification
OVRSemanticLabels
OVRSharable
OVRSimultaneousHandsAndControllersSample
OVRSkeleton
OVRSkeleton
IOVRSkeletonDataProvider
SkeletonPoseData
OVRSkeletonRenderer
OVRSkeletonRenderer
IOVRSkeletonRendererDataProvider
SkeletonRendererData
OVRSpace
OVRSpaceUser
OVRSpatialAnchor
OVRSpatialAnchor
EraseOptions
LoadOptions
SaveOptions
UnboundAnchor
OVRSpectatorModeDomeTest
OVRStorable
OVRSystemPerfMetrics
OVRSystemPerfMetrics
OVRSystemPerfMetricsTcpServer
PerfMetrics
OVRTask
OVRTask
Awaiter
OVRTaskBuilder
OVRTextureData
OVRTrackedKeyboard
OVRTrackedKeyboard
TrackedKeyboardSetActiveEvent
TrackedKeyboardVisibilityChangedEvent
OVRTrackedKeyboardHands
OVRTrackedKeyboardHands
TrackedKeyboardHandsVisibilityChangedEvent
OVRTrackedKeyboardSampleControls
OVRTracker
OVRTracker
Frustum
OVRTriangleMesh
OVRUnityHumanoidSkeletonRetargeter
OVRUnityHumanoidSkeletonRetargeter
JointAdjustment
OVRHumanBodyBonesMappings
OVRSkeletonMetadata
OVRSkeletonMetadata
BoneData
OVRVignette
OVRVirtualKeyboard
OVRVirtualKeyboard
AbstractTextHandler
ITextHandler
InteractorRootTransformOverride
WaitUntilKeyboardVisible
OVRVirtualKeyboardInputFieldTextHandler
OVRVirtualKeyboardSampleControls
OVRVirtualKeyboardSampleInputHandler
OVRWaitCursor
OperationResultExtensions
ProcessPort
RoomMeshAnchor
SharedSpatialAnchorErrorHandler
Code samples
Downloads
Release notes
Supported platforms
Meta
​
Back to Supported platforms
CustomMatchmaking Class
Extends MonoBehaviour
Component responsible for creating, joining and leaving game rooms upon developer request.
When using this component you'll also need to add another component to the same gameobject that implements the ICustomMatchmakingBehaviour interface.
Fields
UnityEvent< RoomOperationResult > onRoomCreationFinished[Get]
Event called when a CreateRoom() operation finished.
UnityEvent< RoomOperationResult > onRoomJoinFinished[Get]
Event called when a JoinRoom operation finished.
UnityEvent onRoomLeaveFinished[Get]
Event called when a LeaveRoom operation finished.
Properties
string LobbyName[Get]
bool IsPrivate[Get]
int MaxPlayersPerRoom[Get]
bool IsPasswordProtected[Get]
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 used implementation of the ICustomMatchmakingBehaviour interface supports room passwords.
This is also used for controlling which fields are shown in the inspector UI of the CustomMatchmaking component.
Protected Fields
ICustomMatchmakingBehaviour MatchmakingBehaviour[Get]
Member Functions
async Task< RoomOperationResult > CreateRoom ( )
Creates a new room with the selected options in the component public fields.
Returns
A task you should await for and receive a result with the information on the newly created room.
async 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.
async 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.
async Task< RoomOperationResult > JoinOpenRoom
( string roomLobby )
Joins a room with the selected roomLobby .
Parameters
roomLobby
Identifier of the room lobby you want to join. This is the same lobby name used in the CreateRoom() and CreateRoom(RoomCreationOptions) operations.
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.
Protected Functions
virtual string GenerateRoomPassword ( )
Generates a random room password to be used in the created room when it's requested in a CreateRoom() operation.
May be overriden to implement your own random password generation.
Returns
A random room password to be used in the created room.
See Also
  • Meta::XR::MultiplayerBlocks::Shared::CustomMatchmaking::ICustomMatchmakingBehaviour
  • Meta::XR::MultiplayerBlocks::Shared::CustomMatchmaking::RoomCreationOptions
  • Meta::XR::MultiplayerBlocks::Shared::CustomMatchmaking::RoomOperationResult
Did you find this page helpful?
Thumbs up icon
Thumbs down icon