Documentation

Support

Matchmaker for the Unreal Engine

Matchmaker overview

Matchmaker for the Unreal Engine

Struct FGetTicketStatusResponse

Review the response structure containing the status and details of a matchmaking ticket.
Read time 3 minutesLast updated 2 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.
Include
#include <MatchmakerClient/Public/Models/GetTicketStatusResponse.h>
Syntax
USTRUCT(BlueprintType)struct FGetTicketStatusResponse

Fields

WasSuccessful

Indicates if the request was completed successfully.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")bool bWasSuccessful = false

Blueprint

Name

Type

Default value

Was SuccessfulBooleanfalse

C++

Name

Type

Default value

bWasSuccessful
bool
false

AssignmentType

The ID for the matchmaking ticket that was created.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")FString AssignmentType

Blueprint

Name

Type

Assignment TypeString

C++

Name

Type

AssignmentType
FString

Message

Optional message

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")FString Message

Blueprint

Name

Type

MessageString

C++

Name

Type

Message
FString

Status

The status of the assignment can be Timeout, Failed, InProgress, or Found.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")StatusEnum Status = StatusEnum::InProgress

Blueprint

Name

Type

Default value

StatusStatusEnum
StatusEnum::InProgress

C++

Name

Type

Default value

Status
StatusEnum
StatusEnum::InProgress

Ip

The IP for the server assigned to this ticket.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")FString Ip

Blueprint

Name

Type

IpString

C++

Name

Type

Ip
FString

Port

The port assigned to this ticket result.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")int32 Port = 0

Blueprint

Name

Type

Default value

PortInteger
0

C++

Name

Type

Default value

Port
int32
0

MatchId

Unique ID of the match.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")FString MatchId

Blueprint

Name

Type

Match IdString

C++

Name

Type

MatchId
FString

ErrorMessage

An error message detailing the error.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")FString ErrorMessage

Blueprint

Name

Type

Error MessageString

C++

Name

Type

ErrorMessage
FString

ErrorCode

Error Code (MatchmakerExceptionReason) as int32 for Blueprint compatibility.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Unity Gaming Services | Matchmaker | Model")int32 ErrorCode = Matchmaker::kMatchmakerExceptionOffset

Blueprint

Name

Type

Default value

Error CodeInteger
0

C++

Name

Type

Default value

ErrorCode
int32
0

Methods

GetReasonEnum()

Declaration

EMatchmakerExceptionReason GetReasonEnum() const

Returns

Type

Description

EMatchmakerExceptionReasonThe exception reason as a EMatchmakerExceptionReason.