Struct FMatchProperties

Review the structure containing information about teams and players in a matched game.

Read time 1 minute

Last updated 2 days ago

Important

Unity Matchmaker currently supports Multiplay hosting, or a client-hosted solution provided by Unity, such as Relay and Distributed Authority. The team is working on extending support to third party hosting providers (including Multiplay by Rocket Science and others), and is aiming to deliver this support in advance of March 31st, 2026. Matchmaker will continue to work with Relay and Distributed Authority.

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
Teams	Array 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
Players	Array 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
Region	FString

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 Id	FString

C++

Name	Type
`BackfillTicketId`	FString

Struct FMatchProperties

Include

Syntax

Fields

Teams

Declaration

Blueprint

Name

Type

C++

Name

Type

Players

Declaration

Blueprint

Name

Type

C++

Name

Type

Region

Declaration

Blueprint

Name

Type

C++

Name

Type

BackfillTicketId

Declaration

Blueprint

Name

Type

C++

Name

Type