From e14916f9622592a993fad54fe184a03de0b95c7b Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Wed, 11 May 2022 17:12:58 -0400
Subject: add error code to SContentLoadException

---
 .../Framework/Exceptions/ContentLoadErrorType.cs    | 21 +++++++++++++++++++++
 .../Framework/Exceptions/SContentLoadException.cs   | 15 +++++++++++++--
 2 files changed, 34 insertions(+), 2 deletions(-)
 create mode 100644 src/SMAPI/Framework/Exceptions/ContentLoadErrorType.cs

(limited to 'src/SMAPI/Framework/Exceptions')

diff --git a/src/SMAPI/Framework/Exceptions/ContentLoadErrorType.cs b/src/SMAPI/Framework/Exceptions/ContentLoadErrorType.cs
new file mode 100644
index 00000000..16689b67
--- /dev/null
+++ b/src/SMAPI/Framework/Exceptions/ContentLoadErrorType.cs
@@ -0,0 +1,21 @@
+namespace StardewModdingAPI.Framework.Exceptions
+{
+    /// <summary>Indicates why loading an asset through the content pipeline failed.</summary>
+    internal enum ContentLoadErrorType
+    {
+        /// <summary>The asset name is empty or has an invalid format.</summary>
+        InvalidName,
+
+        /// <summary>The asset doesn't exist.</summary>
+        AssetDoesNotExist,
+
+        /// <summary>The asset is not available in the current context (e.g. an attempt to load another mod's assets).</summary>
+        AccessDenied,
+
+        /// <summary>The asset exists, but the data could not be deserialized or it doesn't match the expected type.</summary>
+        InvalidData,
+
+        /// <summary>An unknown error occurred.</summary>
+        Other
+    }
+}
diff --git a/src/SMAPI/Framework/Exceptions/SContentLoadException.cs b/src/SMAPI/Framework/Exceptions/SContentLoadException.cs
index be1fe748..4db24d06 100644
--- a/src/SMAPI/Framework/Exceptions/SContentLoadException.cs
+++ b/src/SMAPI/Framework/Exceptions/SContentLoadException.cs
@@ -6,13 +6,24 @@ namespace StardewModdingAPI.Framework.Exceptions
     /// <summary>An implementation of <see cref="ContentLoadException"/> used by SMAPI to detect whether it was thrown by SMAPI or the underlying framework.</summary>
     internal class SContentLoadException : ContentLoadException
     {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Why loading the asset through the content pipeline failed.</summary>
+        public ContentLoadErrorType ErrorType { get; }
+
+
         /*********
         ** Public methods
         *********/
         /// <summary>Construct an instance.</summary>
+        /// <param name="errorType">Why loading the asset through the content pipeline failed.</param>
         /// <param name="message">The error message.</param>
         /// <param name="ex">The underlying exception, if any.</param>
-        public SContentLoadException(string message, Exception? ex = null)
-            : base(message, ex) { }
+        public SContentLoadException(ContentLoadErrorType errorType, string message, Exception? ex = null)
+            : base(message, ex)
+        {
+            this.ErrorType = errorType;
+        }
     }
 }
-- 
cgit