cleanup warnings

.editorconfig

@@ -1,2 +1,6 @@
 [*.{cs,vb}]
-dotnet_diagnostic.CA1707.severity = none
+dotnet_diagnostic.CA1707.severity = none
+dotnet_diagnostic.CS1591.severity = none
+dotnet_diagnostic.S125.severity = none
+dotnet_diagnostic.SA1615.severity = none
+dotnet_diagnostic.SA1611.severity = none

MiraAPI/Events/Vanilla/Map/UpdateSystemEvent.cs

@@ -24,6 +24,7 @@ public class UpdateSystemEvent : MiraCancelableEvent
     ///  Initializes a new instance of the <see cref="UpdateSystemEvent"/> class.
     /// </summary>
     /// <param name="systemType">The SystemType being updated.</param>
+    /// <param name="player">The player that is updating the system.</param>
     /// <param name="amount">Amount to update System to.</param>
     public UpdateSystemEvent(SystemTypes systemType, PlayerControl player, byte amount)
     {

MiraAPI/GameModes/CustomGameModeManager.cs

@@ -21,7 +21,7 @@ public static class CustomGameModeManager
     }
 
     /// <summary>
-    /// Current gamemode.
+    /// Gets the current gamemode.
     /// </summary>
     public static CustomGameMode? ActiveMode { get; internal set; } = new DefaultMode();
 

MiraAPI/GameOptions/ModdedOptionsManager.cs

@@ -45,7 +45,9 @@ public static class ModdedOptionsManager
         pluginInfo.OptionGroups.Add(group);
 
         typeof(OptionGroupSingleton<>).MakeGenericType(type)
+#pragma warning disable S3011
             .GetField("_instance", BindingFlags.Static | BindingFlags.NonPublic)!
+#pragma warning restore S3011
             .SetValue(null, group);
 
         return true;

MiraAPI/GameOptions/ModifierOptionGroup.cs

@@ -2,7 +2,9 @@
 
 namespace MiraAPI.GameOptions;
 
+#pragma warning disable CA1852
 internal class ModifierOptionGroup : AbstractOptionGroup
+#pragma warning restore CA1852
 {
     public override string GroupName { get; }
 

MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs

@@ -129,7 +129,7 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
             Enum.GetNames(typeof(T)).Select(CustomStringName.CreateAndRegister).ToArray()
             : values.Select(CustomStringName.CreateAndRegister).ToArray();
 
-        data.Index = Convert.ToInt32(Value);
+        data.Index = Convert.ToInt32(Value, NumberFormatInfo.InvariantInfo);
     }
 
     /// <inheritdoc />

MiraAPI/GameOptions/OptionTypes/ModdedOption.cs

@@ -32,9 +32,9 @@ public abstract class ModdedOption<T> : IModdedOption
     public StringNames StringName { get; }
 
     /// <summary>
-    /// Gets the BaseGameSetting data of the option.
+    /// Gets or sets the BaseGameSetting data of the option.
     /// </summary>
-    public BaseGameSetting Data { get; protected init; }
+    public BaseGameSetting Data { get; protected set; } = null!;
 
     /// <summary>
     /// Gets or sets the parent mod of the option.

MiraAPI/Hud/CustomActionButton.cs

@@ -180,7 +180,7 @@ public abstract class CustomActionButton
 
         if (!moveButton) return;
 
-        if (HudManagerPatches._bottomLeft == null || HudManagerPatches._bottomRight == null)
+        if (HudManagerPatches.BottomLeft == null || HudManagerPatches.BottomRight == null)
         {
             return;
         }
