​

Démarrage rapide : plug-in PlayFab Party pour Unity

Ce démarrage rapide vous aide à installer le SDK Party pour Unity et à effectuer vos premiers appels d’API pour réunir des joueurs dans un réseau Party. Avant de continuer, assurez-vous d’avoir effectué l’étape Activer la fonctionnalité Party via Game Manager depuis votre compte PlayFab.

​

Configuration requise

• Un compte développeur PlayFab.
• Une copie installée de l’éditeur Unity. Pour installer Unity pour un usage personnel via Unity Hub, ou Unity+ pour un usage professionnel, consultez Télécharger Unity. Vérifiez si nécessaire la prise en charge de Unity dans la documentation de votre plateforme spécifique. La version minimale de Unity prise en charge est Unity 2017 LTS.
• Un projet Unity, qui peut être l’une des options suivantes :
  • Un tout nouveau projet : pour plus d’informations, consultez Démarrer Unity pour la première fois.
  • Un projet de tutoriel guidé. Pour plus d’informations, consultez Prise en main de Unity.
  • Un projet existant.
• Le SDK Unity3D PlayFab « principal ». Pour plus d’informations sur l’installation du SDK Unity3D, consultez la section « Télécharger et installer le SDK PlayFab » de Démarrage rapide : bibliothèque cliente PlayFab pour C# dans Unity.

​

Télécharger et installer le plug-in PlayFab Party pour Unity

Suivez ces étapes pour télécharger et installer le plug-in PlayFab Party pour Unity.

1. Téléchargez le package de ressources du plug-in Party pour Unity de PlayFab (utilisez un point de distribution adapté à votre plateforme).
2. Important ! Consultez les informations du fichier README publié avec le plug-in. Il est adapté à chaque version particulière et peut inclure des instructions importantes propres à votre plateforme.
3. Ouvrez votre projet Unity.
4. Accédez à l’emplacement où vous avez enregistré le fichier .unitypackage et double-cliquez dessus pour ouvrir la boîte de dialogue d’importation.
5. Pour importer le plug-in PlayFab Party pour Unity dans votre projet, sélectionnez Import.

​

Configurer votre scène

Cette partie du guide vous montre comment ajouter le PlayFabMultiplayerManager à votre scène pour pouvoir appeler les API PlayFab Party depuis Unity. Avant de pouvoir créer un réseau, un joueur PlayFab doit être connecté. Pour plus d’informations sur la connexion d’un joueur, consultez Effectuer votre premier appel d’API dans Démarrage rapide : bibliothèque cliente PlayFab pour C# dans Unity.

1. Dans l’éditeur Unity, dans la fenêtre Project, accédez à Assets > PlayFabPartySDK > Prefabs.
2. Depuis le dossier Prefabs, faites glisser le PlayFabMultiplayerManager dans votre scène, dans la fenêtre Hierarchy.
3. Créez dans votre scène un Game Object vide appelé « HelloPartyLogic ».
4. Sélectionnez le Game Object HelloPartyLogic pour ouvrir l’Inspector.
5. Sélectionnez Add Component.
6. Tapez « HelloPartyLogic » et appuyez sur Entrée pour afficher le menu de nouveau script.
7. Appuyez de nouveau sur Entrée pour créer le nouveau script, HelloPartyLogic.cs.
8. Recherchez le script dans la fenêtre Project et double-cliquez dessus pour le modifier.
9. Ajoutez l’instruction using suivante à votre script :
   using PlayFab;
   using PlayFab.Party;
   using PlayFab.ClientModels;
   
10. Ajoutez le code suivant dans la méthode Start pour vous connecter à PlayFab.
    // Log into playfab
    var request = new LoginWithCustomIDRequest { CustomId = UnityEngine.Random.value.ToString(), CreateAccount = true };
    PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
    
11. Ajoutez les méthodes suivantes à la classe.
    private void OnLoginSuccess(LoginResult result)
    {
    }
    
    private void OnLoginFailure(PlayFabError error)
    {
    }
    

Le Microsoft GDK et Windows ne prennent en charge que x64. Pour résoudre ces problèmes :

1. Dans l’éditeur Unity, sélectionnez File > Build Settings.
2. Sélectionnez votre plateforme. Ensuite, dans la liste déroulante Architecture, sélectionnez x86_64 ou x64.
3. Sélectionnez Player Settings.
4. Dans le volet de droite, sélectionnez Other Setting.
5. Recherchez le paramètre Allow unsafe Code et sélectionnez-le.
6. Fermez les fenêtres Build Settings et Project Settings.

