Better handling of invalid data

Author: ManlyMarco

Core_SkinEffects/SkinEffectKind.cs

@@ -8,7 +8,7 @@ namespace KK_SkinEffects
     /// <summary>
     /// List of all effect texture kinds. The values and names are important and should not be changed.
     /// Names are used for resource lookup, effect textures should have the same name as the enum value + a number that represents the level (e.g. WetBody_01).
-    /// Values are used for indexing and should not be changed or some saved data might become misaligned. Values must be sequential starting from 0.
+    /// Values are used for indexing and should not be changed or some saved data might become misaligned. Values must be sequential starting from 0. Higher value effect texture is overlayed above lower ones.
     /// Description is used only for display names and can be changed.
     /// AffectsBody / AffectsFace attributes are used to determine where the effect should be applied, only one can be used.
     /// </summary>
@@ -50,5 +50,7 @@ static SkinEffectKindUtils()
         public static string ToDataKey(this SkinEffectKind kind) => ((int)kind).ToDataKey();
         public static string ToDataKey(this int id) => id.ToString("D", CultureInfo.InvariantCulture);
         public static string GetDisplayName(this SkinEffectKind kind) => kind.GetAttributeOfType<DescriptionAttribute>()?.Description ?? kind.ToString();
+
+        public static bool IsValidKind(this SkinEffectKind kind) => kind >= 0 && (int)kind < ValidSkinEffectKinds.Length;
     }
 }

Core_SkinEffects/SkinEffectsController.cs

@@ -39,8 +39,9 @@ public class SkinEffectsController : CharaCustomFunctionController
         /// </summary>
         public int GetEffectLevel(SkinEffectKind kind)
         {
-            // todo throw instead?
-            if (kind < 0 || (int)kind >= SkinEffectKindUtils.ValidSkinEffectKinds.Length) return -1;
+            if (!kind.IsValidKind())
+                throw new ArgumentException($"Invalid effect kind: {kind}", nameof(kind));
+
             return _effectLevels[(int)kind];
         }
 
@@ -49,8 +50,8 @@ public int GetEffectLevel(SkinEffectKind kind)
         /// </summary>
         public bool SetEffectLevel(SkinEffectKind kind, int level, bool updateEffects)
         {
-            // todo throw instead?
-            if (kind < 0 || (int)kind >= SkinEffectKindUtils.ValidSkinEffectKinds.Length) return false;
+            if (!kind.IsValidKind())
+                return false;
 
             level = Mathf.Clamp(level, 0, TextureLoader.GetTextureCount(kind));
 
@@ -352,6 +353,7 @@ public void ApplyCharaState(IDictionary<string, object> dataDict, bool onlyCusto
             if (dataDict != null && dataDict.Count > 0)
             {
                 var newLevels = ReadEffectLevelsFromData(dataDict);
+                TextureLoader.ClampEffectLevelArray(newLevels);
                 if (newLevels.Any(x => x > 0)) needsUpdate = true;
                 _effectLevels = newLevels;
 

Core_SkinEffects/TextureLoader.cs

@@ -43,8 +43,11 @@ static TextureLoader()
 
         public static int GetTextureCount(SkinEffectKind kind)
         {
-            if (kind < 0)
+            if (kind < 0 || (int)kind >= _resources.Length)
+            {
+                SkinEffectsPlugin.Logger.LogError($"Invalid effect kind: {kind}\n{new StackTrace()}");
                 return 0;
+            }
 
             return _resources[(int)kind].Length;
         }
@@ -62,6 +65,9 @@ private static Texture2D[] GetTextures(string[] resourceNames)
 
         public static Texture2D[] GetTextures(SkinEffectKind kind)
         {
+            if (kind < 0 || (int)kind >= _resources.Length)
+                throw new ArgumentException($"Invalid effect kind: {kind}", nameof(kind));
+
             if (_textures[(int)kind] == null)
             {
                 var newTextures = GetTextures(_resources[(int)kind]);
@@ -78,9 +84,12 @@ public static Texture2D[] GetTextures(SkinEffectKind kind)
         public static Texture2D GetTexture(SkinEffectKind kind, int level)
         {
             var textures = GetTextures(kind);
-            if (level < 0 || level >= textures.Length)
-                return null;
-            return textures[level];
+            if (level < 0)
+                return textures[0];
+            else if (level >= textures.Length)
+                return textures.Last();
+            else
+                return textures[level];
         }
 
         public static void PreloadAllTextures()
@@ -109,5 +118,14 @@ public static void PreloadMainGameTextures()
 
             SkinEffectsPlugin.Logger.LogDebug($"{nameof(PreloadMainGameTextures)} finished in {sw.ElapsedMilliseconds}ms");
         }
+
+        public static void ClampEffectLevelArray(int[] effectLevels)
+        {
+            if (effectLevels.Length > _resources.Length)
+                Array.Resize(ref effectLevels, _resources.Length);
+
+            for (int i = 0; i < effectLevels.Length; i++)
+                effectLevels[i] = Mathf.Clamp(effectLevels[i], 0, _resources[i].Length);
+        }
     }
 }