From 29fdf9ae4a91131f758035ab79fbfe0595ff1eca Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 8 Mar 2020 11:45:55 -0400 Subject: rework input handling to allow sending custom input to the game/mods That will let Virtual Keyboard on Android work with the future multi-key binding API, and with mods that check input state directly (e.g. Pathoschild/StardewMods#520). It might also be useful as a public API in future versions. --- src/SMAPI/Framework/Input/SInputState.cs | 232 +++++++++++++++++-------------- 1 file changed, 125 insertions(+), 107 deletions(-) (limited to 'src/SMAPI/Framework/Input/SInputState.cs') diff --git a/src/SMAPI/Framework/Input/SInputState.cs b/src/SMAPI/Framework/Input/SInputState.cs index 4eaa9ca6..06a7ac3b 100644 --- a/src/SMAPI/Framework/Input/SInputState.cs +++ b/src/SMAPI/Framework/Input/SInputState.cs @@ -23,37 +23,34 @@ namespace StardewModdingAPI.Framework.Input /// The player's last known tile position. private Vector2? LastPlayerTile; + /// The buttons to press until the game next handles input. + private readonly HashSet CustomPressedKeys = new HashSet(); + + /// The buttons to consider released until the actual button is released. + private readonly HashSet CustomReleasedKeys = new HashSet(); + + /// The buttons which were actually down as of the last update, ignoring overrides. + private HashSet LastRealButtonPresses = new HashSet(); + /********* ** Accessors *********/ /// The controller state as of the last update. - public GamePadState RealController { get; private set; } + public GamePadState LastController { get; private set; } /// The keyboard state as of the last update. - public KeyboardState RealKeyboard { get; private set; } + public KeyboardState LastKeyboard { get; private set; } /// The mouse state as of the last update. - public MouseState RealMouse { get; private set; } - - /// A derivative of which suppresses the buttons in . - public GamePadState SuppressedController { get; private set; } - - /// A derivative of which suppresses the buttons in . - public KeyboardState SuppressedKeyboard { get; private set; } + public MouseState LastMouse { get; private set; } - /// A derivative of which suppresses the buttons in . - public MouseState SuppressedMouse { get; private set; } + /// The buttons which were pressed, held, or released as of the last update. + public IDictionary LastButtonStates { get; private set; } = new Dictionary(); /// The cursor position on the screen adjusted for the zoom level. public ICursorPosition CursorPosition => this.CursorPositionImpl; - /// The buttons which were pressed, held, or released. - public IDictionary ActiveButtons { get; private set; } = new Dictionary(); - - /// The buttons to suppress when the game next handles input. Each button is suppressed until it's released. - public HashSet SuppressButtons { get; } = new HashSet(); - /********* ** Public methods @@ -63,14 +60,38 @@ namespace StardewModdingAPI.Framework.Input { return new SInputState { - ActiveButtons = this.ActiveButtons, - RealController = this.RealController, - RealKeyboard = this.RealKeyboard, - RealMouse = this.RealMouse, + LastButtonStates = this.LastButtonStates, + LastController = this.LastController, + LastKeyboard = this.LastKeyboard, + LastMouse = this.LastMouse, CursorPositionImpl = this.CursorPositionImpl }; } + /// Override the state for a button. + /// The button to override. + /// Whether to mark it pressed; else mark it released. + public void OverrideButton(SButton button, bool setDown) + { + if (setDown) + { + this.CustomPressedKeys.Add(button); + this.CustomReleasedKeys.Remove(button); + } + else + { + this.CustomPressedKeys.Remove(button); + this.CustomReleasedKeys.Add(button); + } + } + + /// Get whether a mod has indicated the key was already handled, so the game shouldn't handle it. + /// The button to check. + public bool IsSuppressed(SButton button) + { + return this.CustomReleasedKeys.Contains(button); + } + /// This method is called by the game, and does nothing since SMAPI will already have updated by that point. [Obsolete("This method should only be called by the game itself.")] public override void Update() { } @@ -82,28 +103,47 @@ namespace StardewModdingAPI.Framework.Input { float zoomMultiplier = (1f / Game1.options.zoomLevel); - // get new states - GamePadState realController = GamePad.GetState(PlayerIndex.One); - KeyboardState realKeyboard = Keyboard.GetState(); - MouseState realMouse = Mouse.GetState(); - var activeButtons = this.DeriveStates(this.ActiveButtons, realKeyboard, realMouse, realController); - Vector2 cursorAbsolutePos = new Vector2((realMouse.X * zoomMultiplier) + Game1.viewport.X, (realMouse.Y * zoomMultiplier) + Game1.viewport.Y); + // get real values + GamePadState controller = GamePad.GetState(PlayerIndex.One); + KeyboardState keyboard = Keyboard.GetState(); + MouseState mouse = Mouse.GetState(); + Vector2 cursorAbsolutePos = new Vector2((mouse.X * zoomMultiplier) + Game1.viewport.X, (mouse.Y * zoomMultiplier) + Game1.viewport.Y); Vector2? playerTilePos = Context.IsPlayerFree ? Game1.player.getTileLocation() : (Vector2?)null; + HashSet reallyDown = new HashSet(this.GetPressedButtons(keyboard, mouse, controller)); - // update real states - this.ActiveButtons = activeButtons; - this.RealController = realController; - this.RealKeyboard = realKeyboard; - this.RealMouse = realMouse; + // apply overrides + bool hasOverrides = false; + if (this.CustomPressedKeys.Count > 0 || this.CustomReleasedKeys.Count > 0) + { + // reset overrides that no longer apply + this.CustomPressedKeys.RemoveWhere(key => reallyDown.Contains(key)); + this.CustomReleasedKeys.RemoveWhere(key => !reallyDown.Contains(key)); + + // apply overrides + if (this.ApplyOverrides(this.CustomPressedKeys, this.CustomReleasedKeys, ref keyboard, ref mouse, ref controller)) + hasOverrides = true; + + // remove pressed keys + this.CustomPressedKeys.Clear(); + } + + // get button states + var pressedButtons = hasOverrides + ? new HashSet(this.GetPressedButtons(keyboard, mouse, controller)) + : reallyDown; + var activeButtons = this.DeriveStates(this.LastButtonStates, pressedButtons, keyboard, mouse, controller); + + // update + this.LastController = controller; + this.LastKeyboard = keyboard; + this.LastMouse = mouse; + this.LastButtonStates = activeButtons; + this.LastRealButtonPresses = reallyDown; if (cursorAbsolutePos != this.CursorPositionImpl?.AbsolutePixels || playerTilePos != this.LastPlayerTile) { this.LastPlayerTile = playerTilePos; - this.CursorPositionImpl = this.GetCursorPosition(realMouse, cursorAbsolutePos, zoomMultiplier); + this.CursorPositionImpl = this.GetCursorPosition(mouse, cursorAbsolutePos, zoomMultiplier); } - - // update suppressed states - this.SuppressButtons.RemoveWhere(p => !this.GetState(activeButtons, p).IsDown()); - this.UpdateSuppression(); } catch (InvalidOperationException) { @@ -111,18 +151,18 @@ namespace StardewModdingAPI.Framework.Input } } - /// Apply input suppression to current input. - public void UpdateSuppression() + /// Apply input overrides to the current state. + public void ApplyOverrides() { - GamePadState suppressedController = this.RealController; - KeyboardState suppressedKeyboard = this.RealKeyboard; - MouseState suppressedMouse = this.RealMouse; + GamePadState newController = this.LastController; + KeyboardState newKeyboard = this.LastKeyboard; + MouseState newMouse = this.LastMouse; - this.SuppressGivenStates(this.ActiveButtons, ref suppressedKeyboard, ref suppressedMouse, ref suppressedController); + this.ApplyOverrides(pressed: this.CustomPressedKeys, released: this.CustomReleasedKeys, ref newKeyboard, ref newMouse, ref newController); - this.SuppressedController = suppressedController; - this.SuppressedKeyboard = suppressedKeyboard; - this.SuppressedMouse = suppressedMouse; + this.LastController = newController; + this.LastKeyboard = newKeyboard; + this.LastMouse = newMouse; } /// Get the gamepad state visible to the game. @@ -130,36 +170,30 @@ namespace StardewModdingAPI.Framework.Input public override GamePadState GetGamePadState() { if (Game1.options.gamepadMode == Options.GamepadModes.ForceOff) - return base.GetGamePadState(); + return new GamePadState(); - return this.ShouldSuppressNow() - ? this.SuppressedController - : this.RealController; + return this.LastController; } /// Get the keyboard state visible to the game. [Obsolete("This method should only be called by the game itself.")] public override KeyboardState GetKeyboardState() { - return this.ShouldSuppressNow() - ? this.SuppressedKeyboard - : this.RealKeyboard; + return this.LastKeyboard; } /// Get the keyboard state visible to the game. [Obsolete("This method should only be called by the game itself.")] public override MouseState GetMouseState() { - return this.ShouldSuppressNow() - ? this.SuppressedMouse - : this.RealMouse; + return this.LastMouse; } /// Get whether a given button was pressed or held. /// The button to check. public bool IsDown(SButton button) { - return this.GetState(this.ActiveButtons, button).IsDown(); + return this.GetState(this.LastButtonStates, button).IsDown(); } /// Get whether any of the given buttons were pressed or held. @@ -173,7 +207,7 @@ namespace StardewModdingAPI.Framework.Input /// The button to check. public SButtonState GetState(SButton button) { - return this.GetState(this.ActiveButtons, button); + return this.GetState(this.LastButtonStates, button); } @@ -194,76 +228,60 @@ namespace StardewModdingAPI.Framework.Input return new CursorPosition(absolutePixels, screenPixels, tile, grabTile); } - /// Whether input should be suppressed in the current context. - private bool ShouldSuppressNow() - { - return Game1.chatBox == null || !Game1.chatBox.isActive(); - } - - /// Apply input suppression to the given input states. - /// The current button states to check. + /// Apply input overrides to the given states. + /// The buttons to mark pressed. + /// The buttons to mark released. /// The game's keyboard state for the current tick. /// The game's mouse state for the current tick. /// The game's controller state for the current tick. - private void SuppressGivenStates(IDictionary activeButtons, ref KeyboardState keyboardState, ref MouseState mouseState, ref GamePadState gamePadState) + /// Returns whether any overrides were applied. + private bool ApplyOverrides(ISet pressed, ISet released, ref KeyboardState keyboardState, ref MouseState mouseState, ref GamePadState gamePadState) { - if (this.SuppressButtons.Count == 0) - return; - - // gather info - HashSet suppressKeys = new HashSet(); - HashSet suppressButtons = new HashSet(); - HashSet suppressMouse = new HashSet(); - foreach (SButton button in this.SuppressButtons) + if (pressed.Count == 0 && released.Count == 0) + return false; + + // group keys by type + IDictionary keyboardOverrides = new Dictionary(); + IDictionary controllerOverrides = new Dictionary(); + IDictionary mouseOverrides = new Dictionary(); + foreach (var button in pressed.Concat(released)) { + var newState = this.DeriveState( + oldState: this.GetState(button), + isDown: pressed.Contains(button) + ); + if (button == SButton.MouseLeft || button == SButton.MouseMiddle || button == SButton.MouseRight || button == SButton.MouseX1 || button == SButton.MouseX2) - suppressMouse.Add(button); - else if (button.TryGetKeyboard(out Keys key)) - suppressKeys.Add(key); + mouseOverrides[button] = newState; + else if (button.TryGetKeyboard(out Keys _)) + keyboardOverrides[button] = newState; else if (gamePadState.IsConnected && button.TryGetController(out Buttons _)) - suppressButtons.Add(button); + controllerOverrides[button] = newState; } - // suppress keyboard keys - if (keyboardState.GetPressedKeys().Any() && suppressKeys.Any()) - keyboardState = new KeyboardState(keyboardState.GetPressedKeys().Except(suppressKeys).ToArray()); + // override states + if (keyboardOverrides.Any()) + keyboardState = new KeyboardStateBuilder(keyboardState).OverrideButtons(keyboardOverrides).ToState(); + if (gamePadState.IsConnected && controllerOverrides.Any()) + gamePadState = new GamePadStateBuilder(gamePadState).OverrideButtons(controllerOverrides).ToState(); + if (mouseOverrides.Any()) + mouseState = new MouseStateBuilder(mouseState).OverrideButtons(mouseOverrides).ToMouseState(); - // suppress controller keys - if (gamePadState.IsConnected && suppressButtons.Any()) - { - GamePadStateBuilder builder = new GamePadStateBuilder(gamePadState); - builder.SuppressButtons(suppressButtons); - gamePadState = builder.ToGamePadState(); - } - - // suppress mouse buttons - if (suppressMouse.Any()) - { - mouseState = new MouseState( - x: mouseState.X, - y: mouseState.Y, - scrollWheel: mouseState.ScrollWheelValue, - leftButton: suppressMouse.Contains(SButton.MouseLeft) ? ButtonState.Released : mouseState.LeftButton, - middleButton: suppressMouse.Contains(SButton.MouseMiddle) ? ButtonState.Released : mouseState.MiddleButton, - rightButton: suppressMouse.Contains(SButton.MouseRight) ? ButtonState.Released : mouseState.RightButton, - xButton1: suppressMouse.Contains(SButton.MouseX1) ? ButtonState.Released : mouseState.XButton1, - xButton2: suppressMouse.Contains(SButton.MouseX2) ? ButtonState.Released : mouseState.XButton2 - ); - } + return true; } /// Get the state of all pressed or released buttons relative to their previous state. /// The previous button states. + /// The currently pressed buttons. /// The keyboard state. /// The mouse state. /// The controller state. - private IDictionary DeriveStates(IDictionary previousStates, KeyboardState keyboard, MouseState mouse, GamePadState controller) + private IDictionary DeriveStates(IDictionary previousStates, HashSet pressedButtons, KeyboardState keyboard, MouseState mouse, GamePadState controller) { IDictionary activeButtons = new Dictionary(); // handle pressed keys - SButton[] down = this.GetPressedButtons(keyboard, mouse, controller).ToArray(); - foreach (SButton button in down) + foreach (SButton button in pressedButtons) activeButtons[button] = this.DeriveState(this.GetState(previousStates, button), isDown: true); // handle released keys -- cgit From e80b7712f7e4c78a5b016289ca19efaf7d39cd8b Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 8 Mar 2020 14:53:41 -0400 Subject: encapsulate logic for each input type --- src/SMAPI/Framework/Input/GamePadStateBuilder.cs | 177 +++++++++++++++------ src/SMAPI/Framework/Input/IInputStateBuilder.cs | 29 ++++ src/SMAPI/Framework/Input/KeyboardStateBuilder.cs | 45 ++++-- src/SMAPI/Framework/Input/MouseStateBuilder.cs | 93 +++++++---- src/SMAPI/Framework/Input/SInputState.cs | 185 ++++++---------------- 5 files changed, 305 insertions(+), 224 deletions(-) create mode 100644 src/SMAPI/Framework/Input/IInputStateBuilder.cs (limited to 'src/SMAPI/Framework/Input/SInputState.cs') diff --git a/src/SMAPI/Framework/Input/GamePadStateBuilder.cs b/src/SMAPI/Framework/Input/GamePadStateBuilder.cs index 315aa920..36622066 100644 --- a/src/SMAPI/Framework/Input/GamePadStateBuilder.cs +++ b/src/SMAPI/Framework/Input/GamePadStateBuilder.cs @@ -4,14 +4,23 @@ using Microsoft.Xna.Framework.Input; namespace StardewModdingAPI.Framework.Input { - /// Manipulates controller state. - internal class GamePadStateBuilder + /// Manages controller state. + internal class GamePadStateBuilder : IInputStateBuilder { /********* ** Fields *********/ + /// The maximum direction to ignore for the left thumbstick. + private const float LeftThumbstickDeadZone = 0.2f; + + /// The maximum direction to ignore for the right thumbstick. + private const float RightThumbstickDeadZone = 0.9f; + + /// The underlying controller state. + private GamePadState? State; + /// The current button states. - private readonly IDictionary ButtonStates; + private IDictionary ButtonStates; /// The left trigger value. private float LeftTrigger; @@ -26,44 +35,75 @@ namespace StardewModdingAPI.Framework.Input private Vector2 RightStickPos; + /********* + ** Accessors + *********/ + /// Whether the gamepad is currently connected. + public bool IsConnected { get; private set; } + + /********* ** Public methods *********/ /// Construct an instance. - /// The initial state. - public GamePadStateBuilder(GamePadState state) + /// The initial state, or null to get the latest state. + public GamePadStateBuilder(GamePadState? state = null) + { + this.Reset(state); + } + + /// Reset the tracked state. + /// The state from which to reset, or null to get the latest state. + public GamePadStateBuilder Reset(GamePadState? state = null) { + this.State = state ??= GamePad.GetState(PlayerIndex.One); + this.IsConnected = state.Value.IsConnected; + + if (!this.IsConnected) + return this; + + GamePadDPad pad = state.Value.DPad; + GamePadButtons buttons = state.Value.Buttons; + GamePadTriggers triggers = state.Value.Triggers; + GamePadThumbSticks sticks = state.Value.ThumbSticks; this.ButtonStates = new Dictionary { - [SButton.DPadUp] = state.DPad.Up, - [SButton.DPadDown] = state.DPad.Down, - [SButton.DPadLeft] = state.DPad.Left, - [SButton.DPadRight] = state.DPad.Right, - - [SButton.ControllerA] = state.Buttons.A, - [SButton.ControllerB] = state.Buttons.B, - [SButton.ControllerX] = state.Buttons.X, - [SButton.ControllerY] = state.Buttons.Y, - [SButton.LeftStick] = state.Buttons.LeftStick, - [SButton.RightStick] = state.Buttons.RightStick, - [SButton.LeftShoulder] = state.Buttons.LeftShoulder, - [SButton.RightShoulder] = state.Buttons.RightShoulder, - [SButton.ControllerBack] = state.Buttons.Back, - [SButton.ControllerStart] = state.Buttons.Start, - [SButton.BigButton] = state.Buttons.BigButton + [SButton.DPadUp] = pad.Up, + [SButton.DPadDown] = pad.Down, + [SButton.DPadLeft] = pad.Left, + [SButton.DPadRight] = pad.Right, + + [SButton.ControllerA] = buttons.A, + [SButton.ControllerB] = buttons.B, + [SButton.ControllerX] = buttons.X, + [SButton.ControllerY] = buttons.Y, + [SButton.LeftStick] = buttons.LeftStick, + [SButton.RightStick] = buttons.RightStick, + [SButton.LeftShoulder] = buttons.LeftShoulder, + [SButton.RightShoulder] = buttons.RightShoulder, + [SButton.ControllerBack] = buttons.Back, + [SButton.ControllerStart] = buttons.Start, + [SButton.BigButton] = buttons.BigButton }; - this.LeftTrigger = state.Triggers.Left; - this.RightTrigger = state.Triggers.Right; - this.LeftStickPos = state.ThumbSticks.Left; - this.RightStickPos = state.ThumbSticks.Right; + this.LeftTrigger = triggers.Left; + this.RightTrigger = triggers.Right; + this.LeftStickPos = sticks.Left; + this.RightStickPos = sticks.Right; + + return this; } /// Override the states for a set of buttons. /// The button state overrides. public GamePadStateBuilder OverrideButtons(IDictionary overrides) { + if (!this.IsConnected) + return this; + foreach (var pair in overrides) { + bool changed = true; + bool isDown = pair.Value.IsDown(); switch (pair.Key) { @@ -107,45 +147,92 @@ namespace StardewModdingAPI.Framework.Input default: if (this.ButtonStates.ContainsKey(pair.Key)) this.ButtonStates[pair.Key] = isDown ? ButtonState.Pressed : ButtonState.Released; + else + changed = false; break; } + + if (changed) + this.State = null; } return this; } - /// Construct an equivalent state. - public GamePadState ToState() + /// Get the currently pressed buttons. + public IEnumerable GetPressedButtons() + { + if (!this.IsConnected) + yield break; + + // buttons + foreach (var pair in this.ButtonStates) + { + if (pair.Value == ButtonState.Pressed && pair.Key.TryGetController(out Buttons button)) + yield return button.ToSButton(); + } + + // triggers + if (this.LeftTrigger > 0.2f) + yield return SButton.LeftTrigger; + if (this.RightTrigger > 0.2f) + yield return SButton.RightTrigger; + + // left thumbstick direction + if (this.LeftStickPos.Y > GamePadStateBuilder.LeftThumbstickDeadZone) + yield return SButton.LeftThumbstickUp; + if (this.LeftStickPos.Y < -GamePadStateBuilder.LeftThumbstickDeadZone) + yield return SButton.LeftThumbstickDown; + if (this.LeftStickPos.X > GamePadStateBuilder.LeftThumbstickDeadZone) + yield return SButton.LeftThumbstickRight; + if (this.LeftStickPos.X < -GamePadStateBuilder.LeftThumbstickDeadZone) + yield return SButton.LeftThumbstickLeft; + + // right thumbstick direction + if (this.RightStickPos.Length() > GamePadStateBuilder.RightThumbstickDeadZone) + { + if (this.RightStickPos.Y > 0) + yield return SButton.RightThumbstickUp; + if (this.RightStickPos.Y < 0) + yield return SButton.RightThumbstickDown; + if (this.RightStickPos.X > 0) + yield return SButton.RightThumbstickRight; + if (this.RightStickPos.X < 0) + yield return SButton.RightThumbstickLeft; + } + } + + /// Get the equivalent state. + public GamePadState GetState() { - return new GamePadState( - leftThumbStick: this.LeftStickPos, - rightThumbStick: this.RightStickPos, - leftTrigger: this.LeftTrigger, - rightTrigger: this.RightTrigger, - buttons: this.GetBitmask(this.GetPressedButtons()) // MonoDevelop requires one bitmask here; don't specify multiple values - ); + if (this.State == null) + { + this.State = new GamePadState( + leftThumbStick: this.LeftStickPos, + rightThumbStick: this.RightStickPos, + leftTrigger: this.LeftTrigger, + rightTrigger: this.RightTrigger, + buttons: this.GetButtonBitmask() // MonoGame requires one bitmask here; don't specify multiple values + ); + } + + return this.State.Value; } + /********* ** Private methods *********/ - /// Get all pressed buttons. - private IEnumerable GetPressedButtons() + /// Get a bitmask representing the pressed buttons. + private Buttons GetButtonBitmask() { + Buttons flag = 0; foreach (var pair in this.ButtonStates) { if (pair.Value == ButtonState.Pressed && pair.Key.TryGetController(out Buttons button)) - yield return button; + flag |= button; } - } - /// Get a bitmask representing the given buttons. - /// The buttons to represent. - private Buttons GetBitmask(IEnumerable buttons) - { - Buttons flag = 0; - foreach (Buttons button in buttons) - flag |= button; return flag; } } diff --git a/src/SMAPI/Framework/Input/IInputStateBuilder.cs b/src/SMAPI/Framework/Input/IInputStateBuilder.cs new file mode 100644 index 00000000..193e5216 --- /dev/null +++ b/src/SMAPI/Framework/Input/IInputStateBuilder.cs @@ -0,0 +1,29 @@ +using System.Collections.Generic; + +namespace StardewModdingAPI.Framework.Input +{ + /// Manages input state. + /// The handler type. + /// The state type. + internal interface IInputStateBuilder + where TState : struct + where THandler : IInputStateBuilder + { + /********* + ** Methods + *********/ + /// Reset the tracked state. + /// The state from which to reset, or null to get the latest state. + THandler Reset(TState? state = null); + + /// Override the states for a set of buttons. + /// The button state overrides. + THandler OverrideButtons(IDictionary overrides); + + /// Get the currently pressed buttons. + IEnumerable GetPressedButtons(); + + /// Get the equivalent state. + TState GetState(); + } +} diff --git a/src/SMAPI/Framework/Input/KeyboardStateBuilder.cs b/src/SMAPI/Framework/Input/KeyboardStateBuilder.cs index 12d780f6..f95a28bf 100644 --- a/src/SMAPI/Framework/Input/KeyboardStateBuilder.cs +++ b/src/SMAPI/Framework/Input/KeyboardStateBuilder.cs @@ -4,24 +4,40 @@ using Microsoft.Xna.Framework.Input; namespace StardewModdingAPI.Framework.Input { - /// Manipulates keyboard state. - internal class KeyboardStateBuilder + /// Manages keyboard state. + internal class KeyboardStateBuilder : IInputStateBuilder { /********* ** Fields *********/ + /// The underlying keyboard state. + private KeyboardState? State; + /// The pressed buttons. - private readonly HashSet PressedButtons; + private readonly HashSet PressedButtons = new HashSet(); /********* ** Public methods *********/ /// Construct an instance. - /// The initial state. - public KeyboardStateBuilder(KeyboardState state) + /// The initial state, or null to get the latest state. + public KeyboardStateBuilder(KeyboardState? state = null) { - this.PressedButtons = new HashSet(state.GetPressedKeys()); + this.Reset(state); + } + + /// Reset the tracked state. + /// The state from which to reset, or null to get the latest state. + public KeyboardStateBuilder Reset(KeyboardState? state = null) + { + this.State = state ??= Keyboard.GetState(); + + this.PressedButtons.Clear(); + foreach (var button in state.Value.GetPressedKeys()) + this.PressedButtons.Add(button); + + return this; } /// Override the states for a set of buttons. @@ -32,6 +48,8 @@ namespace StardewModdingAPI.Framework.Input { if (pair.Key.TryGetKeyboard(out Keys key)) { + this.State = null; + if (pair.Value.IsDown()) this.PressedButtons.Add(key); else @@ -42,10 +60,19 @@ namespace StardewModdingAPI.Framework.Input return this; } - /// Build an equivalent state. - public KeyboardState ToState() + /// Get the currently pressed buttons. + public IEnumerable GetPressedButtons() + { + foreach (Keys key in this.PressedButtons) + yield return key.ToSButton(); + } + + /// Get the equivalent state. + public KeyboardState GetState() { - return new KeyboardState(this.PressedButtons.ToArray()); + return + this.State + ?? (this.State = new KeyboardState(this.PressedButtons.ToArray())).Value; } } } diff --git a/src/SMAPI/Framework/Input/MouseStateBuilder.cs b/src/SMAPI/Framework/Input/MouseStateBuilder.cs index 9c6f6f95..cff3e05e 100644 --- a/src/SMAPI/Framework/Input/MouseStateBuilder.cs +++ b/src/SMAPI/Framework/Input/MouseStateBuilder.cs @@ -3,43 +3,61 @@ using Microsoft.Xna.Framework.Input; namespace StardewModdingAPI.Framework.Input { - /// Manipulates mouse state. - internal class MouseStateBuilder + /// Manages mouse state. + internal class MouseStateBuilder : IInputStateBuilder { /********* ** Fields *********/ + /// The underlying mouse state. + private MouseState? State; + /// The current button states. - private readonly IDictionary ButtonStates; + private IDictionary ButtonStates; + + /// The mouse wheel scroll value. + private int ScrollWheelValue; + + /********* + ** Accessors + *********/ /// The X cursor position. - private readonly int X; + public int X { get; private set; } /// The Y cursor position. - private readonly int Y; - - /// The mouse wheel scroll value. - private readonly int ScrollWheelValue; + public int Y { get; private set; } /********* ** Public methods *********/ /// Construct an instance. - /// The initial state. - public MouseStateBuilder(MouseState state) + /// The initial state, or null to get the latest state. + public MouseStateBuilder(MouseState? state = null) + { + this.Reset(state); + } + + /// Reset the tracked state. + /// The state from which to reset, or null to get the latest state. + public MouseStateBuilder Reset(MouseState? state = null) { + this.State = state ??= Mouse.GetState(); + this.ButtonStates = new Dictionary { - [SButton.MouseLeft] = state.LeftButton, - [SButton.MouseMiddle] = state.MiddleButton, - [SButton.MouseRight] = state.RightButton, - [SButton.MouseX1] = state.XButton1, - [SButton.MouseX2] = state.XButton2 + [SButton.MouseLeft] = state.Value.LeftButton, + [SButton.MouseMiddle] = state.Value.MiddleButton, + [SButton.MouseRight] = state.Value.RightButton, + [SButton.MouseX1] = state.Value.XButton1, + [SButton.MouseX2] = state.Value.XButton2 }; - this.X = state.X; - this.Y = state.Y; - this.ScrollWheelValue = state.ScrollWheelValue; + this.X = state.Value.X; + this.Y = state.Value.Y; + this.ScrollWheelValue = state.Value.ScrollWheelValue; + + return this; } /// Override the states for a set of buttons. @@ -56,19 +74,34 @@ namespace StardewModdingAPI.Framework.Input return this; } - /// Construct an equivalent mouse state. - public MouseState ToMouseState() + /// Get the currently pressed buttons. + public IEnumerable GetPressedButtons() { - return new MouseState( - x: this.X, - y: this.Y, - scrollWheel: this.ScrollWheelValue, - leftButton: this.ButtonStates[SButton.MouseLeft], - middleButton: this.ButtonStates[SButton.MouseMiddle], - rightButton: this.ButtonStates[SButton.MouseRight], - xButton1: this.ButtonStates[SButton.MouseX1], - xButton2: this.ButtonStates[SButton.MouseX2] - ); + foreach (var pair in this.ButtonStates) + { + if (pair.Value == ButtonState.Pressed) + yield return pair.Key; + } + } + + /// Get the equivalent state. + public MouseState GetState() + { + if (this.State == null) + { + this.State = new MouseState( + x: this.X, + y: this.Y, + scrollWheel: this.ScrollWheelValue, + leftButton: this.ButtonStates[SButton.MouseLeft], + middleButton: this.ButtonStates[SButton.MouseMiddle], + rightButton: this.ButtonStates[SButton.MouseRight], + xButton1: this.ButtonStates[SButton.MouseX1], + xButton2: this.ButtonStates[SButton.MouseX2] + ); + } + + return this.State.Value; } } } diff --git a/src/SMAPI/Framework/Input/SInputState.cs b/src/SMAPI/Framework/Input/SInputState.cs index 06a7ac3b..333f5726 100644 --- a/src/SMAPI/Framework/Input/SInputState.cs +++ b/src/SMAPI/Framework/Input/SInputState.cs @@ -14,9 +14,6 @@ namespace StardewModdingAPI.Framework.Input /********* ** Accessors *********/ - /// The maximum amount of direction to ignore for the left thumbstick. - private const float LeftThumbstickDeadZone = 0.2f; - /// The cursor position on the screen adjusted for the zoom level. private CursorPosition CursorPositionImpl; @@ -29,8 +26,8 @@ namespace StardewModdingAPI.Framework.Input /// The buttons to consider released until the actual button is released. private readonly HashSet CustomReleasedKeys = new HashSet(); - /// The buttons which were actually down as of the last update, ignoring overrides. - private HashSet LastRealButtonPresses = new HashSet(); + /// Whether there are new overrides in or that haven't been applied to the previous state. + private bool HasNewOverrides; /********* @@ -73,16 +70,12 @@ namespace StardewModdingAPI.Framework.Input /// Whether to mark it pressed; else mark it released. public void OverrideButton(SButton button, bool setDown) { - if (setDown) - { - this.CustomPressedKeys.Add(button); - this.CustomReleasedKeys.Remove(button); - } - else - { - this.CustomPressedKeys.Remove(button); - this.CustomReleasedKeys.Add(button); - } + bool changed = setDown + ? this.CustomPressedKeys.Add(button) | this.CustomReleasedKeys.Remove(button) + : this.CustomPressedKeys.Remove(button) | this.CustomReleasedKeys.Add(button); + + if (changed) + this.HasNewOverrides = true; } /// Get whether a mod has indicated the key was already handled, so the game shouldn't handle it. @@ -104,9 +97,9 @@ namespace StardewModdingAPI.Framework.Input float zoomMultiplier = (1f / Game1.options.zoomLevel); // get real values - GamePadState controller = GamePad.GetState(PlayerIndex.One); - KeyboardState keyboard = Keyboard.GetState(); - MouseState mouse = Mouse.GetState(); + var controller = new GamePadStateBuilder(); + var keyboard = new KeyboardStateBuilder(); + var mouse = new MouseStateBuilder(); Vector2 cursorAbsolutePos = new Vector2((mouse.X * zoomMultiplier) + Game1.viewport.X, (mouse.Y * zoomMultiplier) + Game1.viewport.Y); Vector2? playerTilePos = Context.IsPlayerFree ? Game1.player.getTileLocation() : (Vector2?)null; HashSet reallyDown = new HashSet(this.GetPressedButtons(keyboard, mouse, controller)); @@ -120,7 +113,7 @@ namespace StardewModdingAPI.Framework.Input this.CustomReleasedKeys.RemoveWhere(key => !reallyDown.Contains(key)); // apply overrides - if (this.ApplyOverrides(this.CustomPressedKeys, this.CustomReleasedKeys, ref keyboard, ref mouse, ref controller)) + if (this.ApplyOverrides(this.CustomPressedKeys, this.CustomReleasedKeys, controller, keyboard, mouse)) hasOverrides = true; // remove pressed keys @@ -131,18 +124,18 @@ namespace StardewModdingAPI.Framework.Input var pressedButtons = hasOverrides ? new HashSet(this.GetPressedButtons(keyboard, mouse, controller)) : reallyDown; - var activeButtons = this.DeriveStates(this.LastButtonStates, pressedButtons, keyboard, mouse, controller); + var activeButtons = this.DeriveStates(this.LastButtonStates, pressedButtons); // update - this.LastController = controller; - this.LastKeyboard = keyboard; - this.LastMouse = mouse; + this.HasNewOverrides = false; + this.LastController = controller.GetState(); + this.LastKeyboard = keyboard.GetState(); + this.LastMouse = mouse.GetState(); this.LastButtonStates = activeButtons; - this.LastRealButtonPresses = reallyDown; if (cursorAbsolutePos != this.CursorPositionImpl?.AbsolutePixels || playerTilePos != this.LastPlayerTile) { this.LastPlayerTile = playerTilePos; - this.CursorPositionImpl = this.GetCursorPosition(mouse, cursorAbsolutePos, zoomMultiplier); + this.CursorPositionImpl = this.GetCursorPosition(this.LastMouse, cursorAbsolutePos, zoomMultiplier); } } catch (InvalidOperationException) @@ -154,15 +147,19 @@ namespace StardewModdingAPI.Framework.Input /// Apply input overrides to the current state. public void ApplyOverrides() { - GamePadState newController = this.LastController; - KeyboardState newKeyboard = this.LastKeyboard; - MouseState newMouse = this.LastMouse; - - this.ApplyOverrides(pressed: this.CustomPressedKeys, released: this.CustomReleasedKeys, ref newKeyboard, ref newMouse, ref newController); + if (this.HasNewOverrides) + { + var controller = new GamePadStateBuilder(this.LastController); + var keyboard = new KeyboardStateBuilder(this.LastKeyboard); + var mouse = new MouseStateBuilder(this.LastMouse); - this.LastController = newController; - this.LastKeyboard = newKeyboard; - this.LastMouse = newMouse; + if (this.ApplyOverrides(pressed: this.CustomPressedKeys, released: this.CustomReleasedKeys, controller, keyboard, mouse)) + { + this.LastController = controller.GetState(); + this.LastKeyboard = keyboard.GetState(); + this.LastMouse = mouse.GetState(); + } + } } /// Get the gamepad state visible to the game. @@ -231,11 +228,11 @@ namespace StardewModdingAPI.Framework.Input /// Apply input overrides to the given states. /// The buttons to mark pressed. /// The buttons to mark released. - /// The game's keyboard state for the current tick. - /// The game's mouse state for the current tick. - /// The game's controller state for the current tick. + /// The game's controller state for the current tick. + /// The game's keyboard state for the current tick. + /// The game's mouse state for the current tick. /// Returns whether any overrides were applied. - private bool ApplyOverrides(ISet pressed, ISet released, ref KeyboardState keyboardState, ref MouseState mouseState, ref GamePadState gamePadState) + private bool ApplyOverrides(ISet pressed, ISet released, GamePadStateBuilder controller, KeyboardStateBuilder keyboard, MouseStateBuilder mouse) { if (pressed.Count == 0 && released.Count == 0) return false; @@ -255,17 +252,17 @@ namespace StardewModdingAPI.Framework.Input mouseOverrides[button] = newState; else if (button.TryGetKeyboard(out Keys _)) keyboardOverrides[button] = newState; - else if (gamePadState.IsConnected && button.TryGetController(out Buttons _)) + else if (controller.IsConnected && button.TryGetController(out Buttons _)) controllerOverrides[button] = newState; } // override states if (keyboardOverrides.Any()) - keyboardState = new KeyboardStateBuilder(keyboardState).OverrideButtons(keyboardOverrides).ToState(); - if (gamePadState.IsConnected && controllerOverrides.Any()) - gamePadState = new GamePadStateBuilder(gamePadState).OverrideButtons(controllerOverrides).ToState(); + keyboard.OverrideButtons(keyboardOverrides); + if (controller.IsConnected && controllerOverrides.Any()) + controller.OverrideButtons(controllerOverrides); if (mouseOverrides.Any()) - mouseState = new MouseStateBuilder(mouseState).OverrideButtons(mouseOverrides).ToMouseState(); + mouse.OverrideButtons(mouseOverrides); return true; } @@ -273,10 +270,7 @@ namespace StardewModdingAPI.Framework.Input /// Get the state of all pressed or released buttons relative to their previous state. /// The previous button states. /// The currently pressed buttons. - /// The keyboard state. - /// The mouse state. - /// The controller state. - private IDictionary DeriveStates(IDictionary previousStates, HashSet pressedButtons, KeyboardState keyboard, MouseState mouse, GamePadState controller) + private IDictionary DeriveStates(IDictionary previousStates, HashSet pressedButtons) { IDictionary activeButtons = new Dictionary(); @@ -319,101 +313,12 @@ namespace StardewModdingAPI.Framework.Input /// The mouse state. /// The controller state. /// Thumbstick direction logic derived from . - private IEnumerable GetPressedButtons(KeyboardState keyboard, MouseState mouse, GamePadState controller) - { - // keyboard - foreach (Keys key in keyboard.GetPressedKeys()) - yield return key.ToSButton(); - - // mouse - if (mouse.LeftButton == ButtonState.Pressed) - yield return SButton.MouseLeft; - if (mouse.RightButton == ButtonState.Pressed) - yield return SButton.MouseRight; - if (mouse.MiddleButton == ButtonState.Pressed) - yield return SButton.MouseMiddle; - if (mouse.XButton1 == ButtonState.Pressed) - yield return SButton.MouseX1; - if (mouse.XButton2 == ButtonState.Pressed) - yield return SButton.MouseX2; - - // controller - if (controller.IsConnected) - { - // main buttons - if (controller.Buttons.A == ButtonState.Pressed) - yield return SButton.ControllerA; - if (controller.Buttons.B == ButtonState.Pressed) - yield return SButton.ControllerB; - if (controller.Buttons.X == ButtonState.Pressed) - yield return SButton.ControllerX; - if (controller.Buttons.Y == ButtonState.Pressed) - yield return SButton.ControllerY; - if (controller.Buttons.LeftStick == ButtonState.Pressed) - yield return SButton.LeftStick; - if (controller.Buttons.RightStick == ButtonState.Pressed) - yield return SButton.RightStick; - if (controller.Buttons.Start == ButtonState.Pressed) - yield return SButton.ControllerStart; - - // directional pad - if (controller.DPad.Up == ButtonState.Pressed) - yield return SButton.DPadUp; - if (controller.DPad.Down == ButtonState.Pressed) - yield return SButton.DPadDown; - if (controller.DPad.Left == ButtonState.Pressed) - yield return SButton.DPadLeft; - if (controller.DPad.Right == ButtonState.Pressed) - yield return SButton.DPadRight; - - // secondary buttons - if (controller.Buttons.Back == ButtonState.Pressed) - yield return SButton.ControllerBack; - if (controller.Buttons.BigButton == ButtonState.Pressed) - yield return SButton.BigButton; - - // shoulders - if (controller.Buttons.LeftShoulder == ButtonState.Pressed) - yield return SButton.LeftShoulder; - if (controller.Buttons.RightShoulder == ButtonState.Pressed) - yield return SButton.RightShoulder; - - // triggers - if (controller.Triggers.Left > 0.2f) - yield return SButton.LeftTrigger; - if (controller.Triggers.Right > 0.2f) - yield return SButton.RightTrigger; - - // left thumbstick direction - if (controller.ThumbSticks.Left.Y > SInputState.LeftThumbstickDeadZone) - yield return SButton.LeftThumbstickUp; - if (controller.ThumbSticks.Left.Y < -SInputState.LeftThumbstickDeadZone) - yield return SButton.LeftThumbstickDown; - if (controller.ThumbSticks.Left.X > SInputState.LeftThumbstickDeadZone) - yield return SButton.LeftThumbstickRight; - if (controller.ThumbSticks.Left.X < -SInputState.LeftThumbstickDeadZone) - yield return SButton.LeftThumbstickLeft; - - // right thumbstick direction - if (this.IsRightThumbstickOutsideDeadZone(controller.ThumbSticks.Right)) - { - if (controller.ThumbSticks.Right.Y > 0) - yield return SButton.RightThumbstickUp; - if (controller.ThumbSticks.Right.Y < 0) - yield return SButton.RightThumbstickDown; - if (controller.ThumbSticks.Right.X > 0) - yield return SButton.RightThumbstickRight; - if (controller.ThumbSticks.Right.X < 0) - yield return SButton.RightThumbstickLeft; - } - } - } - - /// Get whether the right thumbstick should be considered outside the dead zone. - /// The right thumbstick value. - private bool IsRightThumbstickOutsideDeadZone(Vector2 direction) + private IEnumerable GetPressedButtons(KeyboardStateBuilder keyboard, MouseStateBuilder mouse, GamePadStateBuilder controller) { - return direction.Length() > 0.9f; + return keyboard + .GetPressedButtons() + .Concat(mouse.GetPressedButtons()) + .Concat(controller.GetPressedButtons()); } } } -- cgit