Add support for Vector2/3/4, Quaternion, Rect; expand support for RGB-only Color

Silksong.ModMenu/Directory.Build.props

@@ -11,6 +11,6 @@
     It should follow the format major.minor.patch (semantic versioning). If you publish your mod
     as a library to NuGet, this version will also be used as the package version.
     -->
-    <Version>0.7.2</Version>
+    <Version>0.7.3</Version>
   </PropertyGroup>
 </Project>

Silksong.ModMenu/Elements/TextInput.cs

@@ -24,6 +24,13 @@ public class TextInput<T> : SelectableValueElement<T>
         typeof(ulong),
     ];
     private static readonly HashSet<Type> floatTypes = [typeof(float), typeof(double)];
+    private static readonly HashSet<Type> floatListTypes =
+    [
+        typeof(Vector2),
+        typeof(Vector3),
+        typeof(Vector4),
+        typeof(Quaternion),
+    ];
 
     /// <summary>
     /// Construct a basic text input.
@@ -48,6 +55,14 @@ public TextInput(LocalizedText label, ITextModel<T> model, LocalizedText descrip
             InputField.contentType = InputField.ContentType.IntegerNumber;
         else if (floatTypes.Contains(typeof(T)))
             InputField.contentType = InputField.ContentType.DecimalNumber;
+        else if (floatListTypes.Contains(typeof(T)))
+        {
+            InputField.contentType = InputField.ContentType.Custom;
+            InputField.onValidateInput = FloatListValidation;
+            ApplyDefaultColors = true;
+            OnTextValueChanged += _ =>
+                State = TextModel.IsTextValid ? ElementState.DEFAULT : ElementState.INVALID;
+        }
     }
 
     /// <summary>
@@ -100,4 +115,31 @@ public override void SetFontSizes(FontSizes fontSizes)
         DescriptionText.fontSize = fontSizes.DescriptionSize();
         InputField.textComponent.fontSize = fontSizes.ChoiceSize();
     }
+
+    /// <summary>
+    /// <see cref="UnityEngine.UI.InputField"/> validation for comma-delimited lists
+    /// of float values, with or without enclosing brackets.
+    /// </summary>
+    static char FloatListValidation(string input, int pos, char ch)
+    {
+        int leftPos = input.IndexOf('('),
+            rightPos = input.IndexOf(')');
+
+        // Everything must go within the brackets, if they're present
+        if (leftPos >= pos || (rightPos < pos && rightPos >= 0))
+            return '\0';
+
+        if (
+            // Brackets must be unique and positioned on the appropriate end of the string
+            (ch == '(' && leftPos == -1 && pos == 0)
+            || (ch == ')' && rightPos == -1 && pos == input.Length)
+            // Other valid characters
+            || char.IsDigit(ch)
+            || char.IsWhiteSpace(ch)
+            || ",.-".Contains(ch)
+        )
+            return ch;
+
+        return '\0';
+    }
 }

Silksong.ModMenu/Internal/MenuPrefabs.cs

@@ -151,6 +151,12 @@ private MenuPrefabs(UIManager uiManager)
             textInputChild.FindChild("CursorRight")!.GetComponent<Animator>(),
         ];
 
+        GameObject underlineObj = new("Underline") { layer = (int)PhysLayers.UI };
+        underlineObj.transform.SetParentReset(textInputField.textComponent.transform);
+        underlineObj.AddComponent<Image>();
+        underlineObj.RectTransform.FitToParentHorizontal(anchorY: 0);
+        underlineObj.RectTransform.sizeDelta = new Vector2(0, 3);
+
         sliderTemplate = Object.Instantiate(
             canvas.FindChild("AudioMenuScreen/Content/MasterVolume")!
         );

Silksong.ModMenu/Models/TextModels.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using Silksong.ModMenu.Internal;
 using UnityEngine;
@@ -17,6 +18,8 @@ public static class TextModels
     public static ParserTextModel<string> ForStrings() =>
         new(DefaultUnparse<string>, DefaultUnparse<string>);
 
+    #region Numbers
+
     /// <summary>
     /// An ITextModel which parses its input into a signed byte.
     /// </summary>
@@ -172,6 +175,8 @@ public static ParserTextModel<double> ForDoubles(double min, double max)
         return model;
     }
 
+    #endregion
+
     private static bool DefaultUnparse<T>(T value, out string text)
     {
         text = $"{value}";
@@ -193,6 +198,8 @@ bool Check(T value)
         return Check;
     }
 
+    #region Colors
+
     /// <summary>
     /// An ITextModel which parses 3, 6, or 8 character hex strings to and from <see cref="Color"/>s.
     /// </summary>
@@ -243,4 +250,111 @@ private static bool HexUnparser(Color c, out string x)
         x = "###";
         return false;
     }
