# Class UMatchmakerServerBlueprintUtil

> Review the utility functions available for working with the Matchmaker Server Blueprint API.

##### Include

```cpp
#include <MatchmakerServer/Public/Utils/MatchmakerServerBlueprintUtil.h>
```

##### Syntax

```cpp
UCLASS()
 class UMatchmakerServerBlueprintUtil : public UBlueprintFunctionLibrary
```

Inherits from [UBlueprintFunctionLibrary](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Engine/Kismet/UBlueprintFunctionLibrary/).

## Methods

### CreateBackfillTicketOptionsAddStringAttribute(FCreateBackfillTicketOptions&, FString, FString)

Adds a string attribute to `CreateBackfillTicketOptions`.

#### Declaration

```cpp
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util")
static bool CreateBackfillTicketOptionsAddStringAttribute(UPARAM(ref) FCreateBackfillTicketOptions& Options, FString Key, FString Value)
```

#### Parameters

| **Name**  | **Type**                                                                                | **Description**                                     |
| :-------- | :-------------------------------------------------------------------------------------- | :-------------------------------------------------- |
| `Options` | [FCreateBackfillTicketOptions](../models/create-backfill-ticket-options)`&`             | The Backfill Ticket Options to add an attribute to. |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | The key for the attribute.                          |
| `Value`   | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | The string value to add for the attribute.          |

#### Returns

| **Type** | **Description**                                                         |
| :------- | :---------------------------------------------------------------------- |
| `bool`   | Returns `true` if the attribute was successfully added, `false` if not. |

### CreateBackfillTicketOptionsAddNumberAttribute(FCreateBackfillTicketOptions&, FString, float)

Adds a number attribute to `CreateBackfillTicketOptions`.

#### Declaration

```cpp
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util")
static bool CreateBackfillTicketOptionsAddNumberAttribute(UPARAM(ref) FCreateBackfillTicketOptions& Options, FString Key, float Value)
```

#### Parameters

| **Name**  | **Type**                                                                                | **Description**                                     |
| :-------- | :-------------------------------------------------------------------------------------- | :-------------------------------------------------- |
| `Options` | [FCreateBackfillTicketOptions](../models/create-backfill-ticket-options)`&`             | The backfill ticket options to add an attribute to. |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | The Key for the attribute.                          |
| `Value`   | `float`                                                                                 | The number value to add for the attribute.          |

#### Returns

| **Type** | **Description**                                                         |
| :------- | :---------------------------------------------------------------------- |
| `bool`   | Returns `true` if the attribute was successfully added, `false` if not. |

### CreateBackfillTicketOptionsRemoveAttribute(FCreateBackfillTicketOptions&, FString)

Removes an attribute from `CreateBackfillTicketOptions`.

#### Declaration

```cpp
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util")
static bool CreateBackfillTicketOptionsRemoveAttribute(UPARAM(ref) FCreateBackfillTicketOptions& Options, FString Key)
```

#### Parameters

| **Name**  | **Type**                                                                                | **Description**                                          |
| :-------- | :-------------------------------------------------------------------------------------- | :------------------------------------------------------- |
| `Options` | [FCreateBackfillTicketOptions](../models/create-backfill-ticket-options)`&`             | The Backfill Ticket Options to remove an attribute from. |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | The Key for the attribute to remove.                     |

#### Returns

| **Type** | **Description**                                                                                                      |
| :------- | :------------------------------------------------------------------------------------------------------------------- |
| `bool`   | Returns `true` if Options contained the attribute and it was removed, or `false` if it didn't contain the attribute. |

### DeserializeMatchmakingResults(FString)

Converts an FString containing JSON for Matchmaking Results to the Blueprint accessible struct. For use with the allocation payload returned by your game server hosting provider.

#### Declaration

```cpp
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util")
static FMatchmakingResults DeserializeMatchmakingResults(FString JsonValueAsString)
```

#### Parameters

| **Name**            | **Type**                                                                                | **Description**                 |
| :------------------ | :-------------------------------------------------------------------------------------- | :------------------------------ |
| `JsonValueAsString` | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | The JSON string to deserialize. |

#### Returns

| **Type**                                             | **Description**                      |
| :--------------------------------------------------- | :----------------------------------- |
| [FMatchmakingResults](../models/matchmaking-results) | The deserialized MatchmakingResults. |
