​

クイックスタート: Unreal Engine 用 PlayFab クライアント ライブラリ

• プレイヤー認証。
• 仮想アイテムと通貨の管理。
• フレンド リストなどのソーシャル機能の作成。 API リファレンス ドキュメント | ライブラリのソース コード | Unreal Marketplace

​

前提条件

• PlayFab デベロッパー アカウント。
• Unreal Engine 用に構成された Visual Studio のインストール。Visual Studio の構成については、Setting Up Visual Studio for Unreal Engine を参照してください。
• Unreal Engine のインストール。Unreal Engine のインストールについては、Unreal Engine インストール ガイド を参照してください。
• PlayFab Unreal プラグインのインストール。Unreal プラグインは Unreal Engine マーケットプレイス からインストールできます。

​

Unreal プロジェクトの作成

1. Project Category で Games を選択します。
2. Select Template で Blank を選択します。
3. Project Settings で C++ または Blueprint のいずれかを選択します。
4. No Starter Content を選択します。
5. プロジェクトに MyProject などの名前を付けます。

​

Unreal プロジェクトで PlayFab プラグインを有効化する

1. Settings メニューの Game Specific Settings の下から Plugins を選択します。
2. PlayFab プラグインを有効化し、必要に応じて Unreal Engine を再起動します。

​

C++ で PlayFab をモジュール依存関係として追加する

1. View メニューから Solution Explorer を開き、C++ プロジェクト ファイルを表示します。
2. Solution Explorer で Solution\Games\YourProjectName\Source に移動し、YourProjectName.Build.cs を開きます。
3. 以下の行を追加します。
   PrivateDependencyModuleNames.AddRange(new string[] { "PlayFab", "PlayFabCpp", "PlayFabCommon" });
   
4. 変更を保存します。

​

必要な Visual Studio プロジェクト ファイルを生成する

1. エクスプローラー ウィンドウを開き、プロジェクト ファイルの保存先フォルダーに移動します。
2. プロジェクトのルート フォルダーで、YourProjectName.uproject ファイルを右クリックします。
3. コンテキスト メニューから Generate Visual Studio project files を選択します。

​

C++ で PlayFab を呼び出す

​

新しい Actor を作成する

1. File メニューから New C++ Class を選択します。
2. Parent Class で Actor を選択します。
3. Actor に LoginActor という名前を付けます。Actor を作成すると、Unreal Engine が自動的に C++ 開発環境を開き、LoginActor.cpp と LoginActor.h を読み込みます。

4. Content Browser から新しい Actor LoginActor を Viewport パネルにドラッグ アンド ドロップします。「World Outliner」ペインに表示されるようになります。 LoginActor が表示されない場合は、Show or hide the source panel アイコンを選択し、C++ classes の下からプロジェクト名を選択してください。

​

C++ の LoginActor に PlayFab API 呼び出しを追加する

1. LoginActor.h の内容を以下のコードに置き換えます。

#pragma once

#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "PlayFab.h"
#include "Core/PlayFabError.h"
#include "Core/PlayFabClientDataModels.h"
#include "LoginActor.generated.h"

UCLASS()
class ALoginActor : public AActor
{
    GENERATED_BODY()
public:
    ALoginActor();
    virtual void BeginPlay() override;
    void OnSuccess(const PlayFab::ClientModels::FLoginResult& Result) const;
    void OnError(const PlayFab::FPlayFabCppError& ErrorResult) const;

    virtual void Tick(float DeltaSeconds) override;
private:
    PlayFabClientPtr clientAPI = nullptr;
};

2. LoginActor.cpp の内容を以下のコードに置き換えます。

#include "LoginActor.h"
#include "Core/PlayFabClientAPI.h"

ALoginActor::ALoginActor()
{
    PrimaryActorTick.bCanEverTick = true;
}