+
+    #endregion
+    #region Vectors & Quaternions
+
+    /// <summary>
+    /// An ITextModel which parses comma-delimited pairs of numbers to and from <see cref="Vector2"/>s.
+    /// </summary>
+    public static ParserTextModel<Vector2> ForVector2() =>
+        new(Vector2Parser, Vector2Unparser, INVALID_VECTOR);
+
+    /// <summary>
+    /// An ITextModel which parses comma-delimited trios of numbers to and from <see cref="Vector3"/>s.
+    /// </summary>
+    public static ParserTextModel<Vector3> ForVector3() =>
+        new(Vector3Parser, Vector3Unparser, INVALID_VECTOR);
+
+    /// <summary>
+    /// An ITextModel which parses comma-delimited quartets of numbers to and from <see cref="Vector4"/>s.
+    /// </summary>
+    public static ParserTextModel<Vector4> ForVector4() =>
+        new(Vector4Parser, Vector4Unparser, INVALID_VECTOR);
+
+    /// <summary>
+    /// An ITextModel which parses comma-delimited quartets of numbers to and from <see cref="Quaternion"/>s.
+    /// </summary>
+    public static ParserTextModel<Quaternion> ForQuaternion() =>
+        new(QuaternionParser, QuaternionUnparser, INVALID_QUATERNION);
+
+    private static readonly Vector4 INVALID_VECTOR = Vector4.positiveInfinity;
+    private static readonly Quaternion INVALID_QUATERNION = new(
+        float.PositiveInfinity,
+        float.PositiveInfinity,
+        float.PositiveInfinity,
+        float.PositiveInfinity
+    );
+
+    private static bool Vector2Parser(string x, out Vector2 v)
+    {
+        bool success = FloatListParser(x, out float[] c) && c.Length == 2;
+        v = success ? new(c[0], c[1]) : INVALID_VECTOR;
+        return success;
+    }
+
+    private static bool Vector2Unparser(Vector2 v, out string x)
+    {
+        x = v.ToString("F2", CultureInfo.InvariantCulture.NumberFormat);
+        return true;
+    }
+
+    private static bool Vector3Parser(string x, out Vector3 v)
+    {
+        bool success = FloatListParser(x, out float[] c) && c.Length == 3;
+        v = success ? new(c[0], c[1], c[2]) : INVALID_VECTOR;
+        return success;
+    }
+
+    private static bool Vector3Unparser(Vector3 v, out string x)
+    {
+        x = v.ToString("F2", CultureInfo.InvariantCulture.NumberFormat);
+        return true;
+    }
+
+    private static bool Vector4Parser(string x, out Vector4 v)
+    {
+        bool success = FloatListParser(x, out float[] c) && c.Length == 4;
+        v = success ? new(c[0], c[1], c[2], c[3]) : INVALID_VECTOR;
+        return success;
+    }
+
+    private static bool Vector4Unparser(Vector4 v, out string x)
+    {
+        x = v.ToString("F2", CultureInfo.InvariantCulture.NumberFormat);
+        return true;
+    }
+
+    private static bool QuaternionParser(string x, out Quaternion q)
+    {
+        bool success = FloatListParser(x, out float[] c) && c.Length == 4;
+        q = success ? new(c[0], c[1], c[2], c[3]) : INVALID_QUATERNION;
+        return success;
+    }
+
+    private static bool QuaternionUnparser(Quaternion q, out string x)
+    {
+        x = q.ToString("F3", CultureInfo.InvariantCulture.NumberFormat);
+        return true;
+    }
+
+    /// <summary>
+    /// Parses strings of the format "(-0.0, -0.0, ... , -0.0)" with or without brackets
+    /// into an array of floats.
+    /// </summary>
+    private static bool FloatListParser(string x, out float[] results)
+    {
+        string[] rawVals = [.. x.Trim().Trim('(', ')').Split(',').Select(s => s.Trim())];
+        results = new float[rawVals.Length];
+
+        NumberFormatInfo format = CultureInfo.InvariantCulture.NumberFormat;
+
+        for (int i = 0; i < rawVals.Length; i++)
+            if (!float.TryParse(rawVals[i], NumberStyles.Float, format, out results[i]))
+                return false;
+
+        return true;
+    }
+
+    #endregion
 }

Silksong.ModMenu/Plugin/ConfigEntryFactory.cs

@@ -45,6 +45,10 @@ public delegate bool MenuElementGenerator(
         GenerateDoubleElement,
         GenerateStringElement,
         GenerateColorElement,
+        GenerateVector2Element,
+        GenerateVector3Element,
+        GenerateVector4Element,
+        GenerateQuaternionElement,
     ];
 
     /// <summary>
@@ -704,6 +708,106 @@ public static bool GenerateColorElement(
         return true;
     }
 
