Merge pull request #529 from sp00ktober/master

Bugfix, Tooltips and minimap indicator

Author: sp00ktober

CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Changelog
 
+0.8.3:
+
+- @kremnev8: improved ingame chat
+- @starfish: added compatibility with BulletTime which enables fluent loading times on Planet and System arrival
+- @starfish: bugfix regarding too large dyson sphere data
+- @starfish: bugfix regarding reloading of dyson sphere
+- @starfish: improved loading of solar systems, this now runs on its own thread
+- @starfish: developer commands can now be executed from the ingame chat (using /xconsole [command] )
+- @sp00ktober: added tooltips to the Nebula settings
+- @sp00ktober: added setting to prevent `System.ObjectDisposedException` errors resulting in random client disconnect
+- @sp00ktober: added code to handle IndexOutOfBounds errors when importing PlanetFactory data (very rare issue)
+- @sp00ktober: fixed wrong array size for storage and slots in ILS
+- @sp00ktober: added minimap indicator for other players positions (on the same planet)
+- @sp00ktober: added chat command to list planets in a system
+- @sp00ktober: added chat command to navigate to star, planet or player by name or id
+
 0.8.2:
 
 - @kremnev8: fix issue with EmojiDataManager when a save was loaded multiple times in a row.

NebulaModel/MultiplayerOptions.cs

@@ -28,9 +28,15 @@ public class MultiplayerOptions : ICloneable
         public string LastIP { get; set; } = string.Empty;
 
         [DisplayName("Sync Ups")]
+        [Description("If enabled the UPS of each player is synced. This ensures a similar amount of GameTick() calls.")]
         public bool SyncUps { get; set; } = true;
-        
+
+        [DisplayName("Sync Soil")]
+        [Description("If enabled the soil count of each players is added together and used as one big pool for everyone. Note that this is a server side setting applied to all clients.")]
+        public bool SyncSoil { get; set; } = false;
+
         [DisplayName("Streamer mode")]
+        [Description("If enabled specific personal information like your IP address is hidden from the ingame chat.")]
         public bool StreamerMode { get; set; } = false;
 
         [DisplayName("Default chat position")]
@@ -39,8 +45,9 @@ public class MultiplayerOptions : ICloneable
         [DisplayName("Default chat size")]
         public ChatSize DefaultChatSize { get; set; } = ChatSize.Medium;
 
-        [DisplayName("Sync Soil")]
-        public bool SyncSoil { get; set; } = false;
+        [DisplayName("Cleanup inactive sessions")]
+        [Description("If disabled the underlying networking library will not cleanup inactive connections. This might solve issues with clients randomly disconnecting and hosts having a 'System.ObjectDisposedException'.")]
+        public bool CleanupInactiveSessions { get; set; } = true;
 
         public string MechaColors { get; set; } = "209 151 76 255;184 90 72 255;94 92 92 255;123 234 255 255;229 155 94 255;255 243 235 255;255 248 245 255;255 255 255 255;";
 

NebulaModel/Packets/Logistics/ILSArriveStarPlanetResponse.cs

@@ -10,6 +10,7 @@ public class ILSArriveStarPlanetResponse
 
         public int[] StationMaxShips { get; set; }
         public int[] StorageLength { get; set; }
+        public int[] SlotLength { get; set; }
         public int[] StorageIdx { get; set; }
         public int[] ItemId { get; set; }
         public int[] Count { get; set; }
@@ -20,6 +21,7 @@ public ILSArriveStarPlanetResponse(int[] stationGId,
                                         int[] stationMaxShips,
                                         int[] storageLength,
                                         int[] storageIdx,
+                                        int[] slotLength,
                                         int[] itemId,
                                         int[] count,
                                         int[] inc)
