From 7e280a066db92c74e957e2a694c922d4c3eae017 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 19 Jan 2021 21:47:05 -0500
Subject: add Input.ButtonsChanged event (#744)

---
 src/SMAPI/Events/ButtonsChangedEventArgs.cs | 67 +++++++++++++++++++++++++++++
 src/SMAPI/Events/IInputEvents.cs            |  3 ++
 2 files changed, 70 insertions(+)
 create mode 100644 src/SMAPI/Events/ButtonsChangedEventArgs.cs

(limited to 'src/SMAPI/Events')

diff --git a/src/SMAPI/Events/ButtonsChangedEventArgs.cs b/src/SMAPI/Events/ButtonsChangedEventArgs.cs
new file mode 100644
index 00000000..dda41692
--- /dev/null
+++ b/src/SMAPI/Events/ButtonsChangedEventArgs.cs
@@ -0,0 +1,67 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using StardewModdingAPI.Framework.Input;
+
+namespace StardewModdingAPI.Events
+{
+    /// <summary>Event arguments when any buttons were pressed or released.</summary>
+    public class ButtonsChangedEventArgs : EventArgs
+    {
+        /*********
+        ** Fields
+        *********/
+        /// <summary>The buttons that were pressed, held, or released since the previous tick.</summary>
+        private readonly Lazy<Dictionary<SButtonState, SButton[]>> ButtonsByState;
+
+
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The current cursor position.</summary>
+        public ICursorPosition Cursor { get; }
+
+        /// <summary>The buttons which were pressed since the previous tick.</summary>
+        public IEnumerable<SButton> Pressed => this.ButtonsByState.Value[SButtonState.Pressed];
+
+        /// <summary>The buttons which were held since the previous tick.</summary>
+        public IEnumerable<SButton> Held => this.ButtonsByState.Value[SButtonState.Held];
+
+        /// <summary>The buttons which were released since the previous tick.</summary>
+        public IEnumerable<SButton> Released => this.ButtonsByState.Value[SButtonState.Released];
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="cursor">The cursor position.</param>
+        /// <param name="inputState">The game's current input state.</param>
+        internal ButtonsChangedEventArgs(ICursorPosition cursor, SInputState inputState)
+        {
+            this.Cursor = cursor;
+            this.ButtonsByState = new Lazy<Dictionary<SButtonState, SButton[]>>(() => this.GetButtonsByState(inputState));
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get the buttons that were pressed, held, or released since the previous tick.</summary>
+        /// <param name="inputState">The game's current input state.</param>
+        private Dictionary<SButtonState, SButton[]> GetButtonsByState(SInputState inputState)
+        {
+            Dictionary<SButtonState, SButton[]> lookup = inputState.ButtonStates
+                .GroupBy(p => p.Value)
+                .ToDictionary(p => p.Key, p => p.Select(p => p.Key).ToArray());
+
+            foreach (var state in new[] { SButtonState.Pressed, SButtonState.Held, SButtonState.Released })
+            {
+                if (!lookup.ContainsKey(state))
+                    lookup[state] = new SButton[0];
+            }
+
+            return lookup;
+        }
+    }
+}
diff --git a/src/SMAPI/Events/IInputEvents.cs b/src/SMAPI/Events/IInputEvents.cs
index 5c40a438..081c40c0 100644
--- a/src/SMAPI/Events/IInputEvents.cs
+++ b/src/SMAPI/Events/IInputEvents.cs
@@ -5,6 +5,9 @@ namespace StardewModdingAPI.Events
     /// <summary>Events raised when the player provides input using a controller, keyboard, or mouse.</summary>
     public interface IInputEvents
     {
+        /// <summary>Raised after the player presses or releases any buttons on the keyboard, controller, or mouse.</summary>
+        event EventHandler<ButtonsChangedEventArgs> ButtonsChanged;
+
         /// <summary>Raised after the player presses a button on the keyboard, controller, or mouse.</summary>
         event EventHandler<ButtonPressedEventArgs> ButtonPressed;
 
-- 
cgit