void ALoginActor::BeginPlay()
{
    Super::BeginPlay();
    
    GetMutableDefault<UPlayFabRuntimeSettings>()->TitleId = TEXT("144");
    
    clientAPI = IPlayFabModuleInterface::Get().GetClientAPI();

    PlayFab::ClientModels::FLoginWithCustomIDRequest request;
    request.CustomId = TEXT("GettingStartedGuide");
    request.CreateAccount = true;

    clientAPI->LoginWithCustomID(request,
        PlayFab::UPlayFabClientAPI::FLoginWithCustomIDDelegate::CreateUObject(this, &ALoginActor::OnSuccess),
        PlayFab::FPlayFabErrorDelegate::CreateUObject(this, &ALoginActor::OnError)
    );
}

void ALoginActor::OnSuccess(const PlayFab::ClientModels::FLoginResult& Result) const
{
    UE_LOG(LogTemp, Log, TEXT("Congratulations, you made your first successful API call!"));
}

void ALoginActor::OnError(const PlayFab::FPlayFabCppError& ErrorResult) const
{
    UE_LOG(LogTemp, Error, TEXT("Something went wrong with your first API call.\nHere's some debug information:\n%s"), *ErrorResult.GenerateErrorReport());
}

void ALoginActor::Tick(float DeltaTime)
{
    Super::Tick(DeltaTime);
}

​

C++ で完了と実行

1. Output Log を表示するには、Windows メニューから Developer Tools を選択し、Output Log を有効にします。
2. ツールバーで Compile を選択し、Unreal Engine のコンパイルが完了するまで待ちます。コードのコンパイル中は、Unreal に「Compiling C++ Code.」と表示されます。
3. Play を選択します。コードが実行されると、Unreal は Output Log ウィンドウに以下を表示します。

​

Unreal Blueprints から PlayFab を呼び出す

​

Blueprint 構造を作成する

• Set Play Fab Settings
• Login with Custom ID
• Make ClientLoginWithCustomIDRequest
• AddCustomEvent x 2
• Break PlayFabError
• Print String x 2

• Event BeginPlay の出力ピンを選択し、Event Graph の空いた場所にドラッグします。Executable Actions ダイアログで Set Play Fab Settings を検索し、選択して Blueprint に追加します。Set Play Fab Settings で、Game Title id が空の場合は、ゲームの Title ID を設定します。
• Set Play Fab Settings の出力ピンを選択し、空いた場所にドラッグします。Executable Actions ダイアログで Login with Custom ID を検索し、選択して Blueprint に追加します。
• Login with Custom ID の Request ピンを選択し、空いた場所にドラッグします。Actions providing a(n) Client Login With Custom ID Request Structure から Make ClientLoginWithCustomIDRequest を選択します。
• Make ClientLoginWithCustomIDRequest で:
  • Create Account を選択します。
  • Custom Id を GettingStartedGuide に設定します。
• Login with Custom ID の On Success ピンを選択し、空いた場所にドラッグします。Actions providing a(n) Delegate で Add Custom Event を検索し、選択して Blueprint に追加します。
  • OnLogin という名前を付けます。
• On Failure ピンを選択し、空いた場所にドラッグします。Actions providing a(n) Delegate で Add Custom Event を検索し、選択して Blueprint に追加します。
  • OnFailure という名前を付けます。
• OnLogin の出力ピンを選択し、空いた場所にドラッグします。Executable Actions ダイアログで Print String を検索し、選択して Blueprint に追加します。
  • Print String で、In String の値を “Congratulations, you made your first successful PlayFab API call using Blueprint!” に設定します。
• OnFailure の出力ピンを選択し、空いた場所にドラッグします。Executable Actions ダイアログで Print String を検索し、選択して Blueprint に追加します。
• OnFailure の Error ピンを選択し、空いた場所にドラッグします。Actions providing a(n) string ダイアログで Break PlayFabError を検索し、選択して Blueprint に追加します。Actions taking a(n) PlayFab error structure ダイアログで Break PlayFabError を検索し、選択して Blueprint に追加します。
• Break PlayFabError の Error Message ピンを、失敗時の Print String アクションの In String ピンに接続します。

​

Blueprint で PlayFab 呼び出しを実行する

1. ツールバーで Play ボタンを選択します。
2. Blueprint が実行されると、以下の出力が Viewport ウィンドウに表示されます。

​

その他のリソース

• Unreal Engine の Blueprints Visual Scripting ドキュメント。
• Unreal Engine ドキュメント。