​

Démarrage rapide : bibliothèque cliente PlayFab pour Unreal Engine

• L’authentification des joueurs.
• La gestion des objets virtuels et de la monnaie.
• La création de fonctionnalités sociales, comme les listes d’amis. Documentation de référence de l’API | Code source de la bibliothèque | Unreal Marketplace

​

Prérequis

• Un compte de développeur PlayFab.
• Une installation de Visual Studio configurée pour Unreal Engine. Pour plus d’informations sur la configuration de Visual Studio, consultez Configuration de Visual Studio pour Unreal Engine.
• Une installation d’Unreal Engine. Pour plus d’informations sur l’installation d’Unreal Engine, consultez le guide d’installation d’Unreal Engine.
• Une installation du plug-in PlayFab pour Unreal. Vous pouvez installer le plug-in Unreal depuis la marketplace Unreal Engine.

​

Créer un projet Unreal

1. Pour Project Category, sélectionnez Games.
2. Dans Select Template, sélectionnez Blank.
3. Dans Project Settings, sélectionnez C++ ou Blueprint.
4. Choisissez No Starter Content.
5. Choisissez un nom pour votre projet, par exemple MyProject.

​

Activer le plug-in PlayFab dans votre projet Unreal

1. Dans le menu Settings, sous Game Specific Settings, sélectionnez Plugins.
2. Activez le plug-in PlayFab et redémarrez Unreal Engine si nécessaire.

​

Ajouter PlayFab en tant que dépendance de module en C++

1. Dans le menu Affichage, ouvrez l’Explorateur de solutions, qui affiche les fichiers de votre projet C++.
2. Dans l’Explorateur de solutions, accédez à Solution\Games\YourProjectName\Source et ouvrez YourProjectName.Build.cs.
3. Ajoutez la ligne suivante :
   PrivateDependencyModuleNames.AddRange(new string[] { "PlayFab", "PlayFabCpp", "PlayFabCommon" });
   
4. Enregistrez vos modifications.

​

Générer les fichiers de projet Visual Studio nécessaires

1. Ouvrez une fenêtre de l’explorateur de fichiers et accédez au dossier où se trouvent les fichiers de votre projet.
2. Dans le dossier racine du projet, cliquez avec le bouton droit sur le fichier YourProjectName.uproject.
3. Dans le menu contextuel, sélectionnez Generate Visual Studio project files.

​

Appeler PlayFab en C++

​

Créer un nouvel Actor

1. Dans le menu File, sélectionnez New C++ Class.
2. Pour Parent Class, sélectionnez Actor.
3. Nommez votre actor LoginActor. Une fois l’Actor créé, Unreal Engine ouvre automatiquement votre environnement de développement C++ et charge LoginActor.cpp et LoginActor.h.

4. Faites glisser votre nouvel Actor LoginActor depuis le Content Browser vers le panneau Viewport. Il apparaît maintenant dans le volet « World Outliner ». Si vous ne voyez pas votre LoginActor, sélectionnez l’icône Show or hide the source panel. Sélectionnez ensuite le nom de votre projet sous les classes C++.

​

Ajouter des appels d’API PlayFab à votre LoginActor C++

1. Remplacez le contenu de LoginActor.h par le code ci-dessous :

#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. Remplacez le contenu de LoginActor.cpp par le code suivant.

#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);
}

​

Terminer et exécuter en C++

1. Affichez l’Output Log : dans le menu Windows, sélectionnez Developer Tools et activez Output Log.
2. Dans la barre d’outils, sélectionnez Compile et attendez qu’Unreal Engine termine la compilation. Pendant la compilation de votre code, Unreal affiche « Compiling C++ Code ».
3. Sélectionnez Play. Lors de l’exécution du code, Unreal affiche ce qui suit dans la fenêtre Output Log :

​

Appeler PlayFab depuis les Blueprints Unreal

​

Créer une structure Blueprint

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

• Sélectionnez la broche de sortie de Event BeginPlay et faites-la glisser vers un emplacement libre de l’Event Graph. Dans la boîte de dialogue Executable Actions, recherchez Set Play Fab Settings et sélectionnez-la pour l’ajouter à votre Blueprint. Dans Set Play Fab Settings, si Game Title id est vide, définissez-le sur le Title ID de votre jeu.
• Sélectionnez la broche de sortie de Set Play Fab Settings et faites-la glisser vers un emplacement libre. Dans la boîte de dialogue Executable Actions, recherchez Login with Custom ID et sélectionnez-la pour l’ajouter à votre Blueprint.
• Sélectionnez la broche Request de Login with Custom ID et faites-la glisser vers un emplacement vide. Dans Actions providing a(n) Client Login With Custom ID Request Structure, sélectionnez Make ClientLoginWithCustomIDRequest.
• Dans Make ClientLoginWithCustomIDRequest :
  • Sélectionnez Create Account.
  • Définissez Custom Id sur GettingStartedGuide.
• Dans Login with Custom ID, sélectionnez la broche On Success et faites-la glisser vers un emplacement vide. Dans Actions providing a(n) Delegate, recherchez Add Custom Event et sélectionnez-la pour l’ajouter à votre Blueprint.
  • Nommez-le OnLogin.
• Sélectionnez la broche On Failure et faites-la glisser vers un emplacement vide. Dans Actions providing a(n) Delegate, recherchez Add Custom Event et sélectionnez-la pour l’ajouter à votre Blueprint.
  • Nommez-le OnFailure.
• Sélectionnez la broche de sortie de OnLogin et faites-la glisser vers un emplacement vide. Dans la boîte de dialogue Executable Actions, recherchez Print String et sélectionnez-la pour l’ajouter au Blueprint.
  • Dans Print String, définissez la valeur In String sur « Congratulations, you made your first successful PlayFab API call using Blueprint! ».
• Sélectionnez la broche de sortie de OnFailure et faites-la glisser vers un emplacement vide. Dans la boîte de dialogue Executable Actions, recherchez Print String et sélectionnez-la pour l’ajouter au Blueprint.
• Sélectionnez la broche Error de OnFailure et faites-la glisser vers un emplacement vide. Dans la boîte de dialogue Actions providing a(n) string, recherchez Break PlayFabError et sélectionnez-la pour l’ajouter au Blueprint. Dans la boîte de dialogue Actions taking a(n) PlayFab error structure, recherchez Break PlayFabError et sélectionnez-la pour l’ajouter au Blueprint.
• Connectez la broche Error Message de Break PlayFabError à la broche In String de l’action Print String d’échec.

​

Exécuter un appel PlayFab avec Blueprint

1. Dans la barre d’outils, sélectionnez le bouton Play.
2. Lors de l’exécution du Blueprint, la sortie suivante s’affiche dans la fenêtre Viewport.

​

Ressources supplémentaires

• Documentation Unreal Engine sur le Blueprints Visual Scripting.
• Documentation Unreal Engine.