summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/GameEvents.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/Events/GameEvents.cs')
-rw-r--r--src/SMAPI/Events/GameEvents.cs57
1 files changed, 48 insertions, 9 deletions
diff --git a/src/SMAPI/Events/GameEvents.cs b/src/SMAPI/Events/GameEvents.cs
index 952b3570..13f6bfb0 100644
--- a/src/SMAPI/Events/GameEvents.cs
+++ b/src/SMAPI/Events/GameEvents.cs
@@ -1,9 +1,11 @@
using System;
+using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Events;
namespace StardewModdingAPI.Events
{
/// <summary>Events raised when the game changes state.</summary>
+ [Obsolete("Use " + nameof(Mod.Helper) + "." + nameof(IModHelper.Events) + " instead. See https://smapi.io/3.0 for more info.")]
public static class GameEvents
{
/*********
@@ -12,6 +14,9 @@ namespace StardewModdingAPI.Events
/// <summary>The core event manager.</summary>
private static EventManager EventManager;
+ /// <summary>Manages deprecation warnings.</summary>
+ private static DeprecationManager DeprecationManager;
+
/*********
** Events
@@ -19,56 +24,88 @@ namespace StardewModdingAPI.Events
/// <summary>Raised when the game updates its state (≈60 times per second).</summary>
public static event EventHandler UpdateTick
{
- add => GameEvents.EventManager.Legacy_UpdateTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_UpdateTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_UpdateTick.Remove(value);
}
/// <summary>Raised every other tick (≈30 times per second).</summary>
public static event EventHandler SecondUpdateTick
{
- add => GameEvents.EventManager.Legacy_SecondUpdateTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_SecondUpdateTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_SecondUpdateTick.Remove(value);
}
/// <summary>Raised every fourth tick (≈15 times per second).</summary>
public static event EventHandler FourthUpdateTick
{
- add => GameEvents.EventManager.Legacy_FourthUpdateTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_FourthUpdateTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_FourthUpdateTick.Remove(value);
}
/// <summary>Raised every eighth tick (≈8 times per second).</summary>
public static event EventHandler EighthUpdateTick
{
- add => GameEvents.EventManager.Legacy_EighthUpdateTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_EighthUpdateTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_EighthUpdateTick.Remove(value);
}
/// <summary>Raised every 15th tick (≈4 times per second).</summary>
public static event EventHandler QuarterSecondTick
{
- add => GameEvents.EventManager.Legacy_QuarterSecondTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_QuarterSecondTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_QuarterSecondTick.Remove(value);
}
/// <summary>Raised every 30th tick (≈twice per second).</summary>
public static event EventHandler HalfSecondTick
{
- add => GameEvents.EventManager.Legacy_HalfSecondTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_HalfSecondTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_HalfSecondTick.Remove(value);
}
/// <summary>Raised every 60th tick (≈once per second).</summary>
public static event EventHandler OneSecondTick
{
- add => GameEvents.EventManager.Legacy_OneSecondTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_OneSecondTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_OneSecondTick.Remove(value);
}
/// <summary>Raised once after the game initialises and all <see cref="IMod.Entry"/> methods have been called.</summary>
public static event EventHandler FirstUpdateTick
{
- add => GameEvents.EventManager.Legacy_FirstUpdateTick.Add(value);
+ add
+ {
+ GameEvents.DeprecationManager.WarnForOldEvents();
+ GameEvents.EventManager.Legacy_FirstUpdateTick.Add(value);
+ }
remove => GameEvents.EventManager.Legacy_FirstUpdateTick.Remove(value);
}
@@ -78,9 +115,11 @@ namespace StardewModdingAPI.Events
*********/
/// <summary>Initialise the events.</summary>
/// <param name="eventManager">The core event manager.</param>
- internal static void Init(EventManager eventManager)
+ /// <param name="deprecationManager">Manages deprecation warnings.</param>
+ internal static void Init(EventManager eventManager, DeprecationManager deprecationManager)
{
GameEvents.EventManager = eventManager;
+ GameEvents.DeprecationManager = deprecationManager;
}
}
}