[ProcTypeAPI] Mirror DamageAPI changes to bounds check (#587)

risk-of-thunder · Jan 25, 2025 · de90674 · de90674
1 parent 150eb3e
commit de90674
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 9 deletions.
diff --git a/R2API.ProcType/ModdedProcType.cs b/R2API.ProcType/ModdedProcType.cs
@@ -15,5 +15,5 @@ public enum ModdedProcType : int
     /// Represents an invalid value of <see cref="ModdedProcType"/>.
     /// </summary>
     /// <remarks>All negative values of <see cref="ModdedProcType"/> are considered invalid.</remarks>
-    Invalid = -1
+    Invalid = 0
 }
diff --git a/R2API.ProcType/ProcTypeAPI.cs b/R2API.ProcType/ProcTypeAPI.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Runtime.CompilerServices;
 using System.Text;
 using HG;
@@ -64,7 +65,9 @@ public static ModdedProcType ReserveProcType()
         {
             throw new IndexOutOfRangeException($"Reached the ModdedProcType limit ({int.MaxValue})! Please contact R2API developers to increase the limit");
         }
-        return (ModdedProcType)ModdedProcTypeCount++;
+
+        ModdedProcTypeCount++;
+        return (ModdedProcType)ModdedProcTypeCount;
     }
 
     /// <summary>
@@ -73,13 +76,16 @@ public static ModdedProcType ReserveProcType()
     /// <exception cref="ArgumentOutOfRangeException"><paramref name="procType"/> is invalid</exception>
     public static void AddModdedProc(ref this ProcChainMask procChainMask, ModdedProcType procType)
     {
-        if (procType <= ModdedProcType.Invalid || (int)procType >= ModdedProcTypeCount)
+        if (procType <= ModdedProcType.Invalid || (int)procType > ModdedProcTypeCount)
         {
-            throw new ArgumentOutOfRangeException(nameof(procType));
+            ProcTypePlugin.Logger.LogError($"Parameter '{nameof(procType)}' with value {procType} is out of range of registered types (1-{ModdedProcTypeCount})\n{new StackTrace(true)}");
+            return;
         }
 
         SetHooks();
 
+        procType--;
+
         byte[] mask = ProcTypeInterop.GetModdedMask(procChainMask);
         byte[] value;
         int i = (int)procType >> 3;
@@ -115,12 +121,16 @@ public static void AddModdedProc(ref this ProcChainMask procChainMask, ModdedPro
     /// <exception cref="ArgumentOutOfRangeException"><paramref name="procType"/> is invalid</exception>
     public static void RemoveModdedProc(ref this ProcChainMask procChainMask, ModdedProcType procType)
     {
-        if (procType <= ModdedProcType.Invalid || (int)procType >= ModdedProcTypeCount)
+        if (procType <= ModdedProcType.Invalid || (int)procType > ModdedProcTypeCount)
         {
-            throw new ArgumentOutOfRangeException(nameof(procType));
+            ProcTypePlugin.Logger.LogError($"Parameter '{nameof(procType)}' with value {procType} is out of range of registered types (1-{ModdedProcTypeCount})\n{new StackTrace(true)}");
+            return;
         }
 
         SetHooks();
+
+        procType--;
+
         byte[] mask = ProcTypeInterop.GetModdedMask(procChainMask);
         if (mask == null)
         {
@@ -178,11 +188,14 @@ public static void RemoveModdedProc(ref this ProcChainMask procChainMask, Modded
     public static bool HasModdedProc(this ProcChainMask procChainMask, ModdedProcType procType)
 #pragma warning restore R2APISubmodulesAnalyzer // Public API Method is not enabling the hooks if needed.
     {
-        if (procType <= ModdedProcType.Invalid || (int)procType >= ModdedProcTypeCount)
+        if (procType <= ModdedProcType.Invalid || (int)procType > ModdedProcTypeCount)
         {
-            throw new ArgumentOutOfRangeException(nameof(procType));
+            ProcTypePlugin.Logger.LogError($"Parameter '{nameof(procType)}' with value {procType} is out of range of registered types (1-{ModdedProcTypeCount})\n{new StackTrace(true)}");
+            return false;
         }
 
+        procType--;
+
         byte[] mask = ProcTypeInterop.GetModdedMask(procChainMask);
         if (mask == null)
         {

diff --git a/R2API.ProcType/README.md b/R2API.ProcType/README.md
@@ -14,6 +14,9 @@ R2API.ProcType patches RoR2.ProcChainMask to store additional data and this data
 
 ## Changelog
 
+### '1.0.2'
+* Changed bounds check and minimum proc type value to make it easier to notice when using unregistered proc type.
+
 ### '1.0.1'
 * Fix NuGet package
 

diff --git a/R2API.ProcType/thunderstore.toml b/R2API.ProcType/thunderstore.toml
@@ -5,7 +5,7 @@ schemaVersion = "0.0.1"
 [package]
 namespace = "RiskofThunder"
 name = "R2API_ProcType"
-versionNumber = "1.0.1"
+versionNumber = "1.0.2"
 description = "API for registering proc types"
 websiteUrl = "https://github.com/risk-of-thunder/R2API"
 containsNsfwContent = false