​

Connexion à un réseau

Cette partie du guide vous montre comment créer et rejoindre un réseau.

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour créer et rejoindre un réseau :
   PlayFabMultiplayerManager.Get().CreateAndJoinNetwork();
   PlayFabMultiplayerManager.Get().OnNetworkJoined += OnNetworkJoined;
   
2. Pour définir le gestionnaire d’événements OnNetworkJoined, ajoutez le code suivant à la classe :
   private void OnNetworkJoined(object sender, string networkId)
   {
       // Print the Network ID so you can give it to the other client.
       Debug.Log(networkId);
   }
   
3. Enregistrez et sélectionnez Play dans l’éditeur Unity. L’ID du réseau s’affiche dans la fenêtre Console.

​

Rejoindre un réseau existant

Cette partie du guide vous montre comment rejoindre un réseau existant créé par un autre client.

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour rejoindre un réseau :
   string networkId = "<your network id>";
   PlayFabMultiplayerManager.Get().JoinNetwork(networkId);
   
2. Pour définir un événement qui se déclenche lorsque votre client local rejoint le réseau, ajoutez le code suivant à la méthode OnLoginSuccess :
   PlayFabMultiplayerManager.Get().OnNetworkJoined += OnNetworkJoined;
   
3. Pour définir le gestionnaire d’événements OnNetworkJoined, ajoutez le code suivant à la classe :
       private void OnNetworkJoined(object sender, string networkId)
       {
           // Print the Network ID so you can give it to the other client.
           Debug.Log("Network joined!");
       }
   
   Il existe de nombreuses façons de transmettre l’ID du réseau de l’hôte aux autres joueurs qui souhaitent le rejoindre. Consultez l’exemple fourni dans ce plug-in Unity pour voir comment procéder.
4. Enregistrez et sélectionnez Play dans l’éditeur Unity. La chaîne « Network joined! » s’affiche dans la fenêtre Console.

​

Accéder aux autres joueurs

Cette partie du guide vous montre comment accéder aux autres joueurs du réseau, y compris au joueur local. Pour être informé de l’arrivée et du départ de joueurs dans le réseau, abonnez-vous aux événements OnRemotePlayerJoined et OnRemotePlayerLeft.

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour créer et rejoindre un réseau :
   PlayFabMultiplayerManager.Get().OnRemotePlayerJoined += OnRemotePlayerJoined;
   PlayFabMultiplayerManager.Get().OnRemotePlayerLeft += OnRemotePlayerLeft;
   
2. Ajoutez les méthodes suivantes à la classe :
   private void OnRemotePlayerLeft(object sender, PlayFabPlayer player)
   {
   }
   
   private void OnRemotePlayerJoined(object sender, PlayFabPlayer player)
   {
   }
   
3. Pour accéder au joueur local, ajoutez le code suivant à la méthode OnRemotePlayerJoined :
   var localPlayer = PlayFabMultiplayerManager.Get().LocalPlayer;
   

La classe PlayFabPlayer contient des propriétés permettant d’identifier le joueur, de le mettre en sourdine et d’afficher son état de chat dans une interface de chat.

​

Envoi et réception de messages de données

Cette partie du guide vous montre comment envoyer et recevoir des messages de données. Avant de pouvoir commencer à envoyer et à recevoir des messages de données, vous devez rejoindre un réseau.

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour écouter les messages de données :
   PlayFabMultiplayerManager.Get().OnDataMessageReceived += LocalPlayer_OnDataMessageReceived;
   
2. Ajoutez le gestionnaire d’événements OnDataMessageRecieved à la classe :
   private void OnDataMessageReceived(object sender, PlayFabPlayer from, byte[] buffer)
   {
       Debug.Log(Encoding.Default.GetString(buffer));
   }
   
3. Pour envoyer un message de données, ajoutez le code suivant à la méthode Update :
   if (Input.GetButtonDown("Fire1"))
   {
       byte[] requestAsBytes = Encoding.UTF8.GetBytes("Hello (data message)");
       PlayFabMultiplayerManager.Get().SendDataMessageToAllPlayers(requestAsBytes);
   }
   

