Class UMatchmakerClientBlueprintApi
Review the Matchmaker Client Blueprint API reference for creating and managing matchmaking tickets.
Read time 2 minutesLast 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 UMatchmakerClientBlueprintApi : public UBlueprintFunctionLibrary
Inherits from UBlueprintFunctionLibrary
Delegates
FCreateTicketResponseDelegate
Declaration
DECLARE_DYNAMIC_DELEGATE_OneParam(FCreateTicketResponseDelegate, FCreateTicketResponse, Response)
Return Type
FDeleteTicketResponseDelegate
Declaration
DECLARE_DYNAMIC_DELEGATE_OneParam(FDeleteTicketResponseDelegate, FDeleteTicketResponse, Response)
Return Type
FGetTicketStatusResponseDelegate
Declaration
DECLARE_DYNAMIC_DELEGATE_OneParam(FGetTicketStatusResponseDelegate, FGetTicketStatusResponse, Response)
Return Type
Methods
CreateTicket
Creates a matchmaking ticket effectively starting matchmaking.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker", meta = (WorldContext = "WorldContextObject"))static void CreateTicket(TArray<FMatchmakerPlayer> Players, FCreateTicketOptions Options, FCreateTicketResponseDelegate ResponseHandler, const UObject* WorldContextObject)
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. |
| FCreateTicketResponseDelegate | The response callback to use once CreateTicket has finished. |
| |
DeleteTicket
Deletes a matchmaking ticket, ending the matchmaking process. This is called when the client wants to cancel matchmaking for the client.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker", meta = (WorldContext = "WorldContextObject"))static void DeleteTicket(FGuid TicketId, FDeleteTicketResponseDelegate ResponseHandler, const UObject* WorldContextObject)
Parameters
Name | Type | Description |
|---|---|---|
| FGuid | ID of the ticket to delete. |
| FDeleteTicketResponseDelegate | The response callback to use once DeleteTicket has finished. |
| |
GetTicketStatus
Gets the status of a ticket assignment in the matchmaker. Poll until the assignment is fulfilled. For more information about polling speed and rate limits, refer to Matchmaker limitations.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker", meta = (WorldContext = "WorldContextObject"))static void GetTicketStatus(FGuid TicketId, FGetTicketStatusResponseDelegate ResponseHandler, const UObject* WorldContextObject)
Parameters
Name | Type | Description |
|---|---|---|
| FGuid | ID of the ticket to access. |
| FGetTicketStatusResponseDelegate | The response callback to use once CreateTicket has finished. |
| |