Documentation

Matchmaker for the Unreal Engine

Matchmaker overview

Matchmaker for the Unreal Engine

Class UMatchmakerClientBlueprintApi

Review the Matchmaker Client Blueprint API reference for creating and managing matchmaking tickets.
Read time 1 minuteLast updated 2 months ago
Declaration
UCLASS()class UMatchmakerClientBlueprintApi : public UBlueprintFunctionLibrary
Inherits from UBlueprintFunctionLibrary

Delegates

FCreateTicketResponseDelegate

Declaration

DECLARE_DYNAMIC_DELEGATE_OneParam(FCreateTicketResponseDelegate, FCreateTicketResponse, Response)

Return Type

FCreateTicketResponse

FDeleteTicketResponseDelegate

Declaration

DECLARE_DYNAMIC_DELEGATE_OneParam(FDeleteTicketResponseDelegate, FDeleteTicketResponse, Response)

Return Type

FDeleteTicketResponse

FGetTicketStatusResponseDelegate

Declaration

DECLARE_DYNAMIC_DELEGATE_OneParam(FGetTicketStatusResponseDelegate, FGetTicketStatusResponse, Response)

Return Type

FGetTicketStatusResponse

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

Players
TArray
<
FMatchmakerPlayer
>
List of players to be added to the ticket (should include at least 1 player).
Options
FCreateTicketOptionsOptions for creating the ticket.
ResponseHandler
FCreateTicketResponseDelegateThe response callback to use once CreateTicket has finished.
WorldContextObject
const
UObject
*

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

TicketId
FGuidID of the ticket to delete.
ResponseHandler
FDeleteTicketResponseDelegateThe response callback to use once DeleteTicket has finished.
WorldContextObject
const
UObject
*

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

TicketId
FGuidID of the ticket to access.
ResponseHandler
FGetTicketStatusResponseDelegateThe response callback to use once CreateTicket has finished.
WorldContextObject
const
UObject
*