Class UMatchmakerClientSubsystem
Review the Matchmaker Client Subsystem API reference for creating and managing matchmaking tickets.
Read time 1 minuteLast updated 7 months ago
Important
Unity Matchmaker will support Multiplay Hosting until the deprecation date of March 31st, 2026. To aid your migration away from Multiplay Hosting, migration examples for alternative hosting providers are available. Matchmaker will continue to work with Relay and Distributed Authority after the Multiplay Hosting deprecation.
Declaration
UCLASS()class MATCHMAKERCLIENT_API UMatchmakerClientSubsystem : public UGameInstanceSubsystem
Inherits from UGameInstanceSubsystem.
Overrides
Initialize(FSubsystemCollectionBase&)
Initialize overrides from USubsystem.
Declaration
virtual void Initialize(FSubsystemCollectionBase& Collection) override
Methods
CreateTicket(TArray<FMatchmakerPlayer>, FCreateTicketOptions, THandler<FCreateTicketResponse>)
Creates a matchmaking ticket effectively starting matchmaking.
Declaration
void CreateTicket(TArray<FMatchmakerPlayer> Players, FCreateTicketOptions Options, Unity::Services::Core::THandler<FCreateTicketResponse> ResponseHandler)
Parameters
Name | Type | Description |
|---|---|---|
| TArray | List of players to be added to the ticket (should include at least 1 player). |
| FCreateTicketOptions | Options for creating the ticket. |
| THandler | The response callback to use once CreateTicket has finished. |
DeleteTicket(FGuid, THandler<FDeleteTicketResponse>)
Deletes a matchmaking ticket, ending the matchmaking process. This is called when the client wants to cancel matchmaking for the client.
Declaration
void DeleteTicket(FGuid TicketId, Unity::Services::Core::THandler<FDeleteTicketResponse> ResponseHandler)
Parameters
Name | Type | Description |
|---|---|---|
| FGuid | ID of the ticket to delete. |
| THandler | The response callback to use once DeleteTicket has finished. |
GetTicketStatus(FGuid, THandler<FGetTicketStatusResponse>)
Gets the status of a ticket assignment in the matchmaker. Polls until the assignment is fulfilled. For more information about polling speed and rate limits, refer to Matchmaker limitations.
Declaration
void GetTicketStatus(FGuid TicketId, Unity::Services::Core::THandler<FGetTicketStatusResponse> ResponseHandler)
Parameters
Name | Type | Description |
|---|---|---|
| FGuid | ID of the ticket to access. |
| THandler | The response callback to use once GetTicketStatus has finished. |