fix: same player number for multiple players in second playthrough (#490)

* Added verification that player number is available before re-assigning it to reconnecting player

Author: LPLafontaineB

Assets/BossRoom/Scripts/Client/Game/State/ClientCharSelectState.cs

@@ -218,7 +218,7 @@ void OnLobbyPlayerStateChanged(NetworkListEvent<CharSelectData.LobbyPlayerState>
                 // we haven't chosen a seat yet (or were kicked out of our seat by someone else)
                 UpdateCharacterSelection(CharSelectData.SeatState.Inactive);
                 // make sure our player num is properly set in Lobby UI
-                OnAssignedPlayerNumber(CharSelectData.LobbyPlayers[localPlayerIdx].PlayerNum);
+                OnAssignedPlayerNumber(CharSelectData.LobbyPlayers[localPlayerIdx].PlayerNumber);
             }
             else
             {
@@ -319,7 +319,7 @@ void UpdateSeats()
             // now actually update the seats in the UI
             for (int i = 0; i < m_PlayerSeats.Count; ++i)
             {
-                m_PlayerSeats[i].SetState(curSeats[i].SeatState, curSeats[i].PlayerNum, curSeats[i].PlayerName);
+                m_PlayerSeats[i].SetState(curSeats[i].SeatState, curSeats[i].PlayerNumber, curSeats[i].PlayerName);
             }
         }
 

Assets/BossRoom/Scripts/Server/Game/State/ServerCharSelectState.cs

@@ -53,7 +53,7 @@ private void OnClientChangedSeat(ulong clientId, int newSeatIdx, bool lockedIn)
                         // Instead of granting lock request, change this player to Inactive state.
                         CharSelectData.LobbyPlayers[idx] = new CharSelectData.LobbyPlayerState(clientId,
                             CharSelectData.LobbyPlayers[idx].PlayerName,
-                            CharSelectData.LobbyPlayers[idx].PlayerNum,
+                            CharSelectData.LobbyPlayers[idx].PlayerNumber,
                             CharSelectData.SeatState.Inactive);
 
                         // then early out
@@ -64,7 +64,7 @@ private void OnClientChangedSeat(ulong clientId, int newSeatIdx, bool lockedIn)
 
             CharSelectData.LobbyPlayers[idx] = new CharSelectData.LobbyPlayerState(clientId,
                 CharSelectData.LobbyPlayers[idx].PlayerName,
-                CharSelectData.LobbyPlayers[idx].PlayerNum,
+                CharSelectData.LobbyPlayers[idx].PlayerNumber,
                 lockedIn ? CharSelectData.SeatState.LockedIn : CharSelectData.SeatState.Active,
                 newSeatIdx,
                 Time.time);
@@ -81,7 +81,7 @@ private void OnClientChangedSeat(ulong clientId, int newSeatIdx, bool lockedIn)
                         CharSelectData.LobbyPlayers[i] = new CharSelectData.LobbyPlayerState(
                             CharSelectData.LobbyPlayers[i].ClientId,
                             CharSelectData.LobbyPlayers[i].PlayerName,
-                            CharSelectData.LobbyPlayers[i].PlayerNum,
+                            CharSelectData.LobbyPlayers[i].PlayerNumber,
                             CharSelectData.SeatState.Inactive);
                     }
                 }
@@ -185,46 +185,52 @@ private void OnSceneEvent(SceneEvent sceneEvent)
             SeatNewPlayer(sceneEvent.ClientId);
         }
 
-        private int GetAvailablePlayerNum()
+        private int GetAvailablePlayerNumber()
         {
-            for (int possiblePlayerNum = 0; possiblePlayerNum < CharSelectData.k_MaxLobbyPlayers; ++possiblePlayerNum)
+            for (int possiblePlayerNumber = 0; possiblePlayerNumber < CharSelectData.k_MaxLobbyPlayers; ++possiblePlayerNumber)
             {
-                bool found = false;
-                foreach (CharSelectData.LobbyPlayerState playerState in CharSelectData.LobbyPlayers)
+                if (IsPlayerNumberAvailable(possiblePlayerNumber))
                 {
-                    if (playerState.PlayerNum == possiblePlayerNum)
-                    {
-                        found = true;
-                        break;
-                    }
-                }
-                if (!found)
-                {
-                    return possiblePlayerNum;
+                    return possiblePlayerNumber;
                 }
             }
             // we couldn't get a Player# for this person... which means the lobby is full!
             return -1;
         }
 
