​

Démarrage rapide : plugiciel Unity PlayFab Multiplayer

​

Configuration requise

• Un compte de développeur PlayFab.
• Une copie installée de l’éditeur Unity. Pour installer Unity pour un usage personnel au moyen d’Unity Hub, ou Unity+ pour un usage professionnel, consultez Download Unity. Vérifiez si nécessaire la prise en charge d’Unity dans la documentation de votre plateforme. La version minimale d’Unity prise en charge est Unity 2017 LTS.
• Un projet Unity, qui peut être l’un des suivants :
  • Un tout nouveau projet : pour plus de renseignements, consultez Démarrer Unity pour la première fois.
  • Un projet de tutoriel guidé. Pour plus de renseignements, consultez Getting Started with Unity.
  • Un projet existant.
• Le SDK Unity3D PlayFab « principal » (également inclus dans le plugiciel Multiplayer pour Unity). Pour plus de renseignements sur l’installation du SDK Unity3D, consultez la section « Télécharger et installer le SDK PlayFab » du démarrage rapide : bibliothèque cliente PlayFab pour C# dans Unity.

​

Télécharger et installer le plugiciel Unity PlayFab Multiplayer

1. Téléchargez le package d’assets PlayFab Multiplayer Unity Plugin (utilisez le point de distribution correspondant à votre plateforme).
2. Important! Consultez les informations du fichier README publié avec le plugiciel. Il est adapté à chaque version et peut contenir 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 plugiciel Unity PlayFab Multiplayer dans votre projet, sélectionnez Import.

​

Configurer votre scène

1. Dans l’éditeur Unity, dans la fenêtre Project, accédez à Assets > PlayFabMultiplayerSDK > Prefabs.
2. Depuis le dossier Prefabs, faites glisser PlayfabMultiplayerEventProcessor dans votre scène, dans la fenêtre Hierarchy.
3. Créez dans votre scène un Game Object vide appelé « HelloMultiplayerLogic ».
4. Sélectionnez le Game Object HelloMultiplayerLogic pour ouvrir l’Inspector.
5. Sélectionnez Add Component.
6. Tapez « HelloMultiplayerLogic » 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, HelloMultiplayerLogic.cs.
8. Trouvez le script dans la fenêtre Project et double-cliquez dessus pour le modifier.
9. Ajoutez les instructions using suivantes à votre script :
   using PlayFab;
   using PlayFab.Multiplayer;
   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)
    {
    }
    

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 droit, sélectionnez Other Setting.
5. Trouvez le paramètre Allow unsafe Code et sélectionnez-le.
6. Fermez les fenêtres Build Settings et Project Settings.

​

Créer et rejoindre un lobby

1. Ouvrez le script HelloMultiplayerLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour créer et rejoindre un lobby :
   string entityId = ...; // PlayFab user's entity Id
   string entityType = ...; // PlayFab user's entity type
   
   PlayFabMultiplayer.OnLobbyCreateAndJoinCompleted += this.PlayFabMultiplayer_OnLobbyCreateAndJoinCompleted;
   PlayFabMultiplayer.OnLobbyDisconnected += this.PlayFabMultiplayer_OnLobbyDisconnected;
   
   var createConfig = new LobbyCreateConfiguration()
   {
       MaxMemberCount = 10,
       OwnerMigrationPolicy = LobbyOwnerMigrationPolicy.Automatic,
       AccessPolicy = LobbyAccessPolicy.Public
   };
   
   createConfig.LobbyProperties["Prop1"] = "Value1";
   createConfig.LobbyProperties["Prop2"] = "Value2";
   
   var joinConfig = new LobbyJoinConfiguration();
   joinConfig.MemberProperties["MemberProp1"] = "MemberValue1";
   joinConfig.MemberProperties["MemberProp2"] = "MemberValue2";
   
   PlayFabMultiplayer.CreateAndJoinLobby(
       new PFEntityKey(
           entityId,
           entityType),
       createConfig,
       joinConfig);
   
2. Pour définir le gestionnaire d’événements OnLobbyCreateAndJoinCompleted, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnLobbyCreateAndJoinCompleted(Lobby lobby, int result)
   {
       if (LobbyError.SUCCEEDED(result))
       {
           // Lobby was successfully created
           Debug.Log(lobby.ConnectionString);
       }
       else
       {
           // Error creating a lobby
           Debug.Log("Error creating a lobby");
       }
   }
   
3. Pour définir le gestionnaire d’événements OnLobbyDisconnected, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnLobbyDisconnected(Lobby lobby)
   {
       // Disconnected from lobby
       Debug.Log("Disconnected from lobby!");
   }
   
4. Enregistrez, puis sélectionnez Play dans l’éditeur Unity. La chaîne de connexion du lobby s’affiche dans la fenêtre Console.

​

Rejoindre un lobby

1. Ouvrez le script HelloMultiplayerLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour rejoindre un lobby :
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   
   string connectionString = "<your lobby connection string>";
   
   PlayFabMultiplayer.JoinLobby(
           entityKey,
           connectionString,
           null);
   
2. Pour définir un événement qui se déclenche lorsque votre client local rejoint le lobby, ajoutez le code suivant à la méthode OnLoginSuccess :
   PlayFabMultiplayer.OnLobbyJoinCompleted += this.PlayFabMultiplayer_OnLobbyJoinCompleted;
   
3. Pour définir le gestionnaire d’événements OnLobbyJoinCompleted, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnLobbyJoinCompleted(Lobby lobby, PFEntityKey newMember, int reason)
   {
       if (LobbyError.SUCCEEDED(reason))
       {
           // Successfully joined a lobby
           Debug.Log("Joined a lobby");
       }
       else
       {
           // Error joining a lobby
           Debug.Log("Error joining a lobby");
       }
   }
   
