​

Inicio rápido: complemento PlayFab Multiplayer para Unity

​

Requisitos

• Una cuenta de desarrollador de PlayFab.
• Una copia instalada del editor de Unity. Para instalar Unity para uso personal a través de Unity Hub, o Unity+ para uso profesional, consulte Download Unity. Compruebe la compatibilidad con Unity en la documentación de su plataforma específica si es necesario. La versión mínima compatible de Unity es Unity 2017 LTS.
• Un proyecto de Unity: puede ser cualquiera de los siguientes:
  • Un proyecto totalmente nuevo: para obtener más información, consulte Iniciar Unity por primera vez.
  • Un proyecto de tutorial guiado. Para obtener más información, consulte Getting Started with Unity.
  • Un proyecto existente.
• El SDK “core” de PlayFab para Unity3D (también incluido en el complemento de Unity de Multiplayer). Para obtener información sobre la instalación del SDK de Unity3D, consulte la sección “Descargar e instalar el SDK de PlayFab” de Inicio rápido: biblioteca cliente de PlayFab para C# en Unity.

​

Descargar e instalar el complemento PlayFab Multiplayer para Unity

1. Descargue el paquete de recursos del complemento de Unity de Multiplayer de PlayFab (use un punto de distribución según su plataforma).
2. ¡Importante! Consulte la información del archivo README publicado con el complemento. Está adaptado a cada versión concreta y puede incluir instrucciones importantes específicas de su plataforma.
3. Abra su proyecto de Unity.
4. Vaya a la ubicación donde guardó el archivo .unitypackage y haga doble clic en él para abrir el cuadro de diálogo de importación.
5. Para importar el complemento PlayFab Multiplayer para Unity en su proyecto, seleccione Import.

​

Configurar la escena

1. En el editor de Unity, en la ventana Project, vaya a Assets > PlayFabMultiplayerSDK > Prefabs.
2. Desde la carpeta Prefabs, arrastre y suelte PlayfabMultiplayerEventProcessor en su escena en la ventana Hierarchy.
3. Cree un Game Object vacío en su escena llamado “HelloMultiplayerLogic”.
4. Seleccione el Game Object HelloMultiplayerLogic para abrir el Inspector.
5. Seleccione Add Component.
6. Escriba “HelloMultiplayerLogic” y presione Entrar para mostrar el menú de nuevo script.
7. Presione Entrar de nuevo para crear el nuevo script, HelloMultiplayerLogic.cs.
8. Busque el script en la ventana Project y haga doble clic en él para editarlo.
9. Agregue la siguiente instrucción using a su script:
   using PlayFab;
   using PlayFab.Multiplayer;
   using PlayFab.ClientModels;
   
10. Agregue el siguiente código en el método Start para iniciar sesión en PlayFab.
    // Log into playfab
    var request = new LoginWithCustomIDRequest { CustomId = UnityEngine.Random.value.ToString(), CreateAccount = true };
    PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
    
11. Agregue los siguientes métodos a la clase.
    private void OnLoginSuccess(LoginResult result)
    {
    }
    
    private void OnLoginFailure(PlayFabError error)
    {
    }
    

1. En el editor de Unity, seleccione File > Build Settings.
2. Seleccione su plataforma. Después, en la lista desplegable Architecture, seleccione x86_64 o x64.
3. Seleccione Player Settings.
4. En el panel derecho, seleccione Other Setting.
5. Busque la opción Allow unsafe Code y selecciónela.
6. Cierre las ventanas Build Settings y Project Settings.

​

Crear un lobby y unirse a él

1. Abra el script HelloMultiplayerLogic.cs. En el método OnLoginSuccess, agregue el siguiente código para crear un lobby y unirse a él:
   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. Para definir el controlador de eventos OnLobbyCreateAndJoinCompleted, agregue el siguiente código a la clase:
   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. Para definir el controlador de eventos OnLobbyDisconnected, agregue el siguiente código a la clase:
   private void PlayFabMultiplayer_OnLobbyDisconnected(Lobby lobby)
   {
       // Disconnected from lobby
       Debug.Log("Disconnected from lobby!");
   }
   
4. Guarde y seleccione Play en el editor de Unity. La cadena de conexión del lobby se muestra en la ventana Console.

​

Unirse a un lobby

1. Abra el script HelloMultiplayerLogic.cs. En el método OnLoginSuccess, agregue el siguiente código para unirse a un lobby:
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   
   string connectionString = "<your lobby connection string>";
   
   PlayFabMultiplayer.JoinLobby(
           entityKey,
           connectionString,
           null);
   
2. Para definir un evento que se desencadene cuando su cliente local se una al lobby, agregue el siguiente código al método OnLoginSuccess:
   PlayFabMultiplayer.OnLobbyJoinCompleted += this.PlayFabMultiplayer_OnLobbyJoinCompleted;
   
3. Para definir el controlador de eventos OnLobbyJoinCompleted, agregue el siguiente código a la clase:
   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. Guarde y seleccione Play en el editor de Unity. La cadena “Joined a lobby” se muestra en la ventana Console.

​

Buscar lobbies

1. Abra el script HelloMultiplayerLogic.cs. En el método OnLoginSuccess, agregue el siguiente código para buscar lobbies:
   PFEntityKey entityKey = ...; // PlayFab user's entity key
   
   LobbySearchConfiguration config = new LobbySearchConfiguration();
   PlayFabMultiplayer.FindLobbies(entityKey, config);
   
2. Para definir un evento que se desencadene cuando su cliente local encuentre lobbies, agregue el siguiente código al método OnLoginSuccess:
   PlayFabMultiplayer.OnLobbyFindLobbiesCompleted += this.PlayFabMultiplayer_OnLobbyFindLobbiesCompleted;
   
3. Para definir el controlador de eventos OnLobbyFindLobbiesCompleted, agregue el siguiente código a la clase:
   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. Guarde y seleccione Play en el editor de Unity. La cadena “Found lobbies” se muestra en la ventana Console.

​

Crear un ticket de matchmaking

1. Abra el script HelloMultiplayerLogic.cs. En el método OnLoginSuccess, agregue el siguiente código para crear 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. Para definir el controlador de eventos OnMatchmakingTicketStatusChanged, agregue el siguiente código a la clase:
   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. Guarde y seleccione Play en el editor de Unity.

​

Unirse a un ticket de matchmaking

1. Abra el script HelloMultiplayerLogic.cs. En el método OnLoginSuccess, agregue el siguiente código para unirse a 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. Para definir el controlador de eventos OnMatchmakingTicketStatusChanged, agregue el siguiente código a la clase:
   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. Guarde y seleccione Play en el editor de Unity.

​

Completar un ticket de matchmaking

1. Se encontrará una coincidencia cuando varios tickets de la misma cola sean aptos para emparejarse. En ese caso, se desencadena el controlador de eventos OnMatchmakingTicketCompleted.
2. Suscríbase al controlador OnMatchmakignTicketCompleted
   PlayFabMultiplayer.OnMatchmakingTicketCompleted += PlayFabMultiplayer_OnMatchmakingTicketCompleted;
   
3. Para definir el controlador de eventos OnMatchmakingTicketCompleted, agregue el siguiente código a la clase:
   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");
       }
   }