From 0e02a0215667ebe1953079d741eea3ece4d22980 Mon Sep 17 00:00:00 2001 From: David Higueros <111460331+TheDavSmasher@users.noreply.github.com> Date: Thu, 22 Oct 2026 15:40:20 -0600 Subject: [PATCH] Changed IModdedOptionList structure to actually allow typed iteration --- .editorconfig | 6 ++++ .../ModdedEnumOptionListAttribute.cs | 12 +++---- .../ModdedNumberOptionListAttribute.cs | 6 ++-- .../OptionList/ModdedOptionListAttribute.cs | 4 +-- .../ModdedPlayerOptionListAttribute.cs | 6 ++-- .../ModdedStringOptionListAttribute.cs | 6 ++-- .../ModdedToggleOptionListAttribute.cs | 6 ++-- MiraAPI/GameOptions/IModdedOption.cs | 35 ++++++++++++++----- MiraAPI/GameOptions/ModdedOptionsManager.cs | 6 ++-- .../OptionTypes/ModdedOptionList.cs | 9 ----- MiraAPI/PluginLoading/MiraPluginManager.cs | 4 +-- 11 files changed, 58 insertions(+), 42 deletions(-) diff --git a/.editorconfig b/.editorconfig index 6daa6a75..20f92823 100644 --- a/.editorconfig +++ b/.editorconfig @@ -104,3 +104,9 @@ dotnet_diagnostic.S1244.severity = none # S2325: Methods and properties that don't access instance data should be static dotnet_diagnostic.S2325.severity = none + +# CA1710: Identifiers should have correct suffix +dotnet_diagnostic.CA1710.severity = silent + +# CA1010: Generic interface should also be implemented +dotnet_diagnostic.CA1010.severity = silent diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedEnumOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedEnumOptionListAttribute.cs index bf2fdf07..55e78a74 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedEnumOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedEnumOptionListAttribute.cs @@ -15,7 +15,7 @@ namespace MiraAPI.GameOptions.Attributes; public class ModdedEnumOptionListAttribute(string title, Type enumType, string[]? values = null) : ModdedOptionListAttribute(title) { - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { var optList = new ModdedOptionList( value.Count, idx => new(GetFormattedTitle(idx), (int)(value[idx] ?? 0), enumType, values)); @@ -25,14 +25,14 @@ public class ModdedEnumOptionListAttribute(string title, Type enumType, string[] /// public override void SetValue(int idx, object value) { - var opt = HolderOptionList?[idx] as ModdedEnumOption; + var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption; opt?.SetValue((int)value); } /// public override object GetValue(int idx) { - return HolderOptionList?[idx] is ModdedEnumOption opt + return HolderOptionList?.ElementAt(idx) is ModdedEnumOption opt ? Enum.ToObject(enumType, opt.Value) : throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {enumType.FullName} is not a ModdedEnumOption"); } @@ -49,7 +49,7 @@ public class ModdedEnumOptionListAttribute(string title, string[]? values = n : ModdedOptionListAttribute(title) where T : struct, Enum { - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { var optList = new ModdedOptionList>( value.Count, idx => new(GetFormattedTitle(idx), (T)(value[idx] ?? 0), values)); @@ -59,14 +59,14 @@ public class ModdedEnumOptionListAttribute(string title, string[]? values = n /// public override void SetValue(int idx, object value) { - var opt = HolderOptionList?[idx] as ModdedEnumOption; + var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption; opt?.SetValue((T)value); } /// public override object GetValue(int idx) { - return HolderOptionList?[idx] is ModdedEnumOption opt + return HolderOptionList?.ElementAt(idx) is ModdedEnumOption opt ? opt.Value : throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {typeof(T).FullName} is not a ModdedEnumOption<{typeof(T).FullName}>"); } diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedNumberOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedNumberOptionListAttribute.cs index c393db3e..0ee13d5b 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedNumberOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedNumberOptionListAttribute.cs @@ -53,7 +53,7 @@ public class ModdedNumberOptionListAttribute( { } - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { return new ModdedOptionList(value.Count, idx => { @@ -81,7 +81,7 @@ public class ModdedNumberOptionListAttribute( /// public override void SetValue(int idx, object value) { - if (HolderOptionList?[idx] is not ModdedNumberOption opt) + if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt) return; var final = value switch @@ -95,7 +95,7 @@ public class ModdedNumberOptionListAttribute( /// public override object GetValue(int idx) { - if (HolderOptionList?[idx] is not ModdedNumberOption opt) + if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt) throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedNumberOption"); var value = opt.Value; diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs index d7ef6e6a..2a31b4d5 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedOptionListAttribute.cs @@ -14,7 +14,7 @@ namespace MiraAPI.GameOptions.Attributes; [AttributeUsage(AttributeTargets.Property)] public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAttribute { - internal IModdedOptionList? HolderOptionList { get; set; } + internal IBaseModdedOptionList? HolderOptionList { get; set; } internal IList? Value { get; set; } internal Type ValueType { get; set; } @@ -68,7 +68,7 @@ public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAt /// The value of the option as an object. public abstract object GetValue(int idx); - internal abstract IModdedOptionList? CreateOptionList(IList value, PropertyInfo property); + internal abstract IBaseModdedOptionList? CreateOptionList(IList value, PropertyInfo property); /// /// Gets the formatted with the option's index. diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedPlayerOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedPlayerOptionListAttribute.cs index 533492bb..036b64a0 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedPlayerOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedPlayerOptionListAttribute.cs @@ -16,7 +16,7 @@ public class ModdedPlayerOptionListAttribute( bool allowNone = true) : ModdedOptionListAttribute(title) { - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { return new ModdedOptionList(value.Count, idx => { @@ -27,7 +27,7 @@ public class ModdedPlayerOptionListAttribute( /// public override void SetValue(int idx, object value) { - if (HolderOptionList?[idx] is not ModdedPlayerOption opt) + if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt) return; var final = value switch @@ -41,7 +41,7 @@ public class ModdedPlayerOptionListAttribute( /// public override object GetValue(int idx) { - if (HolderOptionList?[idx] is not ModdedPlayerOption opt) + if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt) throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedPlayerOption"); if (ValueType == typeof(int)) diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedStringOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedStringOptionListAttribute.cs index 78c4b66d..53b9b5ad 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedStringOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedStringOptionListAttribute.cs @@ -17,7 +17,7 @@ public class ModdedStringOptionListAttribute( string[] values) : ModdedOptionListAttribute(title) { - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { return new ModdedOptionList(value.Count, idx => { @@ -28,14 +28,14 @@ public class ModdedStringOptionListAttribute( /// public override void SetValue(int idx, object value) { - var opt = HolderOptionList?[idx] as ModdedStringOption; + var opt = HolderOptionList?.ElementAt(idx) as ModdedStringOption; opt?.SetValue((string)value); } /// public override object GetValue(int idx) { - return HolderOptionList?[idx] is ModdedStringOption opt + return HolderOptionList?.ElementAt(idx) is ModdedStringOption opt ? opt.Value : throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedStringOption"); } diff --git a/MiraAPI/GameOptions/Attributes/OptionList/ModdedToggleOptionListAttribute.cs b/MiraAPI/GameOptions/Attributes/OptionList/ModdedToggleOptionListAttribute.cs index 9dab9a43..eff26c28 100644 --- a/MiraAPI/GameOptions/Attributes/OptionList/ModdedToggleOptionListAttribute.cs +++ b/MiraAPI/GameOptions/Attributes/OptionList/ModdedToggleOptionListAttribute.cs @@ -27,7 +27,7 @@ public class ModdedToggleOptionListAttribute( { } - internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property) + internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property) { var optList = new ModdedOptionList( value.Count, idx => new(GetFormattedTitle(idx), (bool)(value[idx] ?? false), on, off)); @@ -37,14 +37,14 @@ public class ModdedToggleOptionListAttribute( /// public override void SetValue(int idx, object value) { - var opt = HolderOptionList?[idx] as ModdedToggleOption; + var opt = HolderOptionList?.ElementAt(idx) as ModdedToggleOption; opt?.SetValue((bool)value); } /// public override object GetValue(int idx) { - return HolderOptionList?[idx] is ModdedToggleOption opt + return HolderOptionList?.ElementAt(idx) is ModdedToggleOption opt ? opt.Value : throw new InvalidOperationException($"Holder option for {GetFormattedTitle(idx)} is not a ModdedToggleOption."); } diff --git a/MiraAPI/GameOptions/IModdedOption.cs b/MiraAPI/GameOptions/IModdedOption.cs index a40c9460..344e2b38 100644 --- a/MiraAPI/GameOptions/IModdedOption.cs +++ b/MiraAPI/GameOptions/IModdedOption.cs @@ -1,4 +1,5 @@ using System; +using System.Collections; using System.Collections.Generic; using BepInEx.Configuration; using MiraAPI.Networking; @@ -143,9 +144,11 @@ public interface IModdedOption } /// -/// Interface for list of modded options. +/// Base interface for list of modded options. +/// +/// Do not implement directly, implement or instead. /// -public interface IModdedOptionList : IReadOnlyList +public interface IBaseModdedOptionList : IEnumerable { /// /// Gets the function to name the keys of the individual options in the configuration file. @@ -153,18 +156,34 @@ public interface IModdedOptionList : IReadOnlyList /// Return to use the default of the property's name with its index appended. /// Func? ConfigName { get; init; } + + /// + int Count { get; } + + /// + IModdedOption ElementAt(int index); +} + +/// +/// Interface for list of modded options. +/// +public interface IModdedOptionList : IBaseModdedOptionList, IReadOnlyList +{ + IModdedOption IBaseModdedOptionList.ElementAt(int index) + { + return this[index]; + } } /// /// Interface for list of options. /// /// The type of . -public interface IModdedOptionList : IModdedOptionList +public interface IModdedOptionList : IBaseModdedOptionList, IReadOnlyList where T : IModdedOption { - /// - new T this[int index] { get; } - - /// - new IEnumerator GetEnumerator(); + IModdedOption IBaseModdedOptionList.ElementAt(int index) + { + return this[index]; + } } diff --git a/MiraAPI/GameOptions/ModdedOptionsManager.cs b/MiraAPI/GameOptions/ModdedOptionsManager.cs index 0fb10bb3..2641f706 100644 --- a/MiraAPI/GameOptions/ModdedOptionsManager.cs +++ b/MiraAPI/GameOptions/ModdedOptionsManager.cs @@ -217,7 +217,7 @@ public static class ModdedOptionsManager return; } - if (property.GetValue(group) is not IModdedOptionList optionList) + if (property.GetValue(group) is not IBaseModdedOptionList optionList) { Error($"Failed to get option list for {property.Name}"); return; @@ -227,7 +227,7 @@ public static class ModdedOptionsManager for (var i = 0; i < optionList.Count; i++) { - RegisterOption(optionList[i], group, configName(i), pluginInfo); + RegisterOption(optionList.ElementAt(i), group, configName(i), pluginInfo); } } @@ -324,7 +324,7 @@ public static class ModdedOptionsManager for (var i = 0; i < optionList.Count; i++) { - var option = optionList[i]; + var option = optionList.ElementAt(i); if (visibilityFactory != null) option.Visible = (Func)(visibilityFactory(i) ?? DelegateUtilities.AlwaysTrue); diff --git a/MiraAPI/GameOptions/OptionTypes/ModdedOptionList.cs b/MiraAPI/GameOptions/OptionTypes/ModdedOptionList.cs index 6e9e9ad3..4928e580 100644 --- a/MiraAPI/GameOptions/OptionTypes/ModdedOptionList.cs +++ b/MiraAPI/GameOptions/OptionTypes/ModdedOptionList.cs @@ -62,13 +62,4 @@ public class ModdedOptionList : IModdedOptionList { return Options.GetEnumerator(); } - - /// - IEnumerator IEnumerable.GetEnumerator() - { - return ((IEnumerable)Options).GetEnumerator(); - } - - /// - IModdedOption IReadOnlyList.this[int index] => this[index]; } diff --git a/MiraAPI/PluginLoading/MiraPluginManager.cs b/MiraAPI/PluginLoading/MiraPluginManager.cs index f021c3fc..2874c7d9 100644 --- a/MiraAPI/PluginLoading/MiraPluginManager.cs +++ b/MiraAPI/PluginLoading/MiraPluginManager.cs @@ -328,7 +328,7 @@ public sealed class MiraPluginManager continue; } - if (property.PropertyType.IsAssignableTo(typeof(IModdedOptionList))) + if (property.PropertyType.IsAssignableTo(typeof(IBaseModdedOptionList))) { ModdedOptionsManager.RegisterPropertyOptionList(type, property, pluginInfo); continue; @@ -349,7 +349,7 @@ public sealed class MiraPluginManager } foreach (var field in type.GetFields() - .Where(f => f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IModdedOptionList)))) + .Where(f => f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IBaseModdedOptionList)))) { Error($"{field.Name} is a field, not a property. Use properties for options."); }