Enregistrez HelloPartyLogic.cs et sélectionnez Play dans l’éditeur Unity.

1. Dans un second client, répétez les étapes de Connexion à un réseau pour créer et rejoindre un réseau.
2. Copiez l’ID de réseau renvoyé dans votre premier client et connectez-vous au réseau.
3. Cliquez sur la scène pour envoyer un message. « Hello (data message) » s’affiche dans la fenêtre Console.

​

Envoi et réception de messages de chat

Cette partie du guide vous montre comment envoyer et recevoir des messages de chat et mettre en sourdine des joueurs distants. En plus du chat textuel, Party active automatiquement le chat vocal entre les joueurs. Avant de pouvoir commencer à envoyer et à recevoir des messages de chat, vous devez rejoindre un réseau.

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour écouter les messages de chat :
   PlayFabMultiplayerManager.Get().OnChatMessageReceived += OnChatMessageReceived;
   
2. Ajoutez le gestionnaire d’événements OnChatMessageReceived à la classe ;
   private void OnChatMessageReceived(object sender, PlayFabPlayer from, string message, ChatMessageType type)
   {
       Debug.Log(message);
   }
   

Enregistrez HelloPartyLogic.cs et appuyez sur Play dans l’éditeur Unity.

1. Dans un second client, répétez les étapes de Connexion à un réseau pour créer et rejoindre un réseau.
2. Copiez l’ID de réseau renvoyé dans votre premier client et connectez-vous au réseau.
3. Lorsque vous cliquez sur votre scène, un message est envoyé et s’affiche dans la fenêtre Console.
4. Si vous souhaitez donner à vos joueurs la possibilité de mettre d’autres joueurs en sourdine, définissez la propriété IsMuted sur true.
   private void OnRemotePlayerJoined(object sender, PlayFabPlayer player)
   {
       // This player will not be able to send text or voice communication.
       // Data messages can still be sent.+
       player.IsMuted = true;
   }
   

​

Connexion à un réseau avec des options de configuration de connectivité entre pairs personnalisées

Cette partie du guide vous montre comment créer et rejoindre un réseau avec des options de configuration de connectivité entre pairs personnalisées. L’option par défaut est P2P ; toutefois, l’utilisateur peut modifier cette option à l’aide de n’importe quelle combinaison des indicateurs présentés ici : DirectPeerConnectivityOptions. Cet exemple montre comment définir P2P :

1. Ouvrez le script HelloPartyLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour créer et rejoindre un réseau :
   PlayfabNetworkConfiguration networkConfiguration = new PlayfabNetworkConfiguration();
   networkConfiguration.DirectPeerConnectivityOptions = PARTY_DIRECT_PEER_CONNECTIVITY_OPTIONS_ANY_PLATFORM_TYPE |
                                                        PARTY_DIRECT_PEER_CONNECTIVITY_OPTIONS_ANY_ENTITY_LOGIN_PROVIDER;
   PlayFabMultiplayerManager.Get().CreateAndJoinNetwork(networkConfiguration);
   PlayFabMultiplayerManager.Get().OnNetworkJoined += OnNetworkJoined;
   

​

Gestion de la suspension du titre

Certaines plateformes prennent en charge la suspension temporaire de l’exécution de votre titre : iOS, Switch et GDK. Lorsque votre titre est suspendu, la pile réseau est invalidée et PlayFab Party ne peut pas maintenir la connexion au réseau PlayFab Party. Une attention particulière est nécessaire pour gérer la suspension et la reprise de l’exécution de votre titre lors de l’utilisation de PlayFab Party.

​

iOS

Sur iOS, vous devez quitter le réseau PlayFab Party puis vous y reconnecter, ce qui peut être réalisé en appelant ResetParty()

​

Switch et GDK

Sur Nintendo Switch et Microsoft GDK, vous devez nettoyer PlayFab Party et toutes les ressources associées à PlayFabMultiplayerManager, puis attendre la reprise de l’exécution du titre avant de réinitialiser PlayFab Party et de vous reconnecter à votre réseau. Pour nettoyer PlayFab Party pendant la suspension d’un titre, appelez Suspend(). Une fois que le titre a repris son exécution, appelez Resume() pour réinitialiser PlayFab Party. Une fois PlayFab Party et toutes les ressources associées à PlayFabMultiplayerManager correctement initialisés, répétez les étapes de Rejoindre un réseau existant.