Documentation

Support

Matchmaker for the Unreal Engine

Matchmaker overview

Matchmaker for the Unreal Engine

Struct FMatchmakingResults

Review the structure containing results from a successful match including teams and allocation details.
Read time 2 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 <MatchmakerServer/Public/Models/MatchmakingResults.h>
Syntax
USTRUCT(BlueprintType)struct MATCHMAKERSERVER_API FMatchmakingResults

Fields

MatchProperties

Represents the match properties.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FMatchProperties MatchProperties

Blueprint

Name

Type

Match PropertiesFMatchProperties

C++

Name

Type

MatchProperties
FMatchProperties

GeneratorName

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FString GeneratorName

Blueprint

Name

Type

Generator NameString

C++

Name

Type

GeneratorName
FString

QueueName

Matchmaking queue that allocated the server.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FString QueueName

Blueprint

Name

Type

Queue NameString

C++

Name

Type

QueueName
FString

PoolName

Matchmaking pool that allocated the server.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FString PoolName

Blueprint

Name

Type

Pool NameString

C++

Name

Type

PoolName
FString

BackfillTicketId

The unique ID of the backfill ticket.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FString BackfillTicketId

Blueprint

Name

Type

Backfill Ticket IdString

C++

Name

Type

BackfillTicketId
FString

MatchId

Unique ID of the match.

Declaration

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

Blueprint

Name

Type

Match IdString

C++

Name

Type

MatchId
FString

PoolId

The ID of pool that the match is in.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")FString PoolId

Blueprint

Name

Type

Pool IdString

C++

Name

Type

PoolId
FString

Methods

Deserializes MatchmakingResults from a JSON string.

FromJson(FString)

Declaration

static FMatchmakingResults FromJson(FString JsonString)

Parameters

Name

Type

Description

JsonString
FStringThe serialized JSON string.

Returns

Type

Description

FMatchmakingResultsThe deserialized FMatchmakingResults.