fix: disconnection error when returning to main menu (AscensionGameDev#2258)

(v2)

Author: WeylonSantana

Intersect (Core)/Network/Packets/Client/LogoutPacket.cs

@@ -10,18 +10,14 @@ public LogoutPacket()
         {
         }
 
-        public LogoutPacket(bool returnToCharSelect, bool returnToMainMenu)
+        public LogoutPacket(bool returnToCharSelect)
         {
             ReturningToCharSelect = returnToCharSelect;
-            ReturningToMainMenu = returnToMainMenu;
         }
 
         [Key(0)]
         public bool ReturningToCharSelect { get; set; }
 
-        [Key(1)]
-        public bool ReturningToMainMenu { get; set; }
-
     }
 
 }

Intersect.Client/Core/Main.cs

@@ -194,7 +194,7 @@ private static void ProcessGame()
         {
             if (Globals.ConnectionLost)
             {
-                Logout(false, true);
+                Logout(false);
                 Globals.ConnectionLost = false;
                 return;
             }
@@ -325,7 +325,7 @@ public static void JoinGame()
             Audio.StopMusic(ClientConfiguration.Instance.MusicFadeTimer);
         }
 
-        public static void Logout(bool characterSelect, bool mainMenu, bool skipFade = false)
+        public static void Logout(bool characterSelect, bool skipFade = false)
         {
             Audio.PlayMusic(ClientConfiguration.Instance.MenuMusic, ClientConfiguration.Instance.MusicFadeTimer, ClientConfiguration.Instance.MusicFadeTimer, true);
             if (skipFade)
@@ -339,7 +339,8 @@ public static void Logout(bool characterSelect, bool mainMenu, bool skipFade = f
 
             if (!ClientContext.IsSinglePlayer)
             {
-                PacketSender.SendLogout(characterSelect, mainMenu);
+                Globals.SoftLogout = !characterSelect;
+                PacketSender.SendLogout(characterSelect);
             }
 
             Globals.LoggedIn = false;

Intersect.Client/General/Globals.cs

@@ -38,6 +38,11 @@ public static partial class Globals
 
         public static bool ConnectionLost;
 
+        /// <summary>
+        /// This is used to prevent the client from showing unnecessary disconnect messages
+        /// </summary>
+        public static bool SoftLogout;
+
         //Game Systems
         public static GameContentManager ContentManager;
 

Intersect.Client/Interface/Game/EscapeMenu.cs

@@ -149,7 +149,7 @@ private void LogoutToCharacterSelect(object sender, EventArgs e)
                 Globals.Me.CombatTimer = 0;
             }
 
-            Main.Logout(true, false);
+            Main.Logout(true);
         }
 
         private void LogoutToMainMenu(object sender, EventArgs e)
@@ -159,7 +159,7 @@ private void LogoutToMainMenu(object sender, EventArgs e)
                 Globals.Me.CombatTimer = 0;
             }
 
-            Main.Logout(false, true);
+            Main.Logout(false);
         }
 
         private void ExitToDesktop(object sender, EventArgs e)

Intersect.Client/Interface/Menu/SelectCharacterWindow.cs

@@ -343,7 +343,7 @@ public void Hide()
 
         private void mLogoutButton_Clicked(Base sender, ClickedEventArgs arguments)
         {
-            Main.Logout(false, true, skipFade: true);
+            Main.Logout(false, skipFade: true);
             mMainMenu.Reset();
         }
 

Intersect.Client/Networking/Network.cs

@@ -1,4 +1,4 @@
-using System.Diagnostics;
+using System.Diagnostics;
 using Intersect.Client.Core;
 using Intersect.Client.Framework.Network;
 using Intersect.Client.General;
@@ -69,6 +69,7 @@ public static void DebounceClose(string reason)
                             return;
                         }
 
+                        Globals.SoftLogout = true;
                         _closeTask = default;
                         Close(reason);
                     }
@@ -99,6 +100,7 @@ public static bool InterruptDisconnectsIfConnected()
     private static void OnConnected(INetworkLayerInterface sender, ConnectionEventArgs connectionEventArgs)
     {
         Globals.WaitingOnServer = false;
+        Globals.SoftLogout = false;
     }
 
     private static void OnConnectionFailed(
@@ -125,10 +127,18 @@ private static void OnDisconnected(INetworkLayerInterface sender, ConnectionEven
             ? Strings.Errors.LostConnection.ToString()
             : Strings.Errors.DisconnectionEvent.ToString(connectionEventArgs.EventId);
 
-        Interface.Interface.ShowError(message);
+        // if we did a soft logout we don't want to show the error message
+        if (Globals.SoftLogout)
+        {
+            Globals.SoftLogout = false;
+        }
+        else
+        {
+            Interface.Interface.ShowError(message);
+            Fade.Cancel();
+        }
 
         Globals.WaitingOnServer = false;
-        Fade.Cancel();
 
         if (Globals.GameState != GameStates.InGame && Globals.GameState != GameStates.Loading)
         {

Intersect.Client/Networking/PacketSender.cs

@@ -28,9 +28,9 @@ public static void SendLogin(string username, string password)
             Network.SendPacket(new LoginPacket(username, password));
         }
 
-        public static void SendLogout(bool characterSelect = false, bool mainMenu = true)
+        public static void SendLogout(bool characterSelect = false)
         {
-            Network.SendPacket(new LogoutPacket(characterSelect, mainMenu));
+            Network.SendPacket(new LogoutPacket(characterSelect));
         }
 
         public static void SendNeedMap(params ObjectCacheKey<MapBase>[] cacheKeys)

Intersect.Server.Core/Networking/PacketHandler.cs

@@ -663,13 +663,6 @@ public void HandlePacket(Client client, LogoutPacket packet)
                 client.Entity = default;
                 PacketSender.SendPlayerCharacters(client, skipLoadingRelationships: true);
             }
-            else if(packet.ReturningToMainMenu)
-            {
-                Log.Debug($"[{nameof(LogoutPacket)}] Returning to main menu from player {client.Entity?.Id} ({client.User?.Id})");
-                client.Entity?.TryLogout(false, true);
-                client.Entity = default;
-                client.SetUser(null);
-            }
             else
             {
                 client.Logout();