Matchmaker Overview Class UMatchmakerServerBlueprintUtil Review the utility functions available for working with the Matchmaker Server Blueprint API.
Read time 2 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 <MatchmakerServer/Public/Utils/MatchmakerServerBlueprintUtil.h>
Syntax
UCLASS() class UMatchmakerServerBlueprintUtil : public UBlueprintFunctionLibrary
Inherits from UBlueprintFunctionLibrary .
Methods
CreateBackfillTicketOptionsAddStringAttribute(FCreateBackfillTicketOptions&, FString, FString)
Adds a string attribute to CreateBackfillTicketOptions
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateBackfillTicketOptionsAddStringAttribute(UPARAM(ref) FCreateBackfillTicketOptions& Options, FString Key, FString Value)
Parameters
Returns
Type Description Returns if the attribute was successfully added, if not.
CreateBackfillTicketOptionsAddNumberAttribute(FCreateBackfillTicketOptions&, FString, float)
Adds a number attribute to CreateBackfillTicketOptions
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateBackfillTicketOptionsAddNumberAttribute(UPARAM(ref) FCreateBackfillTicketOptions& Options, FString Key, float Value)
Parameters
Returns
Type Description Returns if the attribute was successfully added, if not.
CreateBackfillTicketOptionsRemoveAttribute(FCreateBackfillTicketOptions&, FString)
Removes an attribute from CreateBackfillTicketOptions
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static bool CreateBackfillTicketOptionsRemoveAttribute(UPARAM(ref) FCreateBackfillTicketOptions& 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.
DeserializeMatchmakingResults(FString)
Converts an FString containing JSON for Matchmaking Results to the Blueprint accessible struct. For use only with Multiplay Payload Allocation.
Declaration
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util") static FMatchmakingResults DeserializeMatchmakingResults(FString JsonValueAsString)
Parameters
Name Type Description FString The JSON string to deserialize.
Returns