deprecate events replaced by save events (#215)

4 files changed, 79 insertions, 12 deletions

diff --git a/src/StardewModdingAPI/Events/PlayerEvents.cs b/src/StardewModdingAPI/Events/PlayerEvents.cs
index 3f301b07..dd3ff220 100644
--- a/src/StardewModdingAPI/Events/PlayerEvents.cs
+++ b/src/StardewModdingAPI/Events/PlayerEvents.cs
@@ -14,9 +14,11 @@ namespace StardewModdingAPI.Events
         ** Events
         *********/
         /// <summary>Raised after the player loads a saved game.</summary>
+        [Obsolete("Use " + nameof(SaveEvents) + "." + nameof(SaveEvents.AfterLoad) + " instead")]
         public static event EventHandler<EventArgsLoadedGameChanged> LoadedGame;
 
         /// <summary>Raised after the game assigns a new player character. This happens just before <see cref="LoadedGame"/>; it's unclear how this would happen any other time.</summary>
+        [Obsolete("should no longer be used")]
         public static event EventHandler<EventArgsFarmerChanged> FarmerChanged;
 
         /// <summary>Raised after the player's inventory changes in any way (added or removed item, sorted, etc).</summary>
@@ -34,7 +36,14 @@ namespace StardewModdingAPI.Events
         /// <param name="loaded">Whether the save has been loaded. This is always true.</param>
         internal static void InvokeLoadedGame(IMonitor monitor, EventArgsLoadedGameChanged loaded)
         {
-            monitor.SafelyRaiseGenericEvent($"{nameof(PlayerEvents)}.{nameof(PlayerEvents.LoadedGame)}", PlayerEvents.LoadedGame?.GetInvocationList(), null, loaded);
+            if (PlayerEvents.LoadedGame == null)
+                return;
+
+            string name = $"{nameof(PlayerEvents)}.{nameof(PlayerEvents.LoadedGame)}";
+            Delegate[] handlers = PlayerEvents.LoadedGame.GetInvocationList();
+
+            Program.DeprecationManager.WarnForEvent(handlers, name, "1.6", DeprecationLevel.Notice);
+            monitor.SafelyRaiseGenericEvent(name, handlers, null, loaded);
         }
 
         /// <summary>Raise a <see cref="FarmerChanged"/> event.</summary>
@@ -43,7 +52,14 @@ namespace StardewModdingAPI.Events
         /// <param name="newFarmer">The new player character.</param>
         internal static void InvokeFarmerChanged(IMonitor monitor, Farmer priorFarmer, Farmer newFarmer)
         {
-            monitor.SafelyRaiseGenericEvent($"{nameof(PlayerEvents)}.{nameof(PlayerEvents.FarmerChanged)}", PlayerEvents.FarmerChanged?.GetInvocationList(), null, new EventArgsFarmerChanged(priorFarmer, newFarmer));
+            if (PlayerEvents.FarmerChanged == null)
+                return;
+
+            string name = $"{nameof(PlayerEvents)}.{nameof(PlayerEvents.FarmerChanged)}";
+            Delegate[] handlers = PlayerEvents.FarmerChanged.GetInvocationList();
+
+            Program.DeprecationManager.WarnForEvent(handlers, name, "1.6", DeprecationLevel.Notice);
+            monitor.SafelyRaiseGenericEvent(name, handlers, null, new EventArgsFarmerChanged(priorFarmer, newFarmer));
         }
 
         /// <summary>Raise an <see cref="InventoryChanged"/> event.</summary>
diff --git a/src/StardewModdingAPI/Events/TimeEvents.cs b/src/StardewModdingAPI/Events/TimeEvents.cs
index 1b367230..dedd7e77 100644
--- a/src/StardewModdingAPI/Events/TimeEvents.cs
+++ b/src/StardewModdingAPI/Events/TimeEvents.cs
@@ -22,6 +22,7 @@ namespace StardewModdingAPI.Events
         public static event EventHandler<EventArgsStringChanged> SeasonOfYearChanged;
 
         /// <summary>Raised when the player is transitioning to a new day and the game is performing its day update logic. This event is triggered twice: once after the game starts transitioning, and again after it finishes.</summary>
+        [Obsolete("Use " + nameof(TimeEvents) + "." + nameof(DayOfMonthChanged) + " or " + nameof(SaveEvents) + " instead")]
         public static event EventHandler<EventArgsNewDay> OnNewDay;
 
 
@@ -71,7 +72,14 @@ namespace StardewModdingAPI.Events
         /// <param name="isTransitioning">Whether the game just started the transition (<c>true</c>) or finished it (<c>false</c>).</param>
         internal static void InvokeOnNewDay(IMonitor monitor, int priorDay, int newDay, bool isTransitioning)
         {
-            monitor.SafelyRaiseGenericEvent($"{nameof(TimeEvents)}.{nameof(TimeEvents.OnNewDay)}", TimeEvents.OnNewDay?.GetInvocationList(), null, new EventArgsNewDay(priorDay, newDay, isTransitioning));
+            if (TimeEvents.OnNewDay == null)
+                return;
+
+            string name = $"{nameof(TimeEvents)}.{nameof(TimeEvents.OnNewDay)}";
+            Delegate[] handlers = TimeEvents.OnNewDay.GetInvocationList();
+
+            Program.DeprecationManager.WarnForEvent(handlers, name, "1.6", DeprecationLevel.Notice);
+            monitor.SafelyRaiseGenericEvent(name, handlers, null, new EventArgsNewDay(priorDay, newDay, isTransitioning));
         }
     }
 }
