add GameLoop events for SMAPI 3.0 (#310)

3 files changed, 73 insertions, 15 deletions

diff --git a/src/SMAPI/Framework/Events/EventManager.cs b/src/SMAPI/Framework/Events/EventManager.cs
index b05d82ce..3d5d0124 100644
--- a/src/SMAPI/Framework/Events/EventManager.cs
+++ b/src/SMAPI/Framework/Events/EventManager.cs
@@ -12,6 +12,33 @@ namespace StardewModdingAPI.Framework.Events
         ** Events (new)
         *********/
         /****
+        ** Game loop
+        ****/
+        /// <summary>Raised after the game is launched, right before the first update tick.</summary>
+        public readonly ManagedEvent<GameLoopLaunchedEventArgs> GameLoop_Launched;
+
+        /// <summary>Raised before the game performs its overall update tick (≈60 times per second).</summary>
+        public readonly ManagedEvent<GameLoopUpdatingEventArgs> GameLoop_Updating;
+
+        /// <summary>Raised after the game performs its overall update tick (≈60 times per second).</summary>
+        public readonly ManagedEvent<GameLoopUpdatedEventArgs> GameLoop_Updated;
+
+        /****
+        ** Input
+        ****/
+        /// <summary>Raised after the player presses a button on the keyboard, controller, or mouse.</summary>
+        public readonly ManagedEvent<InputButtonPressedArgsInput> Input_ButtonPressed;
+
+        /// <summary>Raised after the player released a button on the keyboard, controller, or mouse.</summary>
+        public readonly ManagedEvent<InputButtonReleasedArgsInput> Input_ButtonReleased;
+
+        /// <summary>Raised after the player moves the in-game cursor.</summary>
+        public readonly ManagedEvent<InputCursorMovedArgsInput> Input_CursorMoved;
+
+        /// <summary>Raised after the player scrolls the mouse wheel.</summary>
+        public readonly ManagedEvent<InputMouseWheelScrolledEventArgs> Input_MouseWheelScrolled;
+
+        /****
         ** World
         ****/
         /// <summary>Raised after a game location is added or removed.</summary>
@@ -35,21 +62,6 @@ namespace StardewModdingAPI.Framework.Events
         /// <summary>Raised after terrain features (like floors and trees) are added or removed in a location.</summary>
         public readonly ManagedEvent<WorldTerrainFeatureListChangedEventArgs> World_TerrainFeatureListChanged;
 
-        /****
-        ** Input
-        ****/
-        /// <summary>Raised after the player presses a button on the keyboard, controller, or mouse.</summary>
-        public readonly ManagedEvent<InputButtonPressedArgsInput> Input_ButtonPressed;
-
-        /// <summary>Raised after the player released a button on the keyboard, controller, or mouse.</summary>
-        public readonly ManagedEvent<InputButtonReleasedArgsInput> Input_ButtonReleased;
-
-        /// <summary>Raised after the player moves the in-game cursor.</summary>
-        public readonly ManagedEvent<InputCursorMovedArgsInput> Input_CursorMoved;
-
-        /// <summary>Raised after the player scrolls the mouse wheel.</summary>
-        public readonly ManagedEvent<InputMouseWheelScrolledEventArgs> Input_MouseWheelScrolled;
-
 
         /*********
         ** Events (old)
@@ -252,6 +264,9 @@ namespace StardewModdingAPI.Framework.Events
             ManagedEvent ManageEvent(string typeName, string eventName) => new ManagedEvent($"{typeName}.{eventName}", monitor, modRegistry);
 
             // init events (new)
+            this.GameLoop_Updating = ManageEventOf<GameLoopUpdatingEventArgs>(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.Updating));
+            this.GameLoop_Updated = ManageEventOf<GameLoopUpdatedEventArgs>(nameof(IModEvents.GameLoop), nameof(IGameLoopEvents.Updated));
+
             this.Input_ButtonPressed = ManageEventOf<InputButtonPressedArgsInput>(nameof(IModEvents.Input), nameof(IInputEvents.ButtonPressed));
             this.Input_ButtonReleased = ManageEventOf<InputButtonReleasedArgsInput>(nameof(IModEvents.Input), nameof(IInputEvents.ButtonReleased));
             this.Input_CursorMoved = ManageEventOf<InputCursorMovedArgsInput>(nameof(IModEvents.Input), nameof(IInputEvents.CursorMoved));
diff --git a/src/SMAPI/Framework/Events/ModEvents.cs b/src/SMAPI/Framework/Events/ModEvents.cs
index 90853141..9e474457 100644
--- a/src/SMAPI/Framework/Events/ModEvents.cs
+++ b/src/SMAPI/Framework/Events/ModEvents.cs
@@ -8,6 +8,9 @@ namespace StardewModdingAPI.Framework.Events
         /*********
         ** Accessors
         *********/
+        /// <summary>Events linked to the game's update loop. The update loop runs roughly ≈60 times/second to run game logic like state changes, action handling, etc. These can be useful, but you should consider more semantic events like <see cref="IModEvents.Input"/> if possible.</summary>
+        public IGameLoopEvents GameLoop { get; }
+
         /// <summary>Events raised when the player provides input using a controller, keyboard, or mouse.</summary>
         public IInputEvents Input { get; }
 
@@ -23,6 +26,7 @@ namespace StardewModdingAPI.Framework.Events
         /// <param name="eventManager">The underlying event manager.</param>
         public ModEvents(IModMetadata mod, EventManager eventManager)
         {
+            this.GameLoop = new ModGameLoopEvents(mod, eventManager);
             this.Input = new ModInputEvents(mod, eventManager);
             this.World = new ModWorldEvents(mod, eventManager);
         }
diff --git a/src/SMAPI/Framework/Events/ModGameLoopEvents.cs b/src/SMAPI/Framework/Events/ModGameLoopEvents.cs
new file mode 100644
index 00000000..1a142b0f
--- /dev/null
+++ b/src/SMAPI/Framework/Events/ModGameLoopEvents.cs
@@ -0,0 +1,39 @@
+using System;
+using StardewModdingAPI.Events;
+
+namespace StardewModdingAPI.Framework.Events
+{
+    /// <summary>Events linked to the game's update loop. The update loop runs roughly ≈60 times/second to run game logic like state changes, action handling, etc. These can be useful, but you should consider more semantic events like <see cref="IInputEvents"/> if possible.</summary>
+    internal class ModGameLoopEvents : ModEventsBase, IGameLoopEvents
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>Raised after the game is launched, right before the first update tick.</summary>
+        public event EventHandler<GameLoopLaunchedEventArgs> Launched;
+
+        /// <summary>Raised before the game performs its overall update tick (≈60 times per second).</summary>
+        public event EventHandler<GameLoopUpdatingEventArgs> Updating
+        {
+            add => this.EventManager.GameLoop_Updating.Add(value);
+            remove => this.EventManager.GameLoop_Updating.Remove(value);
+        }
+
+        /// <summary>Raised after the game performs its overall update tick (≈60 times per second).</summary>
+        public event EventHandler<GameLoopUpdatedEventArgs> Updated
+        {
+            add => this.EventManager.GameLoop_Updated.Add(value);
+            remove => this.EventManager.GameLoop_Updated.Remove(value);
+        }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="mod">The mod which uses this instance.</param>
+        /// <param name="eventManager">The underlying event manager.</param>
+        internal ModGameLoopEvents(IModMetadata mod, EventManager eventManager)
+            : base(mod, eventManager) { }
+    }
+}