ドキュメント

サポート

Matchmaker for the Unreal Engine

Matchmaker overview

Matchmaker for the Unreal Engine

クラス UMatchmakerClientBlueprintUtil

Review the utility functions available for working with the Matchmaker Client Blueprint API.
読み終わるまでの所要時間 3 分最終更新 14日前
Include (含める)
#include <MatchmakerClient/Public/Utils/MatchmakerClientBlueprintUtil.h>
構文
UCLASS()class UMatchmakerClientBlueprintUtil : public UBlueprintFunctionLibrary
UBlueprintFunctionLibrary から継承

メソッド

PlayerCustomDataAddStringData(FMatchmakerPlayer&, FString, FString)

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

宣言

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

パラメーター

名前

型

説明

Player
FMatchmakerPlayer
&
カスタムデータの追加先となるマッチメーカープレイヤーです。
Key
FStringカスタムデータのキーです。
Value
FStringカスタムデータに追加する文字列値です。

戻り値

型

説明

bool
カスタムデータが正常に追加された場合には 
true
、追加されなかった場合には 
false
が返されます。

PlayerCustomDataAddNumberData(FMatchmakerPlayer&, FString, float)

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

宣言

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

パラメーター

名前

型

説明

Player
FMatchmakerPlayer
&
カスタムデータの追加先となるマッチメーカープレイヤーです。
Key
FStringカスタムデータのキーです。
Value
float
カスタムデータに追加する数値です。

戻り値

型

説明

bool
カスタムデータが正常に追加された場合には 
true
、追加されなかった場合には 
false
が返されます。

PlayerCustomDataRemoveData(FMatchmakerPlayer&, FString)

MatchmakerPlayer の CustomData からカスタムデータフィールドを削除します。

宣言

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

パラメーター

名前

型

説明

Player
FMatchmakerPlayer
&
カスタムデータが削除されるマッチメーカープレイヤーです。
Key
FString削除するデータのキーです。

戻り値

型

説明

bool
MatchmakerPlayer 
CustomData
に対象のフィールドがあり、かつ削除された場合には 
true
、フィールドがなかった場合には 
false
が返されます。

CreateTicketOptionsAddStringAttribute(FCreateTicketOptions&, FString, FString)

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

宣言

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

パラメーター

名前

型

説明

Options
FCreateTicketOptions
&
属性の追加先となるチケットオプションです。
Key
FString属性のキーです。
Value
FString属性に追加する文字列値です。

戻り値

型

説明

bool
属性が正常に追加された場合には 
true
、追加されなかった場合には 
false
が返されます。

CreateTicketOptionsAddNumberAttribute(FCreateTicketOptions&, FString, float)

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

宣言

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

パラメーター

名前

型

説明

Options
FCreateTicketOptions
&
属性の追加先となるチケットオプションです。
Key
FString属性のキーです。
Value
float
属性に追加する数値です。

戻り値

型

説明

bool
カスタムデータが正常に追加された場合には 
true
、追加されなかった場合には 
false
が返されます。

CreateTicketOptionsRemoveAtrribute(FCreateTicketOptions&, FString)

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

宣言

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

パラメーター

名前

型

説明

Options
FCreateTicketOptions
&
属性が削除されるチケットオプションです。
Key
FString削除する属性のキーです。

戻り値

型

説明

bool
Options に対象の属性があり、かつ削除された場合には 
true
、属性がなかった場合には 
false
が返されます。