+        bool IsPlayerNumberAvailable(int playerNumber)
+        {
+            bool found = false;
+            foreach (CharSelectData.LobbyPlayerState playerState in CharSelectData.LobbyPlayers)
+            {
+                if (playerState.PlayerNumber == playerNumber)
+                {
+                    found = true;
+                    break;
+                }
+            }
+
+            return !found;
+        }
+
         private void SeatNewPlayer(ulong clientId)
         {
             SessionPlayerData? sessionPlayerData = SessionManager<SessionPlayerData>.Instance.GetPlayerData(clientId);
             if (sessionPlayerData.HasValue)
             {
                 var playerData = sessionPlayerData.Value;
-                if (playerData.PlayerNum == -1)
+                if (playerData.PlayerNumber == -1 || !IsPlayerNumberAvailable(playerData.PlayerNumber))
                 {
-                    // If no player num already assigned, get an available one.
-                    playerData.PlayerNum = GetAvailablePlayerNum();
+                    // If no player num already assigned or if player num is no longer available, get an available one.
+                    playerData.PlayerNumber = GetAvailablePlayerNumber();
                 }
-                if (playerData.PlayerNum == -1)
+                if (playerData.PlayerNumber == -1)
                 {
                     // Sanity check. We ran out of seats... there was no room!
-                    throw new Exception($"we shouldn't be here, connection approval should have refused this connection already for client ID {clientId} and player num {playerData.PlayerNum}");
+                    throw new Exception($"we shouldn't be here, connection approval should have refused this connection already for client ID {clientId} and player num {playerData.PlayerNumber}");
                 }
 
-                CharSelectData.LobbyPlayers.Add(new CharSelectData.LobbyPlayerState(clientId, playerData.PlayerName, playerData.PlayerNum, CharSelectData.SeatState.Inactive));
+                CharSelectData.LobbyPlayers.Add(new CharSelectData.LobbyPlayerState(clientId, playerData.PlayerName, playerData.PlayerNumber, CharSelectData.SeatState.Inactive));
                 SessionManager<SessionPlayerData>.Instance.SetPlayerData(clientId, playerData);
             }
         }

Assets/BossRoom/Scripts/Shared/Game/State/CharSelectData.cs

@@ -26,17 +26,17 @@ public struct LobbyPlayerState : INetworkSerializable, IEquatable<LobbyPlayerSta
 
             private FixedPlayerName m_PlayerName; // I'm sad there's no 256Bytes fixed list :(
 
-            public int PlayerNum; // this player's assigned "P#". (0=P1, 1=P2, etc.)
+            public int PlayerNumber; // this player's assigned "P#". (0=P1, 1=P2, etc.)
             public int SeatIdx; // the latest seat they were in. -1 means none
             public float LastChangeTime;
 
             public SeatState SeatState;
 
 
-            public LobbyPlayerState(ulong clientId, string name, int playerNum, SeatState state, int seatIdx = -1, float lastChangeTime = 0)
+            public LobbyPlayerState(ulong clientId, string name, int playerNumber, SeatState state, int seatIdx = -1, float lastChangeTime = 0)
             {
                 ClientId = clientId;
-                PlayerNum = playerNum;
+                PlayerNumber = playerNumber;
                 SeatState = state;
                 SeatIdx = seatIdx;
                 LastChangeTime = lastChangeTime;
@@ -55,7 +55,7 @@ public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReade
             {
                 serializer.SerializeValue(ref ClientId);
                 serializer.SerializeValue(ref m_PlayerName);
-                serializer.SerializeValue(ref PlayerNum);
+                serializer.SerializeValue(ref PlayerNumber);
                 serializer.SerializeValue(ref SeatState);
                 serializer.SerializeValue(ref SeatIdx);
                 serializer.SerializeValue(ref LastChangeTime);
@@ -65,7 +65,7 @@ public bool Equals(LobbyPlayerState other)
             {
                 return ClientId == other.ClientId &&
                        m_PlayerName.Equals(other.m_PlayerName) &&
-                       PlayerNum == other.PlayerNum &&
+                       PlayerNumber == other.PlayerNumber &&
                        SeatIdx == other.SeatIdx &&
                        LastChangeTime.Equals(other.LastChangeTime) &&
                        SeatState == other.SeatState;

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/SessionPlayerData.cs

@@ -5,7 +5,7 @@ namespace Unity.Multiplayer.Samples.BossRoom
     public struct SessionPlayerData : ISessionPlayerData
     {
         public string PlayerName;
-        public int PlayerNum;
+        public int PlayerNumber;
         public Vector3 PlayerPosition;
         public Quaternion PlayerRotation;
         public NetworkGuid AvatarNetworkGuid;
@@ -16,7 +16,7 @@ public SessionPlayerData(ulong clientID, string name, NetworkGuid avatarNetworkG
         {
             ClientID = clientID;
             PlayerName = name;
-            PlayerNum = -1;
+            PlayerNumber = -1;
             PlayerPosition = Vector3.zero;
             PlayerRotation = Quaternion.identity;
             AvatarNetworkGuid = avatarNetworkGuid;