Merge pull request #112 from All-Of-Us-Mods/options-improvements

More additions to the options system

MiraAPI.Example/.editorconfig

@@ -2,3 +2,6 @@
 
 # SA1602: Enumeration items should be documented.
 dotnet_diagnostic.SA1602.severity = none
+
+# SA1601: Partial elements should be documented
+dotnet_diagnostic.SA1601.severity = none

MiraAPI.Example/Options/ExampleOptions.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Utilities;
@@ -6,6 +6,9 @@ using UnityEngine;
 
 namespace MiraAPI.Example.Options;
 
+[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Demo.")]
+[SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "Read above.")]
+[SuppressMessage("Minor Code Smell", "S3400:Methods should not return constants", Justification = "Read above.")]
 public class ExampleOptions : AbstractOptionGroup
 {
     public override string GroupName => "options.exampleOptions1";
@@ -13,27 +16,64 @@ public class ExampleOptions : AbstractOptionGroup
     public override bool ShowInMatchInfoGuide => true;
 
     [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
-    public bool ToggleOpt { get; set; } = false;
+    [ModdedOptionVisibility] // Automatically resolves to using ToggleOpt1Visibility, can also target toggle options
+    public bool ToggleOpt1 { get; set; } = false;
 
-    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
+    [ModdedToggleOption("options.exampleOptions1.toggleOpt2")]
+    [ModdedOptionVisibility(nameof(ToggleOpt1))] // ToggleOpt2 will be visible only when ToggleOpt1 is true
     public bool ToggleOpt2 { get; set; } = true;
 
-    [ModdedToggleOption("Toggle Opt 3")]
-    [ModdedOptionVisibility(nameof(ToggleOpt2))] // ToggleOpt3 will be visible only when ToggleOpt2 is true
-    public bool ToggleOpt3 { get; set; } = true;
-
     [ModdedNumberOption("options.exampleOptions1.numberOpt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
+    [ModdedOptionVisibility(nameof(NumberOptVisibility))] // Can also target static methods
     public float NumberOpt { get; set; } = 4f;
 
-    [ModdedEnumOption("options.exampleOptions1.bestApi", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
-    public BestApi Opt { get; set; } = BestApi.MiraAPI;
+    [ModdedNumberOption("options.exampleOptions1.numberOpt", min: 0, max: 10, suffixType: MiraNumberSuffixes.Distance)]
+    public int NumberOpt2 { get; set; } = 4; // Can also be int!
+
+    [ModdedEnumOption("options.exampleOptions1.bestApi", typeof(Api), ["Mira API", "Mitochondria", "Reactor"])]
+    public Api BestApi { get; set; } = Api.MiraAPI;
+
+    [ModdedEnumOption<Api>("options.exampleOptions1.worstApi", ["Mira API", "Mitochondria", "Reactor"])]
+
+    // These three can target both instance and static methods
+    [ModdedOptionGetter(nameof(GetApi))] // Can also automatically resolve to {Option Name}Getter
+    [ModdedOptionSetter(nameof(SetApi))] // Can also automatically resolve to {Option Name}Setter
+    [ModdedOptionChanged(nameof(ApiChanged))] // Can also automatically resolve to {Option Name}Changed
+    public Api WorstApi { get; set; } = Api.MiraAPI;
 
     [ModdedEnumOptionList<ValueState>("Value State {0}", ["None", "Primary", "Secondary"])]
-    public List<ValueState> ValueStates { get; } =
-        [ValueState.Primary, ValueState.Secondary, ValueState.None, ValueState.None, ValueState.None];
+    public ModdedArray<ValueState> ValueStates { get; set; } = [ValueState.Primary, ValueState.Secondary, ValueState.None, ValueState.None, ValueState.None];
+
+    [ModdedPlayerOption("options.exampleOptions1.players")]
+    public NetworkedPlayerInfo PlayerSelected { get; set; }
+
+    public bool ToggleOpt1Visibility()
+    {
+        return true;
+    }
+
+    public static bool NumberOptVisibility()
+    {
+        return true;
+    }
+
+    public static Api GetApi(Api currentValue)
+    {
+        return currentValue;
+    }
+
+    public static Api SetApi(Api newValue, Api oldValue)
+    {
+        return default;
+    }
+
+    public static void ApiChanged(Api currentValue)
+    {
+        // Something
+    }
 }
 
-public enum BestApi
+public enum Api
 {
     MiraAPI,
     Mitochondria,

MiraAPI.Example/Options/ExampleOptions2.cs

@@ -7,9 +7,7 @@ namespace MiraAPI.Example.Options;
 public class ExampleOptions2 : AbstractOptionGroup
 {
     public override string GroupName => "options.exampleOptions2";
-
     public override uint GroupPriority => 0; // This group will be displayed first. The default value is uint.MaxValue.
-
     public override MenuCategory ParentMenu => MenuCategory.CustomTwo;
     public override bool ShowInMatchInfoGuide => true;
 
@@ -28,6 +26,8 @@ public class ExampleOptions2 : AbstractOptionGroup
     public ModdedEnumOption<TestingData> EnumOpt { get; } = new("options.exampleOptions2.enumOpt", 0)
     {
         ChangedEvent = x => Logger<ExamplePlugin>.Info($"changed Enum Opt to {x}"),
+        Getter = currentValue => currentValue,
+        Setter = (newValue, oldValue) => newValue,
     };
 }
 

MiraAPI.Example/Resources/Locale/en_US.xml

@@ -47,6 +47,8 @@ Eliminate every other faction.</string>
     <string name="options.exampleOptions1.toggleOpt2">Toggle Opt 2</string>
     <string name="options.exampleOptions1.numberOpt">Number Opt</string>
     <string name="options.exampleOptions1.bestApi">Best API</string>
+    <string name="options.exampleOptions1.worstApi">Worst API</string>
+    <string name="options.exampleOptions1.players">Choose A Player</string>
     <string name="options.exampleOptions2">Example Options 2</string>
     <string name="options.exampleOptions2.youMustChoseAPlayer">YOU MUST CHOSE A PLAYER</string>
     <string name="options.exampleOptions2.ehWhatever">Eh whatever</string>