Documentation

Support

Matchmaker for the Unreal Engine

Matchmaker overview

Matchmaker for the Unreal Engine

Struct FMatchProperties

Review the structure containing information about teams and players in a matched game.
Read time 1 minuteLast 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/MatchProperties.h>
Syntax
USTRUCT(BlueprintType)struct FMatchProperties

Fields

Teams

The list of teams in the match.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")TArray<FMatchmakerTeam> Teams

Blueprint

Name

Type

TeamsArray of FMatchmakerTeam

C++

Name

Type

Teams
TArray
<
FMatchmakerTeam
>

Players

The list of players in the match.

Declaration

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Unity Gaming Services | Matchmaker | Model")TArray<FMatchmakerPlayer> Players

Blueprint

Name

Type

PlayersArray of FMatchmakerPlayer

C++

Name

Type

Players
TArray
<
FMatchmakerPlayer
>

Region

The region where the server is allocated.

Declaration

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

Blueprint

Name

Type

RegionFString

C++

Name

Type

Region
FString

BackfillTicketId

This is the backfill ticket ID and it should use the servers allocation ID to ensure uniqueness for the backfill ticket.

Declaration

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

Blueprint

Name

Type

Backfill Ticket IdFString

C++

Name

Type

BackfillTicketId
FString