diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs index 1c236db3..a1df6cc7 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs @@ -83,7 +83,7 @@ public abstract class ModdedOptionListAttribute(string? title = null) : Property /// The formatted option's title. protected string GetFormattedTitle(int index, PropertyInfo property) { - var baseTitle = Title ?? property.Name; + var baseTitle = Title ??= property.Name; return Titles[index] = GetFormattedTitle(baseTitle, index, FormatParams.Match(baseTitle)); } diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs index 48a11fa0..4149c864 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs @@ -2,8 +2,10 @@ using System.Globalization; using System.Linq; using System.Runtime.CompilerServices; +using BepInEx.Configuration; using MiraAPI.Networking; using MiraAPI.Translation; +using MiraAPI.Utilities; namespace MiraAPI.GameOptions.OptionTypes; @@ -107,6 +109,12 @@ public class ModdedEnumOption : ModdedBaseEnumOption { SetValue(BitConverter.ToInt32(data)); } + + /// + protected internal override ConfigDescription? CreateDescription() + { + return new(string.Empty, new AcceptableValueList(UnderlyingValues)); + } } /// @@ -187,4 +195,10 @@ public class ModdedEnumOption : ModdedBaseEnumOption { SetValue(Unsafe.ReadUnaligned(ref data[0])); } + + /// + protected internal override ConfigDescription? CreateDescription() + { + return new(string.Empty, new AcceptableEnumValues(UnderlyingValues)); + } } diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs index f5d36774..eb5bba87 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs @@ -1,6 +1,7 @@ using System; using System.Text.RegularExpressions; using AmongUs.GameOptions; +using BepInEx.Configuration; using MiraAPI.Networking; using MiraAPI.Utilities; using UnityEngine; @@ -294,6 +295,12 @@ public class ModdedNumberOption : ModdedOption return Math.Clamp(newValue, Min, Max); } + /// + protected internal override ConfigDescription? CreateDescription() + { + return new(string.Empty, new AcceptableValueRange(Min, Max)); + } + /// /// Implicitly converts the option to an . /// diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs index 649b224d..3babb611 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedOption.cs @@ -92,7 +92,7 @@ public abstract class ModdedOption(string groupPrefix, string title, T defaul if (field != null || value == null) return; field = value; - var entry = field.GetConfigFile().Bind(ConfigDefinition, DefaultValue); + var entry = field.GetConfigFile().Bind(ConfigDefinition, DefaultValue, CreateDescription()); Value = entry.Value; } } @@ -262,6 +262,13 @@ public abstract class ModdedOption(string groupPrefix, string title, T defaul return newValue; } +#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member (Justification: Internal code.) + protected internal virtual ConfigDescription? CreateDescription() +#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member + { + return null; + } + /// /// Implicitly converts the option to type of . /// diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedStringOption.cs b/MiraAPI/GameOptions/OptionTypes/ModdedStringOption.cs index 7eee8ba5..3e3f66ba 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedStringOption.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedStringOption.cs @@ -2,6 +2,7 @@ using System.Globalization; using System.Linq; using System.Text; +using BepInEx.Configuration; using MiraAPI.Networking; using MiraAPI.Translation; @@ -103,4 +104,10 @@ public class ModdedStringOption : ModdedBaseStringOption { SetValue(Encoding.Unicode.GetString(data)); } + + /// + protected internal override ConfigDescription? CreateDescription() + { + return new(string.Empty, new AcceptableValueList(UnderlyingValues)); + } } diff --git a/MiraAPI/Utilities/AcceptableEnumValues.cs b/MiraAPI/Utilities/AcceptableEnumValues.cs new file mode 100644 index 00000000..e979e87f --- /dev/null +++ b/MiraAPI/Utilities/AcceptableEnumValues.cs @@ -0,0 +1,66 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using BepInEx.Configuration; + +namespace MiraAPI.Utilities; + +/// +/// Specify the list of acceptable enum values for a setting. +/// +/// The type of the enum. +public sealed class AcceptableEnumValues : AcceptableValueBase + where T : struct, Enum +{ + /// + /// Gets a list of values that a setting can take. + /// + public T[] AcceptableValues { get; } + + /// + /// Initializes a new instance of the class. + /// + /// The acceptable values. + /// Thrown when the given values are null. + /// Thrown when no values are given. + public AcceptableEnumValues(params T[] acceptableValues) + : base(typeof(T)) + { + ArgumentNullException.ThrowIfNull(acceptableValues); + + if (acceptableValues.Length == 0) + { + throw new ArgumentException("At least one acceptable value is needed", nameof(acceptableValues)); + } + + AcceptableValues = acceptableValues; + } + + /// + public override object Clamp(object value) + { + if (IsValid(value)) + { + return value; + } + + return AcceptableValues[0]; + } + + /// + public override bool IsValid(object value) + { + if (value is not T v) + { + return false; + } + + return AcceptableValues.Any(x => EqualityComparer.Default.Equals(x, v)); + } + + /// + public override string ToDescriptionString() + { + return "# Acceptable values: " + string.Join(", ", AcceptableValues.Select(x => x.ToString())); + } +}