From 22487264500cb29a19d584dac97c0c790b002617 Mon Sep 17 00:00:00 2001
From: XtraCube <72575280+XtraCube@users.noreply.github.com>
Date: Mon, 17 Mar 2025 09:12:26 -0400
Subject: [PATCH] IncludeInPreset property

---
 MiraAPI/GameOptions/IModdedOption.cs          |  5 ++
 .../OptionTypes/ModdedEnumOption.cs           | 18 ++---
 .../OptionTypes/ModdedNumberOption.cs         |  4 +-
 .../GameOptions/OptionTypes/ModdedOption.cs   | 65 ++++++-------------
 .../OptionTypes/ModdedToggleOption.cs         |  3 +-
 5 files changed, 39 insertions(+), 56 deletions(-)

diff --git a/MiraAPI/GameOptions/IModdedOption.cs b/MiraAPI/GameOptions/IModdedOption.cs
index 86baf9d..e002912 100644
--- a/MiraAPI/GameOptions/IModdedOption.cs
+++ b/MiraAPI/GameOptions/IModdedOption.cs
@@ -46,6 +46,11 @@ public interface IModdedOption
     /// </summary>
     Func<bool> Visible { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether the option should be included with presets.
+    /// </summary>
+    bool IncludeInPreset { get; set; }
+
     /// <summary>
     /// Gets or sets the ConfigDefinition for the option, used for BepInEx configuration.
     /// </summary>
diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs
index ff422f5..18f13c6 100644
--- a/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs
+++ b/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs
@@ -18,7 +18,7 @@ public class ModdedEnumOption : ModdedOption<int>
     /// <summary>
     /// Gets the string values of the enum.
     /// </summary>
-    public string[]? Values { get; }
+    public string[] Values { get; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="ModdedEnumOption"/> class.
@@ -27,7 +27,8 @@ public class ModdedEnumOption : ModdedOption<int>
     /// <param name="defaultValue">The default value as an int.</param>
     /// <param name="enumType">The Enum type.</param>
     /// <param name="values">An option list of string values to use in place of the enum name.</param>
-    public ModdedEnumOption(string title, int defaultValue, Type enumType, string[]? values = null) : base(title, defaultValue)
+    /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
+    public ModdedEnumOption(string title, int defaultValue, Type enumType, string[]? values = null, bool includeInPreset=true) : base(title, defaultValue, includeInPreset)
     {
         Values = values ?? Enum.GetNames(enumType);
         Data = ScriptableObject.CreateInstance<StringGameSetting>();
@@ -37,7 +38,7 @@ public class ModdedEnumOption : ModdedOption<int>
         data.Type = global::OptionTypes.String;
         data.Values = values is null ?
             Enum.GetNames(enumType).Select(CustomStringName.CreateAndRegister).ToArray()
-            : values.Select(CustomStringName.CreateAndRegister).ToArray();
+            : [.. values.Select(CustomStringName.CreateAndRegister)];
 
         data.Index = Value;
     }
@@ -87,7 +88,7 @@ public class ModdedEnumOption : ModdedOption<int>
     /// <inheritdoc />
     protected override void OnValueChanged(int newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data?.GetValueString(newValue), false);
+        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data.GetValueString(newValue), false);
         if (!OptionBehaviour)
         {
             return;
@@ -109,7 +110,7 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
     /// <summary>
     /// Gets the string values of the enum.
     /// </summary>
-    public string[]? Values { get; }
+    public string[] Values { get; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="ModdedEnumOption{T}"/> class.
@@ -117,7 +118,8 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
     /// <param name="title">The title of the option.</param>
     /// <param name="defaultValue">The default value as an int.</param>
     /// <param name="values">An option list of string values to use in place of the enum name.</param>
-    public ModdedEnumOption(string title, T defaultValue, string[]? values = null) : base(title, defaultValue)
+    /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
+    public ModdedEnumOption(string title, T defaultValue, string[]? values = null, bool includeInPreset=true) : base(title, defaultValue, includeInPreset)
     {
         Values = values ?? Enum.GetNames(typeof(T));
         Data = ScriptableObject.CreateInstance<StringGameSetting>();
@@ -127,9 +129,9 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
         data.Type = global::OptionTypes.String;
         data.Values = values is null ?
             Enum.GetNames(typeof(T)).Select(CustomStringName.CreateAndRegister).ToArray()
-            : values.Select(CustomStringName.CreateAndRegister).ToArray();
+            : [.. values.Select(CustomStringName.CreateAndRegister)];
 
-        data.Index = Convert.ToInt32(Value);
+        data.Index = Convert.ToInt32(Value, NumberFormatInfo.InvariantInfo);
     }
 
     /// <inheritdoc />
diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs
index 4d38c04..a01ffe8 100644
--- a/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs
+++ b/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs
@@ -48,6 +48,7 @@ public class ModdedNumberOption : ModdedOption<float>
     /// <param name="suffixType">The suffix type.</param>
     /// <param name="formatString">Optional format string for the option screen.</param>
     /// <param name="zeroInfinity">Whether zero is infinity or not.</param>
+    /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
     public ModdedNumberOption(
         string title,
         float defaultValue,
@@ -56,7 +57,8 @@ public class ModdedNumberOption : ModdedOption<float>
         float increment,
         MiraNumberSuffixes suffixType,
         string? formatString = null,
-        bool zeroInfinity = false) : base(title, defaultValue)
+        bool zeroInfinity = false,
+        bool includeInPreset = true) : base(title, defaultValue, includeInPreset)
     {
         Min = min;
         Max = max;
diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs
index 670fb3c..2b61e2b 100644
--- a/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs
+++ b/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs
@@ -16,29 +16,19 @@ public abstract class ModdedOption<T> : IModdedOption
 {
     private IMiraPlugin? _parentMod;
 
-    /// <summary>
-    /// Gets the unique identifier of the option.
-    /// </summary>
+    /// <inheritdoc />
     public uint Id { get; }
 
-    /// <summary>
-    /// Gets the title of the option.
-    /// </summary>
+    /// <inheritdoc />
     public string Title { get; }
 
-    /// <summary>
-    /// Gets the StringName object of the option.
-    /// </summary>
+    /// <inheritdoc />
     public StringNames StringName { get; }
 
-    /// <summary>
-    /// Gets the BaseGameSetting data of the option.
-    /// </summary>
-    public BaseGameSetting Data { get; protected init; }
+    /// <inheritdoc />
+    public BaseGameSetting Data { get; protected init; } = null!;
 
-    /// <summary>
-    /// Gets or sets the parent mod of the option.
-    /// </summary>
+    /// <inheritdoc />
     public IMiraPlugin? ParentMod
     {
         get => _parentMod;
@@ -66,19 +56,16 @@ public abstract class ModdedOption<T> : IModdedOption
     /// </summary>
     public Action<T>? ChangedEvent { get; set; }
 
-    /// <summary>
-    /// Gets or sets the visibility of the option.
-    /// </summary>
+    /// <inheritdoc />
     public Func<bool> Visible { get; set; }
 
-    /// <summary>
-    /// Gets or sets the option behaviour of the option.
-    /// </summary>
+    /// <inheritdoc />
+    public bool IncludeInPreset { get; set; }
+
+    /// <inheritdoc />
     public OptionBehaviour? OptionBehaviour { get; protected set; }
 
-    /// <summary>
-    /// Gets or sets the config definition of the option.
-    /// </summary>
+    /// <inheritdoc />
     public ConfigDefinition? ConfigDefinition
     {
         get => _configDefinition;
@@ -96,7 +83,8 @@ public abstract class ModdedOption<T> : IModdedOption
     /// </summary>
     /// <param name="title">The option title.</param>
     /// <param name="defaultValue">The default value.</param>
-    protected ModdedOption(string title, T defaultValue)
+    /// <param name="includeInPreset">Whether to include the option in the preset.</param>
+    protected ModdedOption(string title, T defaultValue, bool includeInPreset = true)
     {
         Id = ModdedOptionsManager.NextId;
         Title = title;
@@ -104,6 +92,7 @@ public abstract class ModdedOption<T> : IModdedOption
         Value = defaultValue;
         StringName = CustomStringName.CreateAndRegister(Title);
         Visible = () => true;
+        IncludeInPreset = includeInPreset;
     }
 
     internal void ValueChanged(OptionBehaviour optionBehaviour)
@@ -138,22 +127,13 @@ public abstract class ModdedOption<T> : IModdedOption
         OnValueChanged(newValue);
     }
 
-    /// <summary>
-    /// Gets the float data of the option.
-    /// </summary>
-    /// <returns>A float object representing the option's value.</returns>
+    /// <inheritdoc />
     public abstract float GetFloatData();
 
-    /// <summary>
-    /// Gets the net data of the option.
-    /// </summary>
-    /// <returns>A NetData object representing this option's data.</returns>
+    /// <inheritdoc />
     public abstract NetData GetNetData();
 
-    /// <summary>
-    /// Handles incoming net data.
-    /// </summary>
-    /// <param name="data">The NetData's byte array.</param>
+    /// <inheritdoc />
     public abstract void HandleNetData(byte[] data);
 
     /// <summary>
@@ -169,14 +149,7 @@ public abstract class ModdedOption<T> : IModdedOption
     /// <returns>The value.</returns>
     public abstract T GetValueFromOptionBehaviour(OptionBehaviour optionBehaviour);
 
-    /// <summary>
-    /// Creates the option behaviour.
-    /// </summary>
-    /// <param name="toggleOpt">The ToggleOption prefab.</param>
-    /// <param name="numberOpt">The NumberOption prefab.</param>
-    /// <param name="stringOpt">The StringOption prefab.</param>
-    /// <param name="container">The options container.</param>
-    /// <returns>A new OptionBehaviour for this modded option.</returns>
+    /// <inheritdoc />
     public abstract OptionBehaviour CreateOption(
         ToggleOption toggleOpt,
         NumberOption numberOpt,
diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs
index 3495e86..26ecc74 100644
--- a/MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs
+++ b/MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs
@@ -15,7 +15,8 @@ public class ModdedToggleOption : ModdedOption<bool>
     /// </summary>
     /// <param name="title">The option title.</param>
     /// <param name="defaultValue">The default value.</param>
-    public ModdedToggleOption(string title, bool defaultValue) : base(title, defaultValue)
+    /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
+    public ModdedToggleOption(string title, bool defaultValue, bool includeInPreset=true) : base(title, defaultValue, includeInPreset)
     {
         Data = ScriptableObject.CreateInstance<CheckboxGameSetting>();