use more generic system with events and adapters

Author: xKiraiChan

AbstractUI.cs

@@ -0,0 +1,24 @@
+namespace KiraiMod.Core.UI.SideUI
+{
+    public static class Adapter
+    {
+        private static bool hasInitialized;
+
+        public static void Initialize()
+        {
+            if (hasInitialized) return;
+            hasInitialized = true;
+
+            UIManager.HighGroupAdded += HandleGroup;
+            UIManager.HighGroups.ForEach(HandleGroup);
+        }
+
+        private static void HandleGroup(UIGroup group)
+        {
+            SideUI ui = new(group.name);
+            SideUI.GlobalContext.AddElement(new UIElement<SideUI>(group.name, ui));
+            group.ElementAdded += element => ui.AddElement(element);
+            ui.elements.ForEach(element => ui.AddElement(element));
+        }
+    }
+}

Elements/BaseElement.cs

@@ -1,11 +1,10 @@
-using KiraiMod.Core.UI.Elements;
-using UnityEngine.UI;
+using UnityEngine.UI;
 
 namespace KiraiMod.Core.UI.SideUI
 {
     public class BaseWrapper
     {
-        public BaseWrapper(Image Background, BaseElement Element, Text Text)
+        public BaseWrapper(Image Background, UIElement Element, Text Text)
         {
             this.Background = Background;
             this.Element = Element;
@@ -14,7 +13,7 @@ public BaseWrapper(Image Background, BaseElement Element, Text Text)
 
         public Image Background;
         public Text Text;
-        public BaseElement Element;
+        public UIElement Element;
 
         public virtual void OnLeft() => Controller.OnBack();
 

Elements/BoundElement.cs

@@ -1,5 +1,4 @@
-using KiraiMod.Core.UI.Elements;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.InputSystem;
 

Elements/InvokeElement.cs

@@ -1,13 +1,12 @@
-using KiraiMod.Core.UI.Elements;
-using KiraiMod.Core.UI.SideUI.Wrappers;
+using KiraiMod.Core.UI.SideUI.Wrappers;
 using System;
 using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.UI;
 
 namespace KiraiMod.Core.UI.SideUI
 {
-    public class SideUI : AbstractUI
+    public class SideUI : UIGroup
     {
         public static Lazy<SideUI> _globalContext = new(() =>
         {
@@ -27,10 +26,10 @@ public static SideUI GlobalContext
         public GameObject Sidebar;
         public RectTransform rect;
 
-        public SideUI(string ID) : base(ID, null) { }
-        private SideUI() : base("global.SideUI", "SideUI")
+        public SideUI(string name) : base(name) { }
+        private SideUI() : base("SideUI")
         {
-            Sidebar = ElementFactory.CreateSide(Name, UIManager.ScreenUI.transform.parent);
+            Sidebar = ElementFactory.CreateSide(name, UIManager.ScreenUI.transform.parent);
 
             rect = Sidebar.transform.Cast<RectTransform>();
             rect.sizeDelta = new(200, 0);
@@ -45,30 +44,30 @@ public void IncreaseSize()
             rect.position = rect.position.AddY(-12.5f);
         }
 
-        protected override BaseElement AddElement(BaseElement element)
+        public override UIElement AddElement(UIElement element)
         {
             Image image;
             Text text;
             BaseWrapper container;
 
             switch (element)
             {
-                case BoundElement<bool> elemBool:
-                    (image, text) = ElementFactory.CreateElement(Sidebar, elemBool.Name);
+                case UIElement<bool> elemBool:
+                    (image, text) = ElementFactory.CreateElement(Sidebar, elemBool.name);
                     container = new ToggleWrapper(image, elemBool, text);
                     break;
 
-                case BoundElement<SideUI> elemMenu:
+                case UIElement<SideUI> elemMenu:
                     if (elemMenu.Bound._value is null) return null;
 
-                    (image, text) = ElementFactory.CreateElement(Sidebar, $"< {elemMenu.Name} >");
+                    (image, text) = ElementFactory.CreateElement(Sidebar, $"< {elemMenu.name} >");
 
                     SideUI ui = elemMenu.Bound._value;
-                    ui.Sidebar = ElementFactory.CreateSide(elemMenu.Name, Sidebar.transform);
+                    ui.Sidebar = ElementFactory.CreateSide(elemMenu.name, Sidebar.transform);
                     ui.Parent = this;
                     ui.rect = ui.Sidebar.transform.Cast<RectTransform>();
                     ui.rect.sizeDelta = new(200, 0);
-                    ui.rect.localPosition = new(201, 87.5f);
+                    ui.rect.localPosition = new(201, 12.5f);
                     ui.Sidebar.active = false;
 
                     container = new SideUIWrapper(image, elemMenu, text);
@@ -80,21 +79,13 @@ protected override BaseElement AddElement(BaseElement element)
 
             IncreaseSize();
 
+            base.AddElement(element);
+
             Wrappers.Add(container);
             if (Wrappers.Count == 1)
                 Controller.Redraw();
 
             return element;
         }
-
-        public override bool RemoveElement(BaseElement element)
-        {
-            throw new NotImplementedException();
-        }
-
-        public override bool RemoveElement(string element)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

SideUI/Adapter.cs

@@ -1,13 +1,12 @@
-using KiraiMod.Core.UI.Elements;
-using UnityEngine.UI;
+using UnityEngine.UI;
 
 namespace KiraiMod.Core.UI.SideUI.Wrappers
 {
     public class SideUIWrapper : BaseWrapper
     {
-        private static BoundElement<SideUI> _element;
+        private static UIElement<SideUI> _element;
 
-        public SideUIWrapper(Image Background, BoundElement<SideUI> Element, Text Text) : base(Background, Element, Text) => _element = Element;
+        public SideUIWrapper(Image Background, UIElement<SideUI> Element, Text Text) : base(Background, Element, Text) => _element = Element;
 
         public override void OnRight()
         {

SideUI/BaseWrapper.cs

@@ -1,5 +1,4 @@
-using KiraiMod.Core.UI.Elements;
-using UnityEngine;
+using UnityEngine;
 using UnityEngine.UI;
 
 namespace KiraiMod.Core.UI.SideUI.Wrappers
@@ -9,9 +8,9 @@ public class ToggleWrapper : BaseWrapper
         public static Color on = new Color32(0xCC, 0xCC, 0xFF, 0xFF);
         public static Color off = new Color32(0x56, 0x00, 0xA5, 0xFF);
 
-        private readonly BoundElement<bool> boolElem;
+        private readonly UIElement<bool> boolElem;
 
-        public ToggleWrapper(Image Background, BoundElement<bool> Element, Text text) : base(Background, Element, text)
+        public ToggleWrapper(Image Background, UIElement<bool> Element, Text text) : base(Background, Element, text)
         {
             boolElem = Element;
             boolElem.Bound.ValueChanged += value => text.color = value ? on : off;

SideUI/Controller.cs

@@ -0,0 +1,40 @@
+using KiraiMod.Core.Utils;
+using System;
+
+namespace KiraiMod.Core.UI
+{
+    public class UIElement 
+    {
+        public string name;
+
+        public UIElement(string name) => this.name = name;
+
+        public event Action Changed;
+
+        public void Invoke() => Changed?.Invoke();
+    }
+
+    public class UIElement<T> : UIElement
+    {
+        public readonly Bound<T> Bound;
+
+        public UIElement(string name, T value) : this(name) => Bound._value = value;
+        public UIElement(string name) : base(name)
+        {
+            Bound = new();
+            Bound.ValueChanged += val => Changed?.Invoke(val);
+        }
+
+        public UIElement(string name, Bound<T> bound) : base(name)
+        {
+            this.name = name;
+            Bound = bound;
+            Bound.ValueChanged += val => Changed?.Invoke(val);
+        }
+
+        public new event Action<T> Changed;
+
+        [Obsolete("Change the inner Value of Bound")]
+        public void Invoke(T val) => Changed?.Invoke(val);
+    }
+}

SideUI/SideUI.cs

@@ -0,0 +1,41 @@
+using KiraiMod.Core.Utils;
+using System;
+using System.Collections.Generic;
+
+namespace KiraiMod.Core.UI
+{
+    public class UIGroup
+    {
+        public readonly List<UIElement> elements = new();
+        public event Action<UIElement> ElementAdded;
+        public event Action<UIElement> ElementRemoved;
+
+        public readonly string name;
+
+        public UIGroup(string name) => this.name = name;
+
+        /// <summary> This will register your group as a top level group </summary>
+        public virtual void RegisterAsHighest() => UIManager.RegisterHighGroup(this);
+
+        // these overloads are for convenience and are not intended to be overloaded
+        public UIElement<T> AddElement<T>(string name, T value) => (UIElement<T>)AddElement(new UIElement<T>(name, value));
+        public UIElement<T> AddElement<T>(string name) => (UIElement<T>)AddElement(new UIElement<T>(name));
+        public UIElement<T> AddElement<T>(string name, Bound<T> bound) => (UIElement<T>)AddElement(new UIElement<T>(name, bound));
+
+        /// <remarks> Some implementations may require that the current group is already registered </remarks>
+        public virtual UIElement AddElement(UIElement element)
+        {
+            elements.Add(element);
+            ElementAdded?.Invoke(element);
+            return element;
+        }
+
+        /// <returns> If the element was successfully removed </returns>
+        public virtual bool RemoveElement(UIElement element) 
+        {
+            elements.Remove(element);
+            ElementRemoved?.Invoke(element);
+            return true;
+        }
+    }
+}

SideUI/Wrappers/SideUIWrapper.cs

@@ -1,10 +1,18 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 
 namespace KiraiMod.Core.UI
 {
     public static class UIManager
     {
-        public static Dictionary<string, AbstractUI> UIs = new();
+        public static readonly List<UIGroup> HighGroups = new();
+        public static event Action<UIGroup> HighGroupAdded;
+
+        public static void RegisterHighGroup(UIGroup group)
+        {
+            HighGroups.Add(group);
+            HighGroupAdded?.Invoke(group);
+        }
 
         public static UnityEngine.GameObject ScreenUI
         {