Démarrage rapide : GDK

Prenez en main le SDK PlayFab Services pour le Microsoft Game Development Kit (GDK). Suivez ces étapes pour inclure les bibliothèques dans votre projet et essayer l’exemple de code des fonctionnalités PlayFab de base. Ce démarrage rapide vous aide à effectuer votre premier appel d’API PlayFab à l’aide du GDK. Avant de continuer, assurez-vous d’avoir suivi les étapes de Démarrage rapide : Game Manager, qui garantissent que vous disposez d’un compte PlayFab et que vous connaissez PlayFab Game Manager.

Configuration requise

Un compte de développeur PlayFab.
Visual Studio 2019 ou 2022 installé.
- Pour plus d’informations sur la configuration requise de Visual Studio pour le développement GDK, consultez Configuration requise du SDK et des outils.

Configuration du projet

Comme pour les autres bibliothèques d’extension du GDK, ajoutez le SDK PlayFab Services via les propriétés du projet. Dans les propriétés de configuration de votre projet, sous Gaming Desktop > General, sélectionnez Gaming Extension Libraries. Dans la boîte de dialogue, cochez PlayFab.Services.C.

Sélectionner la bibliothèque d'extension PlayFab.Services.C

Initialisation et connexion

En-têtes

Incluez PFServices.h pour accéder à toutes les fonctionnalités PlayFab incluses :

#include <playfab/services/PFServices.h>

Initialisation

L’initialisation de PlayFab nécessite deux appels de fonction : PFServicesInitialize et PFServiceConfigCreateHandle. Le résultat de cette initialisation est un PFServiceConfigHandle. Vous fournissez ce handle à un appel de connexion ultérieur, afin de diriger l’appel vers le bon titre dans le back-end PlayFab.

    HRESULT hr = PFServicesInitialize(nullptr); // Add your own error handling when FAILED(hr) == true

    PFServiceConfigHandle serviceConfigHandle{ nullptr };

    hr = PFServiceConfigCreateHandle(
            "https://ABCDEF.playfabapi.com",    // PlayFab API endpoint - obtained in the Game Manager
            "ABCDEF",                           // PlayFab Title id - obtained in the Game Manager
            &serviceConfigHandle);

Connexion

Une fois que vous disposez d’un PFServiceConfigHandle, vous pouvez l’utiliser pour effectuer un appel de connexion de joueur. Dans le GDK, utilisez PFAuthenticationLoginWithXUserAsync. Cette fonction vous permet de connecter un joueur à PlayFab à l’aide d’un XUserHandle. Pour en savoir plus sur l’obtention et la gestion d’un XUserHandle, consultez Identité de l’utilisateur et XUser. Après un appel de connexion, vous pouvez vérifier l’état de l’appel avec XAsyncGetStatus. L’état est initialement E_PENDING et passe à S_OK une fois l’appel terminé avec succès. Si l’appel échoue pour une raison quelconque, l’état reflète cet échec. La gestion des erreurs fonctionne de cette manière pour tous les appels PlayFab Services. Avec un résultat S_OK, vous obtenez un PFEntityHandle. Vous utilisez ce handle pour effectuer les appels PlayFab suivants en tant que joueur connecté. Il contient tous les éléments nécessaires pour s’authentifier auprès du service PlayFab en tant que ce joueur.

    PFAuthenticationLoginWithXUserRequest request{};
    request.createAccount = true;
    request.user = userHandle; // An XUserHandle obtained from XUserAddAsync

    XAsyncBlock async{};
    HRESULT hr = PFAuthenticationLoginWithXUserAsync(serviceConfigHandle, &request, &async); // Add your own error handling when FAILED(hr) == true
    hr = XAsyncGetStatus(&async, true); // This is doing a blocking wait for completion, but you can use the XAsyncBlock to set a callback instead for async style usage

    std::vector<char> loginResultBuffer;
    PFAuthenticationLoginResult const* loginResult;
    size_t bufferSize;
    hr = PFAuthenticationLoginWithXUserGetResultSize(&async, &bufferSize);
    loginResultBuffer.resize(bufferSize);

    PFEntityHandle entityHandle{ nullptr };
    hr = PFAuthenticationLoginWithXUserGetResult(&async, &entityHandle, loginResultBuffer.size(), loginResultBuffer.data(), &loginResult, nullptr);

Gérer la suspension et la reprise

Les jeux GDK peuvent être suspendus pendant de longues périodes (par exemple, via Quick Resume). Si le jeton d’entité expire pendant la suspension, le SDK le détecte à la reprise et en informe votre jeu. Vous devez vous inscrire au TokenExpiredHandler tôt dans le cycle de vie de votre jeu afin de pouvoir vous réauthentifier et reconnecter les services si nécessaire. Pour plus de détails, consultez Gérer l’expiration des jetons.

Appels de service

Une fois le joueur connecté, vous pouvez effectuer des appels au back-end PlayFab. Voici un exemple d’appel permettant d’obtenir les fichiers stockés dans PlayFab pour le joueur actuel.

Obtenir l’EntityKey

