Added optional description text to config menu fields

Jump-King-Modding-Platform · Jan 30, 2022 · bb09282 · bb09282
1 parent 464eae1
commit bb09282
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/JKMP.Core/Configuration/Attributes/Attributes.cs b/JKMP.Core/Configuration/Attributes/Attributes.cs
@@ -38,6 +38,11 @@ public abstract class SettingsOptionAttribute : Attribute
         /// The name of the property. If null the property name will be used.
         /// </summary>
         public string? Name { get; set; }
+
+        /// <summary>
+        /// The description of the property. Only visible if value is not null or empty.
+        /// </summary>
+        public string? Description { get; set; }
     }
 
     /// <summary>

diff --git a/JKMP.Core/Configuration/UI/ReflectedConfigMenu.cs b/JKMP.Core/Configuration/UI/ReflectedConfigMenu.cs
@@ -107,6 +107,12 @@ private void CreateFields(AdvancedMenuSelector menu, List<IDrawable> drawables)
                     }
                 };
 
+                // Create the description text if it's not empty/null
+                if (!string.IsNullOrEmpty(optionAttribute.Description))
+                {
+                    menu.AddChild(new TextInfo(optionAttribute.Description, Color.Gray, JKContentManager.Font.MenuFontSmall));
+                }
+
                 string fieldName = optionAttribute.Name ?? property.Name;
 
                 // Create the field