Merge pull request #543 from sp00ktober/bugfix

more error messages and reconnect command

Author: starfi5h

NebulaPatcher/Patches/Dynamic/GameCamera_Patch.cs

@@ -0,0 +1,18 @@
+using HarmonyLib;
+using NebulaWorld;
+using NebulaWorld.GameStates;
+
+namespace NebulaPatcher.Patches.Dynamic
+{
+    [HarmonyPatch(typeof(GameCamera))]
+    public class GameCamera_Patch
+    {
+        [HarmonyPrefix]
+        [HarmonyPatch(nameof(GameCamera.Logic))]
+        public static bool Logic_Prefix()
+        {
+            // prevent NRE while doing a reconnect as a client issued through the chat command
+            return !(GameStatesManager.DuringReconnect && GameMain.mainPlayer == null);
+        }
+    }
+}

NebulaPatcher/Patches/Dynamic/GameData_Patch.cs

@@ -6,6 +6,7 @@
 using NebulaModel.Packets.Players;
 using NebulaPatcher.Patches.Transpilers;
 using NebulaWorld;
+using NebulaWorld.Warning;
 using System;
 using UnityEngine;
 
@@ -56,13 +57,29 @@ public static bool GetOrCreateFactory_Prefix(GameData __instance, ref PlanetFact
                     factoryIndex = GameMain.data.factoryCount++;
                     planet.factoryIndex = factoryIndex;
                     __instance.factories[factoryIndex] = new PlanetFactory();
-                    __instance.factories[factoryIndex].Import(factoryIndex, __instance, reader.BinaryReader);
+                    try
+                    {
+                        __instance.factories[factoryIndex].Import(factoryIndex, __instance, reader.BinaryReader);
+                    }
+                    catch(System.InvalidOperationException e)
+                    {
+                        HandleRemoteDataImportError(e);
+                        return false;
+                    }
                     planet.factory = __instance.factories[factoryIndex];
                 }
                 else
                 {
                     factoryIndex = planet.factoryIndex;
-                    __instance.factories[factoryIndex].Import(factoryIndex, __instance, reader.BinaryReader);
+                    try
+                    {
+                        __instance.factories[factoryIndex].Import(factoryIndex, __instance, reader.BinaryReader);
+                    }
+                    catch (System.InvalidOperationException e)
+                    {
+                        HandleRemoteDataImportError(e);
+                        return false;
+                    }
                     planet.factory = __instance.factories[factoryIndex];
                 }
                 // Initial FactoryProductionStat for other in-game stats checking functions
@@ -81,6 +98,15 @@ public static bool GetOrCreateFactory_Prefix(GameData __instance, ref PlanetFact
             return false;
         }
 
+        // a user reported to receive an error regarding decompressing the lz4 data which breaks the game as the planet factory cant be loaded.
+        // it is not known what exactly caused the error but that client seemed to have an instable internet connection.
+        // so we give advice in this rare situation to issue a reconnect.
+        private static void HandleRemoteDataImportError(System.InvalidOperationException e)
+        {
+            WarningManager.DisplayCriticalWarning($"Failed to properly decompress and import factory data.\nPlease do a reconnect.\nSee the logfile for more information.");
+            Log.Error($"There was an error while decompressing and importing factory data, probably due to an instable internet connection. See full error below.\n{e.StackTrace}");
+        }
+
         [HarmonyPrefix]
         [HarmonyPatch(nameof(GameData.OnActivePlanetLoaded))]
         public static bool OnActivePlanetLoaded_Prefix(GameData __instance, PlanetData planet)

NebulaPatcher/Patches/Dynamic/MonitorComponent_Patch.cs

@@ -131,6 +131,22 @@ public static void SetTargetBelt_Prefix(MonitorComponent __instance, int __0, in
                     new MonitorSettingUpdatePacket(planetId, __instance.id, MonitorSettingEvent.SetTargetBelt, __0, __1));
             }
         }
+
+        [HarmonyPrefix]
+        [HarmonyPatch(nameof(MonitorComponent.InternalUpdate))]
+        public static bool InternalUpdate_Prefix(MonitorComponent __instance, CargoTraffic _traffic, EntityData[] _entityPool, SpeakerComponent[] _speakerPool, AnimData[] _animPool)
+        {
+            if (Multiplayer.IsActive && __instance.targetBeltId > _traffic.beltPool.Length)
+            {
+                if (Multiplayer.Session.LocalPlayer.IsHost)
+                {
+                    _traffic.factory.RemoveEntityWithComponents(__instance.entityId);
+                    WarningManager.DisplayTemporaryWarning($"Broken Traffic Monitor detected on {_traffic.factory.planet.displayName}\nIt was removed, clients should reconnect!", 15000);
+                }
+                return false;
+            }
+            return true;
+        }
     }
 #pragma warning restore Harmony003 // Harmony non-ref patch parameters modified
 }