@@ -29,6 +31,7 @@ public ILSArriveStarPlanetResponse(int[] stationGId,
             StationMaxShips = stationMaxShips;
             StorageLength = storageLength;
             StorageIdx = storageIdx;
+            SlotLength = slotLength;
             ItemId = itemId;
             Count = count;
             Inc = inc;

NebulaNetwork/PacketProcessors/Logistics/ILSArriveStarPlanetRequestProcessor.cs

@@ -36,18 +36,24 @@ public override void ProcessPacket(ILSArriveStarPlanetRequest packet, NebulaConn
             if (player != null)
             {
                 List<int> stationGId = new List<int>();
+                List<int> stationPId = new List<int>();
                 List<int> stationMaxShips = new List<int>();
                 List<int> storageLength = new List<int>();
-                int arraySize = 0;
-                int offset = 0;
+                List<int> slotLength = new List<int>();
+                int arraySizeStorage = 0;
+                int arraySizeSlot = 0;
+                int offsetStorage = 0;
+                int offsetSlot = 0;
 
                 foreach (StationComponent stationComponent in GameMain.data.galacticTransport.stationPool)
                 {
                     if (stationComponent != null && GameMain.galaxy.PlanetById(stationComponent.planetId)?.star.id == packet.StarId)
                     {
                         stationGId.Add(stationComponent.gid);
+                        stationPId.Add(stationComponent.planetId);
                         stationMaxShips.Add(stationComponent.workShipDatas.Length);
                         storageLength.Add(stationComponent.storage.Length);
+                        slotLength.Add(stationComponent.slots.Length);
                     }
                 }
 
@@ -57,36 +63,45 @@ public override void ProcessPacket(ILSArriveStarPlanetRequest packet, NebulaConn
 
                     for (int i = 0; i < storageLength.Count; i++)
                     {
-                        arraySize += storageLength[i];
+                        arraySizeStorage += storageLength[i];
+                    }
+                    for(int i = 0; i < slotLength.Count; i++)
+                    {
+                        arraySizeSlot += slotLength[i];
                     }
 
-                    int[] planetId = new int[arraySize];
-                    int[] storageIdx = new int[arraySize];
-                    int[] itemId = new int[arraySize];
-                    int[] count = new int[arraySize];
-                    int[] inc = new int[arraySize];
+                    int[] storageIdx = new int[arraySizeSlot];
+
+                    int[] itemId = new int[arraySizeStorage];
+                    int[] count = new int[arraySizeStorage];
+                    int[] inc = new int[arraySizeStorage];
 
                     for (int i = 0; i < stationGId.Count; i++)
                     {
-                        for (int j = 0; j < storageLength[i]; j++)
+                        for(int j = 0; j < slotLength[i]; j++)
                         {
-                            planetId[offset + j] = gStationPool[stationGId[i]].planetId;
                             if (gStationPool[stationGId[i]].slots.Length > 0) // collectors dont have a slot for belts
                             {
-                                storageIdx[offset + j] = gStationPool[stationGId[i]].slots[j].storageIdx;
+                                storageIdx[offsetSlot + j] = gStationPool[stationGId[i]].slots[j].storageIdx;
                             }
-                            itemId[offset + j] = gStationPool[stationGId[i]].storage[j].itemId;
-                            count[offset + j] = gStationPool[stationGId[i]].storage[j].count;
-                            inc[offset + j] = gStationPool[stationGId[i]].storage[j].inc;
                         }
-                        offset += storageLength[i];
+                        offsetSlot += slotLength[i];
+
+                        for (int j = 0; j < storageLength[i]; j++)
+                        {
+                            itemId[offsetStorage + j] = gStationPool[stationGId[i]].storage[j].itemId;
+                            count[offsetStorage + j] = gStationPool[stationGId[i]].storage[j].count;
+                            inc[offsetStorage + j] = gStationPool[stationGId[i]].storage[j].inc;
+                        }
+                        offsetStorage += storageLength[i];
                     }
 
                     player.SendPacket(new ILSArriveStarPlanetResponse(stationGId.ToArray(),
-                                                                planetId,
+                                                                stationPId.ToArray(),
                                                                 stationMaxShips.ToArray(),
                                                                 storageLength.ToArray(),
                                                                 storageIdx,
+                                                                slotLength.ToArray(),
                                                                 itemId,
                                                                 count,
                                                                 inc));

NebulaNetwork/PacketProcessors/Logistics/ILSArriveStarPlanetResponseProcessor.cs

@@ -18,7 +18,8 @@ public override void ProcessPacket(ILSArriveStarPlanetResponse packet, NebulaCon
 
             StationComponent[] gStationPool = GameMain.data.galacticTransport.stationPool;
 
-            int offset = 0;
+            int offsetStorage = 0;
+            int offsetSlot = 0;
             for (int i = 0; i < packet.StationGId.Length; i++)
             {
                 if (packet.StationGId[i] >= gStationPool.Length || gStationPool[packet.StationGId[i]] == null)
@@ -29,25 +30,31 @@ public override void ProcessPacket(ILSArriveStarPlanetResponse packet, NebulaCon
                 StationComponent stationComponent = gStationPool[packet.StationGId[i]];
                 if (stationComponent.slots == null && !stationComponent.isCollector)
                 {
-                    stationComponent.slots = new SlotData[packet.StorageLength[i]];
+                    stationComponent.slots = new SlotData[packet.SlotLength[i]];
                 }
                 if (stationComponent.storage == null)
                 {
                     stationComponent.storage = new StationStore[packet.StorageLength[i]];
                 }
-                for (int j = 0; j < packet.StorageLength[i]; j++)
+                for (int j = 0; j < packet.SlotLength[i]; j++)
                 {
-                    int index = offset + j;
+                    int index = offsetSlot + j;
 
                     if (!stationComponent.isCollector)
                     {
                         stationComponent.slots[j].storageIdx = packet.StorageIdx[index];
                     }
+                }
+                offsetSlot += packet.SlotLength[i];
+                for(int j = 0; j < packet.StorageLength[i]; j++)
+                {
+                    int index = offsetStorage + j;
+
                     stationComponent.storage[j].itemId = packet.ItemId[index];
                     stationComponent.storage[j].count = packet.Count[index];
                     stationComponent.storage[j].inc = packet.Inc[index];
                 }
-                offset += packet.StorageLength[i];
+                offsetStorage += packet.StorageLength[i];
             }
         }
     }

NebulaNetwork/Server.cs

@@ -73,6 +73,7 @@ public override void Start()
             socket.AddWebSocketService<WebSocketService>("/socket", wse => new WebSocketService());
             try
             {
+                socket.KeepClean = Config.Options.CleanupInactiveSessions;
                 socket.Start();
             }catch(System.InvalidOperationException e)
             {

NebulaPatcher/Patches/Dynamic/UIOptionWindow_Patch.cs

@@ -9,13 +9,42 @@
 using System.Linq;
 using System.Reflection;
 using UnityEngine;
+using UnityEngine.EventSystems;
 using UnityEngine.UI;
 
 namespace NebulaPatcher.Patches.Dynamic
 {
     [HarmonyPatch(typeof(UIOptionWindow))]
     internal class UIOptionWindow_Patch
     {
+        public class Tooltip : MonoBehaviour, IPointerEnterHandler, IPointerExitHandler
+        {
+            public string Title = null;
+            public string Text = null;
+            UIButtonTip tip = null;
+
+            public void OnPointerEnter(PointerEventData eventData)
+            {
+                tip = UIButtonTip.Create(true, Title, Text, 2, new Vector2(0, 0), 508, this.gameObject.transform, "", "");
+            }
+
+            public void OnPointerExit(PointerEventData eventData)
+            {
+                if(tip != null)
+                {
+                    Destroy(tip.gameObject);
+                }
+            }
+
+            public void OnDisable()
+            {
+                if (tip != null)
+                {
+                    Destroy(tip.gameObject);
+                }
+            }
+        }
+
         private static RectTransform multiplayerTab;
 
         // Templates
@@ -159,23 +188,24 @@ private static void AddMultiplayerOptionsProperties(RectTransform container)
             foreach (PropertyInfo prop in properties)
             {
                 DisplayNameAttribute displayAttr = prop.GetCustomAttribute<DisplayNameAttribute>();
+                DescriptionAttribute descriptionAttr = prop.GetCustomAttribute<DescriptionAttribute>();
                 if (displayAttr != null)
                 {
                     if (prop.PropertyType == typeof(bool))
                     {
-                        CreateBooleanControl(displayAttr, prop, anchorPosition, container);
+                        CreateBooleanControl(displayAttr, descriptionAttr, prop, anchorPosition, container);
                     }
                     else if (prop.PropertyType == typeof(int) || prop.PropertyType == typeof(float) || prop.PropertyType == typeof(ushort))
                     {
-                        CreateNumberControl(displayAttr, prop, anchorPosition, container);
+                        CreateNumberControl(displayAttr, descriptionAttr, prop, anchorPosition, container);
                     }
                     else if (prop.PropertyType == typeof(string))
                     {
-                        CreateStringControl(displayAttr, prop, anchorPosition, container);
+                        CreateStringControl(displayAttr, descriptionAttr, prop, anchorPosition, container);
                     }
                     else if (prop.PropertyType.IsEnum)
                     {
-                        CreateEnumControl(displayAttr, prop, anchorPosition, container);
+                        CreateEnumControl(displayAttr, descriptionAttr, prop, anchorPosition, container);
                     }
                     else
                     {
@@ -190,10 +220,10 @@ private static void AddMultiplayerOptionsProperties(RectTransform container)
             container.sizeDelta = new Vector2(container.sizeDelta.x, -anchorPosition.y + 40);
         }
 
-        private static void CreateBooleanControl(DisplayNameAttribute control, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
+        private static void CreateBooleanControl(DisplayNameAttribute control, DescriptionAttribute descriptionAttr, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
         {
             RectTransform element = Object.Instantiate(checkboxTemplate, container, false);
-            SetupUIElement(element, control, prop, anchorPosition);
+            SetupUIElement(element, control, descriptionAttr, prop, anchorPosition);
             UIToggle toggle = element.GetComponentInChildren<UIToggle>();
             toggle.toggle.onValueChanged.RemoveAllListeners();
             toggle.toggle.onValueChanged.AddListener((value) => {
@@ -219,13 +249,13 @@ private static void CreateBooleanControl(DisplayNameAttribute control, PropertyI
             };
         }
 
-        private static void CreateNumberControl(DisplayNameAttribute control, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
+        private static void CreateNumberControl(DisplayNameAttribute control, DescriptionAttribute descriptionAttr, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
         {
             UIRangeAttribute rangeAttr = prop.GetCustomAttribute<UIRangeAttribute>();
             bool sliderControl = rangeAttr != null && rangeAttr.Slider;
 
             RectTransform element = Object.Instantiate(sliderControl ? sliderTemplate : inputTemplate, container, false);
-            SetupUIElement(element, control, prop, anchorPosition);
+            SetupUIElement(element, control, descriptionAttr, prop, anchorPosition);
 
             bool isFloatingPoint = prop.PropertyType == typeof(float) || prop.PropertyType == typeof(double);
 
@@ -294,10 +324,10 @@ private static void CreateNumberControl(DisplayNameAttribute control, PropertyIn
             }
         }
 
-        private static void CreateStringControl(DisplayNameAttribute control, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
+        private static void CreateStringControl(DisplayNameAttribute control, DescriptionAttribute descriptionAttr, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
         {
             RectTransform element = Object.Instantiate(inputTemplate, container, false);
-            SetupUIElement(element, control, prop, anchorPosition);
+            SetupUIElement(element, control, descriptionAttr, prop, anchorPosition);
 
             InputField input = element.GetComponentInChildren<InputField>();
             input.onValueChanged.RemoveAllListeners();
@@ -309,10 +339,10 @@ private static void CreateStringControl(DisplayNameAttribute control, PropertyIn
             };
         }
 
-        private static void CreateEnumControl(DisplayNameAttribute control, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
+        private static void CreateEnumControl(DisplayNameAttribute control, DescriptionAttribute descriptionAttr, PropertyInfo prop, Vector2 anchorPosition, RectTransform container)
         {
             RectTransform element = Object.Instantiate(comboBoxTemplate, container, false);
-            SetupUIElement(element, control, prop, anchorPosition);
+            SetupUIElement(element, control, descriptionAttr, prop, anchorPosition);
             UIComboBox combo = element.GetComponentInChildren<UIComboBox>();
             combo.Items = System.Enum.GetNames(prop.PropertyType).ToList();
             combo.ItemsData = System.Enum.GetValues(prop.PropertyType).OfType<int>().ToList();
@@ -325,11 +355,17 @@ private static void CreateEnumControl(DisplayNameAttribute control, PropertyInfo
             };
         }
 
-        private static void SetupUIElement(RectTransform element, DisplayNameAttribute display, PropertyInfo prop, Vector2 anchorPosition)
+        private static void SetupUIElement(RectTransform element, DisplayNameAttribute display, DescriptionAttribute descriptionAttr, PropertyInfo prop, Vector2 anchorPosition)
         {
             element.gameObject.SetActive(true);
             element.name = prop.Name;
             element.anchoredPosition = anchorPosition;
+            if(descriptionAttr != null)
+            {
+                element.gameObject.AddComponent<Tooltip>();
+                element.gameObject.GetComponent<Tooltip>().Title = display.DisplayName;
+                element.gameObject.GetComponent<Tooltip>().Text = descriptionAttr.Description;
+            }
             element.GetComponent<Localizer>().enabled = false;
             element.GetComponent<Text>().text = display.DisplayName;
         }