diff --git a/src/StardewModdingAPI/Framework/InternalExtensions.cs b/src/StardewModdingAPI/Framework/InternalExtensions.cs
index 415785d9..c4bd2d35 100644
--- a/src/StardewModdingAPI/Framework/InternalExtensions.cs
+++ b/src/StardewModdingAPI/Framework/InternalExtensions.cs
@@ -86,5 +86,26 @@ namespace StardewModdingAPI.Framework
             // anything else
             return exception.ToString();
         }
+
+        /****
+        ** Deprecation
+        ****/
+        /// <summary>Log a deprecation warning for mods using an event.</summary>
+        /// <param name="deprecationManager">The deprecation manager to extend.</param>
+        /// <param name="handlers">The event handlers.</param>
+        /// <param name="nounPhrase">A noun phrase describing what is deprecated.</param>
+        /// <param name="version">The SMAPI version which deprecated it.</param>
+        /// <param name="severity">How deprecated the code is.</param>
+        public static void WarnForEvent(this DeprecationManager deprecationManager, Delegate[] handlers, string nounPhrase, string version, DeprecationLevel severity)
+        {
+            if (handlers == null || !handlers.Any())
+                return;
+
+            foreach (Delegate handler in handlers)
+            {
+                string modName = Program.ModRegistry.GetModFrom(handler) ?? "an unknown mod"; // suppress stack trace for unknown mods, not helpful here
+                deprecationManager.Warn(modName, nounPhrase, version, severity);
+            }
+        }
     }
 }
diff --git a/src/StardewModdingAPI/Framework/ModRegistry.cs b/src/StardewModdingAPI/Framework/ModRegistry.cs
index b593142d..51ec7123 100644
--- a/src/StardewModdingAPI/Framework/ModRegistry.cs
+++ b/src/StardewModdingAPI/Framework/ModRegistry.cs
@@ -36,6 +36,34 @@ namespace StardewModdingAPI.Framework
             return (from mod in this.Mods select mod);
         }
 
+        /// <summary>Get the friendly mod name which handles a delegate.</summary>
+        /// <param name="delegate">The delegate to follow.</param>
+        /// <returns>Returns the mod name, or <c>null</c> if the delegate isn't implemented by a known mod.</returns>
+        public string GetModFrom(Delegate @delegate)
+        {
+            return @delegate?.Target != null
+                ? this.GetModFrom(@delegate.Target.GetType())
+                : null;
+        }
+
+        /// <summary>Get the friendly mod name which defines a type.</summary>
+        /// <param name="type">The type to check.</param>
+        /// <returns>Returns the mod name, or <c>null</c> if the type isn't part of a known mod.</returns>
+        public string GetModFrom(Type type)
+        {
+            // null
+            if (type == null)
+                return null;
+
+            // known type
+            string assemblyName = type.Assembly.FullName;
+            if (this.ModNamesByAssembly.ContainsKey(assemblyName))
+                return this.ModNamesByAssembly[assemblyName];
+
+            // not found
+            return null;
+        }
+
         /// <summary>Get the friendly name for the closest assembly registered as a source of deprecation warnings.</summary>
         /// <returns>Returns the source name, or <c>null</c> if no registered assemblies were found.</returns>
         public string GetModFromStack()
@@ -49,16 +77,10 @@ namespace StardewModdingAPI.Framework
             // search stack for a source assembly
             foreach (StackFrame frame in frames)
             {
-                // get assembly name
                 MethodBase method = frame.GetMethod();
-                Type type = method.ReflectedType;
-                if (type == null)
-                    continue;
-                string assemblyName = type.Assembly.FullName;
-
-                // get name if it's a registered source
-                if (this.ModNamesByAssembly.ContainsKey(assemblyName))
-                    return this.ModNamesByAssembly[assemblyName];
+                string name = this.GetModFrom(method.ReflectedType);
+                if (name != null)
+                    return name;
             }
 
             // no known assembly found