@@ -188,17 +188,17 @@ public abstract class CustomActionButton
         switch (location)
         {
             case ButtonLocation.BottomLeft:
-                var gridArrange = HudManagerPatches._bottomLeft.GetComponent<GridArrange>();
-                var aspectPosition = HudManagerPatches._bottomLeft.GetComponent<AspectPosition>();
+                var gridArrange = HudManagerPatches.BottomLeft.GetComponent<GridArrange>();
+                var aspectPosition = HudManagerPatches.BottomLeft.GetComponent<AspectPosition>();
 
-                Button.transform.SetParent(HudManagerPatches._bottomLeft.transform);
+                Button.transform.SetParent(HudManagerPatches.BottomLeft.transform);
 
                 gridArrange.Start();
                 gridArrange.ArrangeChilds();
                 aspectPosition.AdjustPosition();
                 break;
             case ButtonLocation.BottomRight:
-                Button.transform.SetParent(HudManagerPatches._bottomRight);
+                Button.transform.SetParent(HudManagerPatches.BottomRight);
                 break;
         }
     }
@@ -435,11 +435,11 @@ public abstract class CustomActionButton
         {
             if (CanUse())
             {
-                Button.SetEnabled();
+                Button!.SetEnabled();
             }
             else
             {
-                Button.SetDisabled();
+                Button!.SetDisabled();
             }
 
             if (EffectActive)

MiraAPI/Hud/CustomButtonManager.cs

@@ -31,7 +31,9 @@ public static class CustomButtonManager
         CustomButtons.Add(button);
         pluginInfo.Buttons.Add(button);
         typeof(CustomButtonSingleton<>).MakeGenericType(buttonType)
+#pragma warning disable S3011
             .GetField("_instance", BindingFlags.Static | BindingFlags.NonPublic)!
+#pragma warning restore S3011
             .SetValue(null, button);
 
         ButtonEventTypes.Add(buttonType, typeof(MiraButtonClickEvent<>).MakeGenericType(buttonType));

MiraAPI/Hud/CustomButtonSingleton.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
 
 namespace MiraAPI.Hud;
 
@@ -13,7 +14,6 @@ public static class CustomButtonSingleton<T> where T : CustomActionButton
     /// <summary>
     /// Gets the instance of the button.
     /// </summary>
-#pragma warning disable CA1000
+    [SuppressMessage("Design", "CA1000:Do not declare static members on generic types", Justification = "This is a utility class to get the instance of a custom action button.")]
     public static T Instance => _instance ??= CustomButtonManager.CustomButtons.OfType<T>().Single();
-#pragma warning restore CA1000
 }

MiraAPI/Modifiers/ModifierDisplay/ModifierDisplayComponent.cs

@@ -17,7 +17,7 @@ namespace MiraAPI.Modifiers.ModifierDisplay;
 /// The code used to display Mira modifiers.
 /// </summary>
 [RegisterInIl2Cpp]