NebulaPatcher/Patches/Dynamic/UIEscMenu_Patch.cs

@@ -37,7 +37,7 @@ public static void OnButton6Click_Prefix()
             QuitGame();
         }
 
-        private static void QuitGame()
+        public static void QuitGame()
         {
             if (Multiplayer.IsActive)
             {

NebulaPatcher/Patches/Dynamic/UIMainMenu_Patch.cs

@@ -194,8 +194,14 @@ private static void AddMultiplayerJoinMenu()
 
         private static void OnJoinGameButtonClick()
         {
-            // Remove whitespaces from connection string
             string s = new string(hostIPAdressInput.text.ToCharArray().Where(c => !char.IsWhiteSpace(c)).ToArray());
+            JoinGame(s);
+        }
+
+        public static void JoinGame(string ip)
+        {
+            // Remove whitespaces from connection string
+            string s = ip;
 
             // Taken from .net IPEndPoint
             IPEndPoint result = null;

NebulaPatcher/Patches/Dynamic/VFPreload_Patch.cs

@@ -0,0 +1,27 @@
+using HarmonyLib;
+using NebulaModel;
+using NebulaWorld.GameStates;
+
+namespace NebulaPatcher.Patches.Dynamic
+{
+    [HarmonyPatch(typeof(VFPreload))]
+    internal class VFPreload_Patch
+    {
+        [HarmonyPostfix]
+        [HarmonyPatch(nameof(VFPreload.InvokeOnLoadWorkEnded))]
+        public static void InvokeOnLoadWorkEnded_Postfix()
+        {
+            if (GameStatesManager.DuringReconnect)
+            {
+                string ip = "127.0.0.1:8469";
+                if (Config.Options.RememberLastIP && !string.IsNullOrWhiteSpace(Config.Options.LastIP))
+                {
+                    ip = Config.Options.LastIP;
+                }
+
+                UIMainMenu_Patch.JoinGame(ip);
+                GameStatesManager.DuringReconnect = false;
+            }
+        }
+    }
+}

NebulaWorld/Chat/ChatCommandRegistry.cs

@@ -66,6 +66,7 @@ static ChatCommandRegistry()
             RegisterCommand("xconsole", new XConsoleCommandHandler(), "x");
             RegisterCommand("navigate", new NavigateCommandHandler(), "n");
             RegisterCommand("system", new SystemCommandHandler(), "s");
+            RegisterCommand("reconnect", new ReconnectCommandHandler(), "r");
         }
     }
 

NebulaWorld/Chat/Commands/ReconnectCommandHandler.cs

@@ -0,0 +1,29 @@
+using NebulaModel.DataStructures;
+using NebulaWorld.GameStates;
+using NebulaWorld.MonoBehaviours.Local;
+
+namespace NebulaWorld.Chat.Commands
+{
+    public class ReconnectCommandHandler : IChatCommandHandler
+    {
+        public void Execute(ChatWindow window, string[] parameters)
+        {
+            if (!Multiplayer.IsActive || Multiplayer.Session.LocalPlayer.IsHost)
+            {
+                window.SendLocalChatMessage("This command can only be used in multiplayer and as client!", ChatMessageType.CommandErrorMessage);
+                return;
+            }
+            GameStatesManager.DoFastReconnect();
+        }
+
+        public string[] GetUsage()
+        {
+            return new string[] { $"" };
+        }
+
+        public string GetDescription()
+        {
+            return "performs a reconnect.";
+        }
+    }
+}

NebulaWorld/GameStates/GameStatesManager.cs

@@ -1,5 +1,4 @@
-using NebulaModel.Logger;
-using System;
+using System;
 
 namespace NebulaWorld.GameStates
 {
@@ -16,9 +15,17 @@ public void Dispose()
 
         public static long RealGameTick => GameMain.gameTick;
         public static float RealUPS => (float)FPSController.currentUPS;
+        public static bool DuringReconnect = false;
 
         public static void NotifyTickDifference(float delta)
         {
         }
+
+        public static void DoFastReconnect()
+        {
+            // trigger game exit to main menu
+            DuringReconnect = true;
+            UIRoot.instance.uiGame.escMenu.OnButton5Click();
+        }
     }
 }