Matchmaker Overview Class UMatchmakerClientBlueprintUtil Review the utility functions available for working with the Matchmaker Client Blueprint API.
Read time 3 minutes
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 <MatchmakerClient/Public/Utils/MatchmakerClientBlueprintUtil.h>
Syntax
UCLASS() class UMatchmakerClientBlueprintUtil : public UBlueprintFunctionLibrary
Inherits from UBlueprintFunctionLibrary
Methods
PlayerCustomDataAddStringData(FMatchmakerPlayer&, FString, FString)
Adds a string of custom data to a player's CustomData field.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool PlayerCustomDataAddStringData(UPARAM(ref) FMatchmakerPlayer& Player, FString Key, FString Value)
Parameters
Name Type Description FMatchmakerPlayer The matchmaker player to add custom data to. FString The key for the custom data. FString The string value to add for the custom data.
Returns
Type Description Returns if the custom data was successfully added, if not.
PlayerCustomDataAddNumberData(FMatchmakerPlayer&, FString, float)
Adds a number of custom data to a player's CustomData field.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool PlayerCustomDataAddNumberData(UPARAM(ref) FMatchmakerPlayer& Player, FString Key, float Value)
Parameters
Name Type Description FMatchmakerPlayer The matchmaker player to add custom data to. FString The key for the custom data. The number value to add for the custom data.
Returns
Type Description Returns if the custom data was successfully added, if not.
PlayerCustomDataRemoveData(FMatchmakerPlayer&, FString)
Removes a custom data field from a MatchmakerPlayer's CustomData .
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool PlayerCustomDataRemoveData(UPARAM(ref) FMatchmakerPlayer& Player, FString Key)
Parameters
Returns
Type Description Returns if the MatchmakerPlayer contained the field and it was removed, or if it didn't contain the field.
CreateTicketOptionsAddStringAttribute(FCreateTicketOptions&, FString, FString)
Adds a string attribute to a CreateTicketOptions.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateTicketOptionsAddStringAttribute(UPARAM(ref) FCreateTicketOptions& Options, FString Key, FString Value)
Parameters
Returns
Type Description Returns if the attribute was successfully added, if not.
CreateTicketOptionsAddNumberAttribute(FCreateTicketOptions&, FString, float)
Adds a number attribute to a .
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateTicketOptionsAddNumberAttribute(UPARAM(ref) FCreateTicketOptions& Options, FString Key, float Value)
Parameters
Name Type Description FCreateTicketOptions The Ticket Options to add an attribute to. FString The Key for the attribute. The number value to add for the attribute.
Returns
Type Description Returns if the custom data was successfully added, if not.
CreateTicketOptionsRemoveAtrribute(FCreateTicketOptions&, FString)
Removes an attribute from CreateTicketOptions.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateTicketOptionsRemoveAtrribute(UPARAM(ref) FCreateTicketOptions& Options, FString Key)
Parameters
Returns
Type Description Returns if Options contained the attribute and it was removed, or if it didn't contain the attribute.