Alerts System and UI (#2529)

* #272 add bordered panel for effects bar * #272 avoid mouse overlapping tooltip when near edges, change tooltip colors to match mockups * #272 WIP defining status effect states as YML and sending them as encoded integers * #272 refactor to use new alert system * #272 refactor to use new alert system * #272 fix various bugs with new alert system and update alerts to have color * #272 WIP * #272 rename status effects to alerts * #272 WIP reworking alert internals to avoid code dup and eliminate enum * #272 refactor alerts to use categories and fix various bugs * #272 more alert bugfixes * #272 alert ordering * #272 callback-based approach for alert clicks * #272 add debug commands for alerts * #272 utilize new GridContainer capabilities for sizing of alerts tab * #272 scale alerts height based on window size * #272 fix tooltip flicker * #272 transparent alert panel * #272 adjust styles to match injazz mockups more, add cooldown info in tooltip * #272 adjust styles to match injazz mockups more, add cooldown info in tooltip * #272 alert prototype tests * #272 alert manager tests * #272 alert order tests * #272 simple unit test for alerts component * #272 integration test for alerts * #272 rework alerts to use enums instead of id / category * #272 various cleanups for PR * #272 use byte for more compact alert messages * #272 rename StatusEffects folder to Alerts, add missing NetSerializable
2020-11-09 20:22:19 -08:00
parent c82199610d
commit 5f788c3318
86 changed files with 2305 additions and 598 deletions
--- a/Content.Shared/Alert/AlertOrderPrototype.cs
+++ b/Content.Shared/Alert/AlertOrderPrototype.cs
@@ -0,0 +1,81 @@
+using System;
+using System.Collections.Generic;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Serialization;
+using Robust.Shared.Utility;
+using YamlDotNet.RepresentationModel;
+
+namespace Content.Shared.Alert
+{
+    /// <summary>
+    /// Defines the order of alerts so they show up in a consistent order.
+    /// </summary>
+    [Prototype("alertOrder")]
+    public class AlertOrderPrototype : IPrototype, IComparer<AlertPrototype>
+    {
+        private Dictionary<AlertType, int> _typeToIdx = new Dictionary<AlertType, int>();
+        private Dictionary<AlertCategory, int> _categoryToIdx = new Dictionary<AlertCategory, int>();
+
+        public void LoadFrom(YamlMappingNode mapping)
+        {
+            if (!mapping.TryGetNode("order", out YamlSequenceNode orderMapping)) return;
+
+            int i = 0;
+            foreach (var entryYaml in orderMapping)
+            {
+                var orderEntry = (YamlMappingNode) entryYaml;
+                var serializer = YamlObjectSerializer.NewReader(orderEntry);
+                if (serializer.TryReadDataField("category", out AlertCategory alertCategory))
+                {
+                    _categoryToIdx[alertCategory] = i++;
+                }
+                else if (serializer.TryReadDataField("alertType", out AlertType alertType))
+                {
+                    _typeToIdx[alertType] = i++;
+                }
+            }
+        }
+
+        private int GetOrderIndex(AlertPrototype alert)
+        {
+            if (_typeToIdx.TryGetValue(alert.AlertType, out var idx))
+            {
+                return idx;
+            }
+            if (alert.Category != null &&
+                _categoryToIdx.TryGetValue((AlertCategory) alert.Category, out idx))
+            {
+                return idx;
+            }
+
+            return -1;
+        }
+
+        public int Compare(AlertPrototype x, AlertPrototype y)
+        {
+            if ((x == null) && (y == null)) return 0;
+            if (x == null) return 1;
+            if (y == null) return -1;
+            var idx = GetOrderIndex(x);
+            var idy = GetOrderIndex(y);
+            if (idx == -1 && idy == -1)
+            {
+                // break ties by type value
+                return x.AlertType - y.AlertType;
+            }
+
+            if (idx == -1) return 1;
+            if (idy == -1) return -1;
+            var result = idx - idy;
+            // not strictly necessary (we don't care about ones that go at the same index)
+            // but it makes the sort stable
+            if (result == 0)
+            {
+                // break ties by type value
+                return x.AlertType - y.AlertType;
+            }
+
+            return result;
+        }
+    }
+}