Added Element.DebugName to allow describing ui elements in ToString

Author: Ellpeck

CHANGELOG.md

@@ -6,6 +6,7 @@ MLEM uses [semantic versioning](https://semver.org/). Potentially breaking chang
 ### MLEM.Ui
 Additions
 - Added UiSystem.OnElementAreaDirty and Element.OnAreaDirty events
+- Added Element.DebugName to allow describing ui elements in ToString
 
 Improvements
 - Made the exception thrown after the element recursion limit is reached more helpful

MLEM.Ui/Elements/Element.cs

@@ -336,6 +336,11 @@ public virtual bool PreventParentSpill {
         /// Note that, if no element is previously selected and auto-navigation is invoked, this element cannot be chosen as the first element to navigate to if its auto-nav group is non-null.
         /// </summary>
         public virtual string AutoNavGroup { get; set; }
+        /// <summary>
+        /// An optional string to display as this element's name in its <see cref="ToString"/> method.
+        /// If this is unset, this element's underlying type's <see cref="Type.Name"/> is displayed instead.
+        /// </summary>
+        public virtual string DebugName { get; set; }
 
         /// <summary>
         /// This Element's current <see cref="UiStyle"/>.
@@ -973,7 +978,7 @@ public virtual bool StopAnimation(UiAnimation animation) {
 
         /// <inheritdoc />
         public override string ToString() {
-            var ret = this.GetType().Name;
+            var ret = this.DebugName ?? this.GetType().Name;
             // elements will contain their path up to the root and their index in each parent
             // eg Paragraph 2 @ Panel 3 @ ... @ Group RootName
             if (this.Parent != null) {

Tests/UiTests.cs

@@ -266,6 +266,21 @@ public void TestIssue40() {
         this.Game.UiSystem.Remove("Test");
     }
 
+    [Test]
+    public void TestToString() {
+        var panel = new Panel(Anchor.TopLeft, Vector2.One);
+        var group = panel.AddChild(new Group(Anchor.TopLeft, Vector2.One, false, false));
+        var button = group.AddChild(new Button(Anchor.TopLeft, Vector2.One));
+
+        Assert.AreEqual(button.ToString(), "Button 0 @ Group 0 @ Panel");
+        this.AddAndUpdate(panel, out _, out _);
+        Assert.AreEqual(button.ToString(), "Button 0 @ Group 0 @ Panel Test");
+
+        button.DebugName = "Test Button";
+        group.DebugName = "Test Group";
+        Assert.AreEqual(button.ToString(), "Test Button 0 @ Test Group 0 @ Panel Test");
+    }
+
     private void AddAndUpdate(Element element, out TimeSpan addTime, out TimeSpan updateTime) {
         foreach (var root in this.Game.UiSystem.GetRootElements())
             this.Game.UiSystem.Remove(root.Name);