# クラス UMatchmakerClientBlueprintUtil

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

##### Include (含める)##include

```cpp
#include <MatchmakerClient/Public/Utils/MatchmakerClientBlueprintUtil.h>
```

##### 構文##syntax

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

[UBlueprintFunctionLibrary](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Engine/Kismet/UBlueprintFunctionLibrary/) から継承

## メソッド##methods

### PlayerCustomDataAddStringData(FMatchmakerPlayer&, FString, FString)##playercustomdataaddstringdata(fmatchmakerplayer&,-fstring,-fstring)

プレイヤーの CustomData フィールドにカスタムデータの文字列を追加します。

#### 宣言##declaration

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

#### パラメーター##parameters

| **名前**   | **型**                                                                                                     | **説明**                        |
| :------- | :-------------------------------------------------------------------------------------------------------- | :---------------------------- |
| `Player` | [FMatchmakerPlayer](/matchmaker/unreal-engine-sdk/sdk-api/matchmaker-core/models/matchmaker-player.md)`&` | カスタムデータの追加先となるマッチメーカープレイヤーです。 |
| `Key`    | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/)                   | カスタムデータのキーです。                 |
| `Value`  | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/)                   | カスタムデータに追加する文字列値です。           |

#### 戻り値##returns

| **型**  | **説明**                                                   |
| :----- | :------------------------------------------------------- |
| `bool` | カスタムデータが正常に追加された場合には `true`、追加されなかった場合には `false` が返されます。 |

### PlayerCustomDataAddNumberData(FMatchmakerPlayer&, FString, float)##playercustomdataaddnumberdata(fmatchmakerplayer&,-fstring,-float)

プレイヤーの CustomData フィールドにカスタムデータの数値を追加します。

#### 宣言##declaration

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

#### パラメーター##parameters

| **名前**   | **型**                                                                                                     | **説明**                        |
| :------- | :-------------------------------------------------------------------------------------------------------- | :---------------------------- |
| `Player` | [FMatchmakerPlayer](/matchmaker/unreal-engine-sdk/sdk-api/matchmaker-core/models/matchmaker-player.md)`&` | カスタムデータの追加先となるマッチメーカープレイヤーです。 |
| `Key`    | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/)                   | カスタムデータのキーです。                 |
| `Value`  | `float`                                                                                                   | カスタムデータに追加する数値です。             |

#### 戻り値##returns

| **型**  | **説明**                                                   |
| :----- | :------------------------------------------------------- |
| `bool` | カスタムデータが正常に追加された場合には `true`、追加されなかった場合には `false` が返されます。 |

### PlayerCustomDataRemoveData(FMatchmakerPlayer&, FString)##playercustomdataremovedata(fmatchmakerplayer&,-fstring)

[MatchmakerPlayer の CustomData](/matchmaker-unreal/sdk-api/matchmaker-core/models/matchmaker-player.md#customdata) からカスタムデータフィールドを削除します。

#### 宣言##declaration

```cpp
UFUNCTION(BlueprintCallable, Category = "Unity Gaming Services | Matchmaker Util")
static bool PlayerCustomDataRemoveData(UPARAM(ref) FMatchmakerPlayer& Player, FString Key)
```

#### パラメーター##parameters

| **名前**   | **型**                                                                                                     | **説明**                       |
| :------- | :-------------------------------------------------------------------------------------------------------- | :--------------------------- |
| `Player` | [FMatchmakerPlayer](/matchmaker/unreal-engine-sdk/sdk-api/matchmaker-core/models/matchmaker-player.md)`&` | カスタムデータが削除されるマッチメーカープレイヤーです。 |
| `Key`    | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/)                   | 削除するデータのキーです。                |

#### 戻り値##returns

| **型**  | **説明**                                                                                                                                                                            |
| :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bool` | [MatchmakerPlayer](/matchmaker/unreal-engine-sdk/sdk-api/matchmaker-core/models/matchmaker-player.md) `CustomData` に対象のフィールドがあり、かつ削除された場合には `true`、フィールドがなかった場合には `false` が返されます。 |

### CreateTicketOptionsAddStringAttribute(FCreateTicketOptions&, FString, FString)##createticketoptionsaddstringattribute(fcreateticketoptions&,-fstring,-fstring)

CreateTicketOptions に文字列属性を追加します。

#### 宣言##declaration

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

#### パラメーター##parameters

| **名前**    | **型**                                                                                   | **説明**                |
| :-------- | :-------------------------------------------------------------------------------------- | :-------------------- |
| `Options` | [FCreateTicketOptions](../models/create-ticket-options)`&`                              | 属性の追加先となるチケットオプションです。 |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | 属性のキーです。              |
| `Value`   | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | 属性に追加する文字列値です。        |

#### 戻り値##returns

| **型**  | **説明**                                              |
| :----- | :-------------------------------------------------- |
| `bool` | 属性が正常に追加された場合には `true`、追加されなかった場合には `false` が返されます。 |

### CreateTicketOptionsAddNumberAttribute(FCreateTicketOptions&, FString, float)##createticketoptionsaddnumberattribute(fcreateticketoptions&,-fstring,-float)

`CreateTicketOptions` に数値属性を追加します。

#### 宣言##declaration

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

#### パラメーター##parameters

| **名前**    | **型**                                                                                   | **説明**                |
| :-------- | :-------------------------------------------------------------------------------------- | :-------------------- |
| `Options` | [FCreateTicketOptions](../models/create-ticket-options)`&`                              | 属性の追加先となるチケットオプションです。 |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | 属性のキーです。              |
| `Value`   | `float`                                                                                 | 属性に追加する数値です。          |

#### 戻り値##returns

| **型**  | **説明**                                                   |
| :----- | :------------------------------------------------------- |
| `bool` | カスタムデータが正常に追加された場合には `true`、追加されなかった場合には `false` が返されます。 |

### CreateTicketOptionsRemoveAtrribute(FCreateTicketOptions&, FString)##createticketoptionsremoveatrribute(fcreateticketoptions&,-fstring)

CreateTicketOptions から属性を削除します。

#### 宣言##declaration

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

#### パラメーター##parameters

| **名前**    | **型**                                                                                   | **説明**               |
| :-------- | :-------------------------------------------------------------------------------------- | :------------------- |
| `Options` | [FCreateTicketOptions](../models/create-ticket-options)`&`                              | 属性が削除されるチケットオプションです。 |
| `Key`     | [FString](https://docs.unrealengine.com/5.3/en-US/API/Runtime/Core/Containers/FString/) | 削除する属性のキーです。         |

#### 戻り値##returns

| **型**  | **説明**                                                           |
| :----- | :--------------------------------------------------------------- |
| `bool` | Options に対象の属性があり、かつ削除された場合には `true`、属性がなかった場合には `false` が返されます。 |