+    /// <summary>
+    /// Generate a text element for a Vector2.
+    /// </summary>
+    public static bool GenerateVector2Element(
+        ConfigEntryBase entry,
+        [MaybeNullWhen(false)] out MenuElement menuElement
+    )
+    {
+        if (entry is not ConfigEntry<Vector2> vectorEntry)
+        {
+            menuElement = default;
+            return false;
+        }
+
+        TextInput<Vector2> vector = new(
+            entry.LabelName(),
+            TextModels.ForVector2(),
+            entry.DescriptionLine()
+        );
+        vector.SynchronizeWith(vectorEntry);
+
+        menuElement = vector;
+        return true;
+    }
+
+    /// <summary>
+    /// Generate a text element for a Vector3.
+    /// </summary>
+    public static bool GenerateVector3Element(
+        ConfigEntryBase entry,
+        [MaybeNullWhen(false)] out MenuElement menuElement
+    )
+    {
+        if (entry is not ConfigEntry<Vector3> vectorEntry)
+        {
+            menuElement = default;
+            return false;
+        }
+
+        TextInput<Vector3> vector = new(
+            entry.LabelName(),
+            TextModels.ForVector3(),
+            entry.DescriptionLine()
+        );
+        vector.SynchronizeWith(vectorEntry);
+
+        menuElement = vector;
+        return true;
+    }
+
+    /// <summary>
+    /// Generate a text element for a Vector4.
+    /// </summary>
+    public static bool GenerateVector4Element(
+        ConfigEntryBase entry,
+        [MaybeNullWhen(false)] out MenuElement menuElement
+    )
+    {
+        if (entry is not ConfigEntry<Vector4> vectorEntry)
+        {
+            menuElement = default;
+            return false;
+        }
+
+        TextInput<Vector4> vector = new(
+            entry.LabelName(),
+            TextModels.ForVector4(),
+            entry.DescriptionLine()
+        );
+        vector.SynchronizeWith(vectorEntry);
+
+        menuElement = vector;
+        return true;
+    }
+
+    /// <summary>
+    /// Generate a text element for a Quaternion.
+    /// </summary>
+    public static bool GenerateQuaternionElement(
+        ConfigEntryBase entry,
+        [MaybeNullWhen(false)] out MenuElement menuElement
+    )
+    {
+        if (entry is not ConfigEntry<Quaternion> quaternionEntry)
+        {
+            menuElement = default;
+            return false;
+        }
+
+        TextInput<Quaternion> quaternion = new(
+            entry.LabelName(),
+            TextModels.ForQuaternion(),
+            entry.DescriptionLine()
+        );
+        quaternion.SynchronizeWith(quaternionEntry);
+
+        menuElement = quaternion;
+        return true;
+    }
+
     private record ElementTreeNode
     {
         public readonly List<(string path, MenuElement element)> Elements = [];

Silksong.ModMenuTesting/Tests/ModMenuAutoTestingPlugin.cs

@@ -19,24 +19,24 @@ protected override void Setup(ConfigFile config)
     {
         config.Bind("Unity Types", "KeyCode Option", KeyCode.A);
         config.Bind("Unity Types", "Color Option", Color.green);
-        config.Bind("Unity Types", "Vector2 Option", Vector2.one); // not done
-        config.Bind("Unity Types", "Vector3 Option", Vector3.one); // not done
-        config.Bind("Unity Types", "Vector4 Option", Vector4.one); // not done
-        config.Bind("Unity Types", "Quaternion Option", Quaternion.identity); // not done
+        config.Bind("Unity Types", "Vector2 Option", Vector2.one);
+        config.Bind("Unity Types", "Vector3 Option", Vector3.one);
+        config.Bind("Unity Types", "Vector4 Option", Vector4.one);
+        config.Bind("Unity Types", "Quaternion Option", Quaternion.identity);
 
         config.Bind("Value Types", "String Option", "value");
         config.Bind("Value Types", "Enum Option", TestEnum.EnumOne);
         config.Bind("Value Types", "Bool Option", true);
-        config.Bind("Value Types", "Byte Option", (byte)0); // not done
-        config.Bind("Value Types", "SByte Option", (sbyte)0); // not done
-        config.Bind("Value Types", "Short Option", (short)0); // not done
-        config.Bind("Value Types", "UShort Option", (ushort)0); // not done
+        config.Bind("Value Types", "Byte Option", (byte)0);
+        config.Bind("Value Types", "SByte Option", (sbyte)0);
+        config.Bind("Value Types", "Short Option", (short)0);
+        config.Bind("Value Types", "UShort Option", (ushort)0);
         config.Bind("Value Types", "Int Option", 0);
-        config.Bind("Value Types", "UInt Option", 0u); // not done
-        config.Bind("Value Types", "Long Option", 0L); // not done
-        config.Bind("Value Types", "ULong Option", 0UL); // not done
+        config.Bind("Value Types", "UInt Option", 0u);
+        config.Bind("Value Types", "Long Option", 0L);
+        config.Bind("Value Types", "ULong Option", 0UL);
         config.Bind("Value Types", "Float Option", 0.0f);
-        config.Bind("Value Types", "Double Option", 0.0d); // not done
-        config.Bind("Value Types", "Decimal Option", 0.0m); // not done
+        config.Bind("Value Types", "Double Option", 0.0d);
+        config.Bind("Value Types", "Decimal Option", 0.0m);
     }
 }