summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IMonitor.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/IMonitor.cs')
-rw-r--r--src/StardewModdingAPI/IMonitor.cs25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/IMonitor.cs b/src/StardewModdingAPI/IMonitor.cs
new file mode 100644
index 00000000..62c479bc
--- /dev/null
+++ b/src/StardewModdingAPI/IMonitor.cs
@@ -0,0 +1,25 @@
+namespace StardewModdingAPI
+{
+ /// <summary>Encapsulates monitoring and logging for a given module.</summary>
+ public interface IMonitor
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>Whether SMAPI is aborting. Mods don't need to worry about this unless they have background tasks.</summary>
+ bool IsExiting { get; }
+
+
+ /*********
+ ** Methods
+ *********/
+ /// <summary>Log a message for the player or developer.</summary>
+ /// <param name="message">The message to log.</param>
+ /// <param name="level">The log severity level.</param>
+ void Log(string message, LogLevel level = LogLevel.Debug);
+
+ /// <summary>Immediately exit the game without saving. This should only be invoked when an irrecoverable fatal error happens that risks save corruption or game-breaking bugs.</summary>
+ /// <param name="reason">The reason for the shutdown.</param>
+ void ExitGameImmediately(string reason);
+ }
+}