4. Enregistrez, puis sélectionnez Play dans l’éditeur Unity. La chaîne « Joined a lobby » s’affiche dans la fenêtre Console.

​

Rechercher des lobbies

1. Ouvrez le script HelloMultiplayerLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour rechercher des lobbies :
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   
   LobbySearchConfiguration config = new LobbySearchConfiguration();
   PlayFabMultiplayer.FindLobbies(entityKey, config);
   
2. Pour définir un événement qui se déclenche lorsque votre client local trouve des lobbies, ajoutez le code suivant à la méthode OnLoginSuccess :
   PlayFabMultiplayer.OnLobbyFindLobbiesCompleted += this.PlayFabMultiplayer_OnLobbyFindLobbiesCompleted;
   
3. Pour définir le gestionnaire d’événements OnLobbyFindLobbiesCompleted, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnLobbyFindLobbiesCompleted(
       IList<LobbySearchResult> searchResults, 
       PFEntityKey newMember, 
       int reason)
   {
       if (LobbyError.SUCCEEDED(reason))
       {
           // Successfully found lobbies
           Debug.Log("Found lobbies");
   
           // Iterate through lobby search results
           foreach (LobbySearchResult result in searchResults)
           {
               // Examine a search result
           }
       }
       else
       {
           // Error finding lobbies
           Debug.Log("Error finding lobbies");
       }
   }
   
4. Enregistrez, puis sélectionnez Play dans l’éditeur Unity. La chaîne « Found lobbies » s’affiche dans la fenêtre Console.

​

Créer un ticket de matchmaking

1. Ouvrez le script HelloMultiplayerLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour créer un ticket de matchmaking :
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   PFEntityKey remoteEntityKey = ...; // another PlayFab user's entity key
   string remoteUserAttributesJson = ...; // JSON string with another PlayFab user's attributes for matchmaking
   
   PlayFabMultiplayer.OnMatchmakingTicketStatusChanged += PlayFabMultiplayer_OnMatchmakingTicketStatusChanged;
   
   List<MatchUser> localUsers = new List<MatchUser>();
   localUsers.Add(new MatchUser(entityKey, remoteUserAttributesJson));
   
   List<PFEntityKey> membersToMatchWith = new List<PFEntityKey>();
   membersToMatchWith.Add(remoteEntityKey);
   
   PlayFabMultiplayer.CreateMatchmakingTicket(
       localUsers,
       "QuickMatchQueueName",
       membersToMatchWith);
   
2. Pour définir le gestionnaire d’événements OnMatchmakingTicketStatusChanged, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnMatchmakingTicketStatusChanged(MatchmakingTicket ticket)
   {
       // Store and print matchmaking ticket
       Debug.Log(ticket.TicketId);
   
       // Examine matchmaking ticket status
       Debub.Log(ticket.Status)
   
       // Share matchmaking ticket with other clients taking part in matchmaking
   
       // Examine ticket
   }
   
3. Enregistrez, puis sélectionnez Play dans l’éditeur Unity.

​

Rejoindre un ticket de matchmaking

1. Ouvrez le script HelloMultiplayerLogic.cs. Dans la méthode OnLoginSuccess, ajoutez le code suivant pour rejoindre un ticket de matchmaking :
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   string ticketId = ...; // Matchmaking ticket obtained from the client that created the ticket
   
   PlayFabMultiplayer.OnMatchmakingTicketCompleted += PlayFabMultiplayer_OnMatchmakingTicketStatusChanged;
   
   // Create JSON string with PlayFab user's attributes for matchmaking. This will need to be shared with other clients taking part in matchmaking
   string uniqueId = System.Guid.NewGuid().ToString();
   string userAttributesJson = "{\"MatchIdentifier\": \"" + uniqueId + "\"}";
   
   PlayFabMultiplayer.JoinMatchmakingTicketFromId(
       new MatchUser(entityKey, userAttributesJson),
       ticketId,
       "QuickMatchQueueName",
       new List<PFEntityKey>());
   
2. Pour définir le gestionnaire d’événements OnMatchmakingTicketStatusChanged, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnMatchmakingTicketStatusChanged(MatchmakingTicket ticket)
   {
       // Store and print matchmaking ticket
       Debug.Log(ticket.TicketId);
   
       // Examine matchmaking ticket status
       Debub.Log(ticket.Status)
   
       // Share matchmaking ticket with other clients taking part in matchmaking
   
       // Examine ticket
   }
   
3. Enregistrez, puis sélectionnez Play dans l’éditeur Unity.

​

Finaliser un ticket de matchmaking

1. Une partie est trouvée dès que plusieurs tickets de la même file d’attente peuvent être associés. Dans ce cas, le gestionnaire d’événements OnMatchmakingTicketCompleted est déclenché.
2. Abonnez-vous au gestionnaire OnMatchmakignTicketCompleted
   PlayFabMultiplayer.OnMatchmakingTicketCompleted += PlayFabMultiplayer_OnMatchmakingTicketCompleted;
   
3. Pour définir le gestionnaire d’événements OnMatchmakingTicketCompleted, ajoutez le code suivant à la classe :
   private void PlayFabMultiplayer_OnMatchmakingTicketCompleted(MatchmakingTicket ticket, int result)
   {
       if (LobbyError.SUCCEEDED(result))
       {
           // Successfully completed matchmaking ticket
           Debug.Log("Completed matchmaking ticket");
   
           // Examine matchmaking details
           MatchmakingMatchDetails details = ticket.GetMatchDetails();
       }
       else
       {
           // Error completing a matchmaking ticket
           Debug.Log("Error completing a matchmaking ticket");
       }
   }