Documentation

Support

Matchmaker

Matchmaker

Struct FMatchmakingResults

Review the structure containing results from a successful match including teams and allocation details.
Read time 2 minutesLast updated 2 days ago

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.