Pour certains appels à PlayFab, il peut être utile de connaître la PFEntityKey du joueur. Une fois que vous disposez d’un PFEntityToken, vous pouvez récupérer une PFEntityKey avec PFEntityGetEntityKey.

    PFEntityKey const* pEntityKey{};
    std::vector<char> entityKeyBuffer;
    size_t size{};
    HRESULT hr = PFEntityGetEntityKeySize(entityHandle, &size); // Add your own error handling when FAILED(hr) == true

    entityKeyBuffer.resize(size);
    hr = PFEntityGetEntityKey(entityHandle, entityKeyBuffer.size(), entityKeyBuffer.data(), &pEntityKey, nullptr);

Appeler GetFiles

Tous les appels PlayFab suivent un modèle similaire : préparation de l’objet de requête, appel (à l’aide du PFEntityHandle obtenu lors de la connexion), création d’un objet destiné à recevoir la réponse, puis appel d’une fonction GetResult pour remplir le conteneur nouvellement créé.

    XAsyncBlock async{};
    PFDataGetFilesRequest requestFiles{};
    requestFiles.entity = pEntityKey;

    HRESULT hr = PFDataGetFilesAsync(entityHandle, &requestFiles, &async); // Add your own error handling when FAILED(hr) == true
    hr = XAsyncGetStatus(&async, true); // This is doing a blocking wait for completion, but you can use the XAsyncBlock to set a callback instead for async style usage

    size_t resultSize;
    hr = PFDataGetFilesGetResultSize(&async, &resultSize);

    std::vector<char> getFilesResultBuffer(resultSize);
    PFDataGetFilesResponse* getFilesResponseResult{ nullptr };
    hr = PFDataGetFilesGetResult(&async, getFilesResultBuffer.size(), getFilesResultBuffer.data(), &getFilesResponseResult, nullptr);

Nettoyage

Lorsque votre jeu est prêt à s’arrêter, ou si vous devez nettoyer PlayFab pour une autre raison, veillez à fermer tous les handles ouverts et à appeler PFServicesUninitializeAsync.

    PFEntityCloseHandle(entityHandle);
    entityHandle = nullptr;

    PFServiceConfigCloseHandle(serviceConfigHandle);
    serviceConfigHandle = nullptr;

    XAsyncBlock async{};
    HRESULT hr = PFServicesUninitializeAsync(&async); // Add your own error handling when FAILED(hr) == true
    hr = XAsyncGetStatus(&async, true); // This is doing a blocking wait for completion, but you can use the XAsyncBlock to set a callback instead for async style usage

Modèle d’API asynchrone

Le SDK PlayFab Services pour le GDK suit le modèle de programmation asynchrone implémenté dans le GDK. Ce modèle de programmation implique l’utilisation de tâches et de files d’attente de tâches fournies par la bibliothèque XAsync. Ce modèle est cohérent avec les autres fonctions et extensions du GDK (comme l’API XBOX Services). Bien qu’il introduise une certaine complexité, il offre également un haut niveau de contrôle sur les opérations asynchrones. Cet exemple montre comment effectuer un appel asynchrone à PFDataGetFilesAsync.

    auto async = std::make_unique<XAsyncBlock>();
    async->callback = [](XAsyncBlock* async)
    {
        std::unique_ptr<XAsyncBlock> asyncBlockPtr{ async }; // take ownership of XAsyncBlock

        size_t resultSize;
        HRESULT hr = PFDataGetFilesGetResultSize(async, &resultSize);
        if (SUCCEEDED(hr))
        {
            std::vector<char> getFilesResultBuffer(resultSize);
            PFDataGetFilesResponse* getFilesResponseResult{ nullptr };
            PFDataGetFilesGetResult(async, getFilesResultBuffer.size(), getFilesResultBuffer.data(), &getFilesResponseResult, nullptr);
        }
    };

    PFDataGetFilesRequest requestFiles{};
    requestFiles.entity = m_pEntityKey;
    HRESULT hr = PFDataGetFilesAsync(m_entityHandle, &requestFiles, async.get());
    if (SUCCEEDED(hr))
    {
        async.release(); // at this point, the callback will be called so release the unique ptr
    }

Gestion des erreurs

Les opérations XAsync terminées renvoient des codes d’état HTTP. Un code d’état d’erreur se traduit par un HRESULT d’échec, tel que HTTP_E_STATUS_NOT_FOUND, lors de l’appel de XAsyncGetStatus() ou de l’une des API PF*Get(). Pour afficher les messages d’erreur détaillés renvoyés par le service, consultez la section suivante sur le débogage. Ces messages d’erreur détaillés peuvent être utiles pendant le développement pour mieux comprendre comment le service PlayFab réagit aux requêtes du client.

Débogage

Le moyen le plus simple d’afficher les résultats et de déboguer les appels du SDK PlayFab Services consiste à activer le traçage de débogage. L’activation du traçage de débogage vous permet à la fois d’afficher les résultats dans la fenêtre de sortie du débogueur et de les intégrer aux journaux de votre jeu.

Référence

Documentation de référence de l’API

​Démarrage rapide : GDK

​Configuration requise

​Configuration du projet

​Initialisation et connexion

​En-têtes

​Initialisation

​Connexion

​Gérer la suspension et la reprise

​Appels de service

​Obtenir l’EntityKey

​Appeler GetFiles

​Nettoyage

​Modèle d’API asynchrone

​Gestion des erreurs

​Débogage

​Référence