-public class ModifierDisplayComponent(nint ptr) : MonoBehaviour(ptr)
+public class ModifierDisplayComponent(nint cppPtr) : MonoBehaviour(cppPtr)
 {
     /// <summary>
     /// Gets the instance of the Modifier Display.
@@ -34,8 +34,8 @@ public class ModifierDisplayComponent(nint ptr) : MonoBehaviour(ptr)
     private PassiveButton _nextButton = null!;
     private PassiveButton _backButton = null!;
 
-    private int _currentPage = 0;
-    private const int _itemsPerPage = 3;
+    private int _currentPage;
+    private const int ItemsPerPage = 3;
 
     private readonly Dictionary<BaseModifier, ModifierUiComponent> _modifiers = [];
 
@@ -142,10 +142,10 @@ public class ModifierDisplayComponent(nint ptr) : MonoBehaviour(ptr)
 
     private void UpdatePage()
     {
-        var totalPages = Mathf.CeilToInt((float)_modifiers.Count / _itemsPerPage);
+        var totalPages = Mathf.CeilToInt((float)_modifiers.Count / ItemsPerPage);
         _currentPage = Mathf.Clamp(_currentPage, 0, Mathf.Max(0, totalPages - 1));
 
-        if (_modifiers.Count <= _itemsPerPage)
+        if (_modifiers.Count <= ItemsPerPage)
         {
             _modifiers.Do(x => x.Value.gameObject.SetActive(true));
             _pagination.gameObject.SetActive(false);
@@ -162,8 +162,8 @@ public class ModifierDisplayComponent(nint ptr) : MonoBehaviour(ptr)
         _backButton.gameObject.SetActive(true);
 
         _modifiers.Do(x => x.Value.gameObject.SetActive(false));
-        var start = _currentPage * _itemsPerPage;
-        var end = Mathf.Min(start + _itemsPerPage, _modifiers.Count);
+        var start = _currentPage * ItemsPerPage;
+        var end = Mathf.Min(start + ItemsPerPage, _modifiers.Count);
         var modifiers = _modifiers.ToArray();
 
         for (var i = start; i < end; i++)

MiraAPI/Modifiers/ModifierDisplay/ModifierUiComponent.cs

@@ -9,7 +9,7 @@ namespace MiraAPI.Modifiers.ModifierDisplay;
 /// The code placed on every Modifier HUD object. Used to handle updating.
 /// </summary>
 [RegisterInIl2Cpp]
-public class ModifierUiComponent(nint ptr) : MonoBehaviour(ptr)
+public class ModifierUiComponent(nint cppPtr) : MonoBehaviour(cppPtr)
 {
     /// <summary>
     /// Gets the modifier which this component is for.
@@ -17,12 +17,13 @@ public class ModifierUiComponent(nint ptr) : MonoBehaviour(ptr)
     [HideFromIl2Cpp]
     public BaseModifier? Modifier { get; internal set; }
 
+    // ReSharper disable InconsistentNaming
     private SpriteRenderer modBg = null!;
     private TextMeshPro desc = null!;
     private SpriteRenderer icon = null!;
     private TextMeshPro nameText = null!;
     private RectTransform descRect = null!;
-
+    // ReSharper restore InconsistentNaming
     private void Awake()
     {
         if (Modifier == null) return;

MiraAPI/Modifiers/ModifierFactory.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Linq.Expressions;
 using MiraAPI.Utilities;
@@ -11,7 +12,7 @@ namespace MiraAPI.Modifiers;
 /// </summary>
 public static class ModifierFactory
 {
-    private static readonly Dictionary<(Type, Type[]), Func<object[], BaseModifier>> _constructorCache = [];
+    private static readonly Dictionary<(Type, Type[]), Func<object[], BaseModifier>> ConstructorCache = [];
 
     private static Func<object[], BaseModifier> CreateConstructor(Type type, params object[] args)
     {
@@ -45,13 +46,13 @@ public static class ModifierFactory
     /// <returns>An instance of the modifier.</returns>
     public static BaseModifier CreateInstance(Type type, params object[] args)
     {
-        var argTypes = args.Select(arg => arg?.GetType() ?? typeof(object)).ToArray();
+        var argTypes = args.Select(arg => arg.GetType()).ToArray();
         var key = (type, argTypes);
 
-        if (!_constructorCache.TryGetValue(key, out var constructor))
+        if (!ConstructorCache.TryGetValue(key, out var constructor))
         {
             constructor = CreateConstructor(type, args);
-            _constructorCache[key] = constructor;
+            ConstructorCache[key] = constructor;
         }
 
         return constructor(args);
@@ -95,6 +96,7 @@ public static class ModifierFactory<T> where T : BaseModifier
     /// </summary>
     /// <param name="args">Parameters for the constructor.</param>
     /// <returns>An instance of the modifier.</returns>
+    [SuppressMessage("Design", "CA1000:Do not declare static members on generic types", Justification = "This is a factory class.")]
     public static T CreateInstance(params object[] args)
     {
         return Constructor(args);

MiraAPI/Networking/MiraRpc.cs

@@ -46,7 +46,7 @@ public enum MiraRpc : uint
     RemoveVote,
 
     /// <summary>
-    /// Custom RPC to replace Among Us CastVote
+    /// Custom RPC to replace Among Us CastVote.
     /// </summary>
     CastVote,
 }

MiraAPI/Patches/Hud/ButtonResetPatches.cs

@@ -4,7 +4,7 @@ using MiraAPI.Hud;
 namespace MiraAPI.Patches.Hud;
 
 /// <summary>
-/// Reset button patches
+/// Reset button patches.
 /// </summary>
 [HarmonyPatch]
 public static class ButtonResetPatches

MiraAPI/Patches/HudManagerPatches.cs

@@ -13,9 +13,9 @@ namespace MiraAPI.Patches;
 public static class HudManagerPatches
 {
     // Custom buttons parent.
-    internal static GameObject? _bottomLeft;
-    internal static Transform? _bottomRight;
-    internal static Transform? _buttons;
+    public static GameObject? BottomLeft { get; private set; }
+    public static Transform? BottomRight { get; private set; }
+    public static Transform? Buttons { get; private set; }
 
     /*
     /// <summary>
@@ -36,30 +36,30 @@ public static class HudManagerPatches
     [HarmonyPatch(nameof(HudManager.Start))]
     public static void StartPostfix(HudManager __instance)
     {
-        if (_buttons == null)
+        if (Buttons == null)
         {
-            _buttons = __instance.transform.Find("Buttons");
+            Buttons = __instance.transform.Find("Buttons");
         }
 
-        if (_bottomRight == null)
+        if (BottomRight == null)
         {
-            _bottomRight = _buttons.Find("BottomRight");
+            BottomRight = Buttons.Find("BottomRight");
         }
 
-        if (_bottomLeft == null)
+        if (BottomLeft == null)
         {
-            _bottomLeft = Object.Instantiate(_bottomRight.gameObject, _buttons);
+            BottomLeft = Object.Instantiate(BottomRight.gameObject, Buttons);
         }
 
-        foreach (var t in _bottomLeft.GetComponentsInChildren<ActionButton>(true))
+        foreach (var t in BottomLeft.GetComponentsInChildren<ActionButton>(true))
         {
             t.gameObject.Destroy();
         }
 
-        var gridArrange = _bottomLeft.GetComponent<GridArrange>();
-        var aspectPosition = _bottomLeft.GetComponent<AspectPosition>();
+        var gridArrange = BottomLeft.GetComponent<GridArrange>();
+        var aspectPosition = BottomLeft.GetComponent<AspectPosition>();
 
-        _bottomLeft.name = "BottomLeft";
+        BottomLeft.name = "BottomLeft";
         gridArrange.Alignment = GridArrange.StartAlign.Right;
         aspectPosition.Alignment = AspectPosition.EdgeAlignments.LeftBottom;
 
@@ -67,8 +67,8 @@ public static class HudManagerPatches
         {
             var location = button.Location switch
             {
-                ButtonLocation.BottomLeft => _bottomLeft.transform,
-                ButtonLocation.BottomRight => _bottomRight,
+                ButtonLocation.BottomLeft => BottomLeft.transform,
+                ButtonLocation.BottomRight => BottomRight,
                 _ => null,
             };
 

MiraAPI/Patches/Menu/NameplatesTabPatches.cs

@@ -108,7 +108,7 @@ public static class NameplatesTabPatches
         var x = (NamePlateViewData viewdata) =>
         {
             colorChip.transform.GetChild(1).GetComponent<SpriteRenderer>().sprite = viewdata?.Image;
-            //(colorChip as NameplateChip).image.sprite = viewdata?.Image;
+            // (colorChip as NameplateChip).image.sprite = viewdata?.Image;
         };
         __instance.StartCoroutine(AddressableAssetExtensions.CoLoadAssetAsync<NamePlateViewData>(__instance, namePlate.GetAssetReference(), x));
         colorChip.transform.localPosition = new Vector3(position.x, position.y, -1f);

MiraAPI/Patches/MinigameBeginErrorPatch.cs

@@ -3,7 +3,7 @@
 namespace MiraAPI.Patches;
 
 /// <summary>
-/// Used to fix the Minigame crash errors (credits Submerged/PH Gaming for the fix)
+/// Used to fix the Minigame crash errors (credits Submerged/PH Gaming for the fix).
 /// </summary>
 [HarmonyPatch]
 public static class MinigameBeginErrorPatch

MiraAPI/Patches/Roles/GameStartupPatch.cs

@@ -10,7 +10,7 @@ public static class GameStartupPatch
     private static bool _runOnce;
 
     /// <summary>
-    /// This is used for registering roles when the game opens, might be a janky solution, but it works
+    /// This is used for registering roles when the game opens, might be a janky solution, but it works.
     /// </summary>
     [HarmonyPostfix]
     [HarmonyPatch(nameof(MainMenuManager.Start))]

MiraAPI/Patches/Roles/HauntMenuPatch.cs

@@ -24,4 +24,4 @@ public static class HauntMenuMinigamePatch
         __instance.FilterText.text = role.NiceName;
         __instance.FilterText.color = color;
     }
-}
+}

MiraAPI/Patches/Roles/RoleOptionsCollectionPatch.cs

@@ -12,7 +12,7 @@ namespace MiraAPI.Patches.Roles;
 public static class RoleOptionsCollectionPatch
 {
     /// <summary>
-    /// Set the role chance for custom Launchpad roles based on config
+    /// Set the role chance for custom Launchpad roles based on config.
     /// </summary>
     /// <returns>Return false to skip original method, true to not.</returns>
     [HarmonyPrefix]
@@ -42,7 +42,7 @@ public static class RoleOptionsCollectionPatch
     }
 
     /// <summary>
-    /// Set the amount for custom Launchpad roles based on config
+    /// Set the amount for custom Launchpad roles based on config.
     /// </summary>
     /// <returns>Return false to skip original method, true to not.</returns>
     [HarmonyPrefix]

MiraAPI/Patches/Roles/SabotageButtonPatch.cs

@@ -4,7 +4,7 @@ using MiraAPI.Roles;
 namespace MiraAPI.Patches.Roles;
 
 [HarmonyPatch(typeof(SabotageButton))]
-public class SabotageButtonPatch
+public static class SabotageButtonPatch
 {
     /// <summary>
     /// Patches the Sabotage button to check if the player's custom role can use sabotage.

MiraAPI/PluginLoading/MiraPluginManager.cs

@@ -162,6 +162,12 @@ public sealed class MiraPluginManager
 
             foreach (var property in type.GetProperties())
             {
+                if (property.GetMethod?.IsStatic == true)
+                {
+                    Logger<MiraApiPlugin>.Error($"Option property {property.Name} in {type.Name} must not be static.");
+                    continue;
+                }
+
                 if (property.PropertyType.IsAssignableTo(typeof(IModdedOption)))
                 {
                     ModdedOptionsManager.RegisterPropertyOption(type, property, pluginInfo);

MiraAPI/Utilities/Assets/LoadableResourceAsset.cs

@@ -7,6 +7,7 @@ namespace MiraAPI.Utilities.Assets;
 /// A utility class for loading assets from embedded resources.
 /// </summary>
 /// <param name="path">The path to the embedded resource.</param>
+/// <param name="pixelsPerUnit">The pixels per unit for the loaded sprite.</param>
 public class LoadableResourceAsset(string path, float pixelsPerUnit=100f) : LoadableAsset<Sprite>
 {
     private readonly Assembly _assembly = Assembly.GetCallingAssembly();
@@ -14,9 +15,9 @@ public class LoadableResourceAsset(string path, float pixelsPerUnit=100f) : Load
     /// <inheritdoc />
     public override Sprite LoadAsset()
     {
-        if (LoadedAsset != null)
+        if (LoadedAsset)
         {
-            return LoadedAsset;
+            return LoadedAsset!;
         }
 
         return LoadedAsset = SpriteTools.LoadSpriteFromPath(path, _assembly, pixelsPerUnit);

MiraAPI/Utilities/Assets/SpriteTools.cs

@@ -14,6 +14,8 @@ public static class SpriteTools
     /// Load a sprite from a resource path.
     /// </summary>
     /// <param name="resourcePath">The path to the resource.</param>
+    /// <param name="assembly">The assembly containing the resource.</param>
+    /// <param name="pixelsPerUnit">The pixels per unit for the loaded sprite.</param>
     /// <returns>A sprite made from the resource.</returns>
     /// <exception cref="Exception">The resource cannot be found.</exception>
     public static Sprite LoadSpriteFromPath(string resourcePath, Assembly assembly, float pixelsPerUnit)