Démarrage rapide : macOS

Prenez en main le SDK PlayFab Services pour macOS. 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 SDK macOS. 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.
L’IDE XCode installé.

Configuration du projet

Téléchargez le SDK PlayFab macOS dans votre projet depuis la page des versions du SDK PlayFab.

Intégrer le SDK C PlayFab à votre propre projet

Ajouter les binaires à votre jeu

Une fois vos binaires obtenus, par téléchargement ou par génération à partir du code source, vous devriez pouvoir les intégrer facilement à votre jeu/application. Vous devez ajouter les binaires suivants à votre jeu :

HttpClient_macOS.xcframework
PlayFabCore_macOS.xcframework
PlayFabServices_macOS.xcframework

Suivez ces instructions pour les ajouter :

Dans XCode, accédez à la cible souhaitée et sélectionnez-la.
Dans la section General, faites défiler vers le bas et, dans la section “Frameworks, Libraries, and Embedded Content”, sélectionnez le signe ”+”.
Recherchez vos binaires PlayFabServices / PlayFabCore / HttpClient et sélectionnez les dossiers xcframework. (Vous pouvez également sélectionner une bibliothèque spécifique en naviguant à l’intérieur des dossiers xcframework, mais il est recommandé d’importer le bundle xcframework, car il fonctionne à la fois pour les builds sur appareil et sur simulateur.)
Une fois les binaires importés avec succès, HttpClient_macOS, PlayFabCore_macOS et PlayFabServices_macOS apparaissent sous Frameworks, Libraries, and Embedded Content.

Ajouter les chemins de recherche des en-têtes

Une fois les binaires ajoutés, vous devez vous assurer que les chemins de recherche des en-têtes sont également correctement configurés.

Accédez à votre projet.
Sélectionnez “Build Settings”, puis recherchez “Header Search Paths”.
Mettez à jour la valeur de la propriété pour inclure les en-têtes du SDK. Ajoutez une référence aux en-têtes du dossier include. Exemple :
PlayFabCSdk-macOS/include

Initialisation et connexion

Suivez les étapes suivantes pour faire fonctionner quelques exemples d’appels PlayFab :

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 SDK, utilisez une méthode PFAuthenticationLoginWith*Async telle que PFAuthenticationLoginWithAppleAsync. Cette fonction vous permet de connecter un joueur à PlayFab à l’aide du jeton d’identité d’un utilisateur Apple. (consultez la documentation d’Apple sur l’authentification des utilisateurs avec Sign in with Apple). 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 façon 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.

PFAuthenticationLoginWithAppleRequest request{};
request.createAccount = true;
request.identityToken = identityToken; // A user identity token obtained from Apple

XAsyncBlock async{};
hr = PFAuthenticationLoginWithAppleAsync(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 = PFAuthenticationLoginWithAppleGetResultSize(&async, &bufferSize);
loginResultBuffer.resize(bufferSize);

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

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, assurez-vous de 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 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 retournent 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 retourné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.

Voir aussi

Documentation de référence de l’API

​Démarrage rapide : macOS

​Configuration requise

​Configuration du projet

​Intégrer le SDK C PlayFab à votre propre projet

​Ajouter les binaires à votre jeu

​Ajouter les chemins de recherche des en-têtes

​Initialisation et connexion

​En-têtes

​Initialisation

​Connexion

​Appels de service

​Obtenir l’EntityKey

​Appeler GetFiles

​Nettoyage

​Modèle d’API asynchrone

​Gestion des erreurs

​Débogage

​Voir aussi