add log_context console command to replace test_input

This logs more contextual info like menu changes.

Author: Pathoschild

docs/release-notes.md

@@ -4,6 +4,7 @@
 ## Upcoming release
 * For players:
   * Added [`--prefer-terminal-name` command-line argument](technical/smapi.md#command-line-arguments) to override which terminal SMAPI is launched with (thanks to test482!).
+  * Added `log_context` console command. This replaces `log_input` and logs more information like menu changes.
   * Fixed some mods compiled for Stardew Valley 1.6.3+ not working in 1.6.0–1.6.2.
   * Fixed SMAPI's "_Found warnings with X mods_" message counting hidden warnings.
   * Improved translations. Thanks to RezaHidayatM (added Indonesian)!

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/ConsoleCommand.cs

@@ -16,9 +16,6 @@ internal abstract class ConsoleCommand : IConsoleCommand
         /// <summary>The command description.</summary>
         public string Description { get; }
 
-        /// <summary>Whether the command may need to perform logic when the player presses a button. This value shouldn't change.</summary>
-        public bool MayNeedInput { get; }
-
         /// <summary>Whether the command may need to perform logic when the game updates. This value shouldn't change.</summary>
         public bool MayNeedUpdate { get; }
 
@@ -48,13 +45,11 @@ public virtual void OnButtonPressed(IMonitor monitor, SButton button) { }
         /// <summary>Construct an instance.</summary>
         /// <param name="name">The command name the user must type.</param>
         /// <param name="description">The command description.</param>
-        /// <param name="mayNeedInput">Whether the command may need to perform logic when the player presses a button.</param>
         /// <param name="mayNeedUpdate">Whether the command may need to perform logic when the game updates.</param>
-        protected ConsoleCommand(string name, string description, bool mayNeedInput = false, bool mayNeedUpdate = false)
+        protected ConsoleCommand(string name, string description, bool mayNeedUpdate = false)
         {
             this.Name = name;
             this.Description = description;
-            this.MayNeedInput = mayNeedInput;
             this.MayNeedUpdate = mayNeedUpdate;
         }
 

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/IConsoleCommand.cs

@@ -15,9 +15,6 @@ internal interface IConsoleCommand
         /// <summary>Whether the command may need to perform logic when the game updates. This value shouldn't change.</summary>
         bool MayNeedUpdate { get; }
 
-        /// <summary>Whether the command may need to perform logic when the player presses a button. This value shouldn't change.</summary>
-        bool MayNeedInput { get; }
-
 
         /*********
         ** Public methods
@@ -31,10 +28,5 @@ internal interface IConsoleCommand
         /// <summary>Perform any logic needed on update tick.</summary>
         /// <param name="monitor">Writes messages to the console and log file.</param>
         void OnUpdated(IMonitor monitor);
-
-        /// <summary>Perform any logic when input is received.</summary>
-        /// <param name="monitor">Writes messages to the console and log file.</param>
-        /// <param name="button">The button that was pressed.</param>
-        void OnButtonPressed(IMonitor monitor, SButton button);
     }
 }

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/LogContextCommand.cs

@@ -0,0 +1,31 @@
+using System.Diagnostics.CodeAnalysis;
+using StardewModdingAPI.Framework;
+
+namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Other
+{
+    /// <summary>A command which logs contextual info like keys pressed or menus changed until it's disabled.</summary>
+    [SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Loaded using reflection")]
+    internal class LogContextCommand : ConsoleCommand
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        public LogContextCommand()
+            : base("log_context", "Prints contextual info like keys pressed or menus changed until it's disabled.", mayNeedUpdate: true) { }
+
+        /// <summary>Handle the command.</summary>
+        /// <param name="monitor">Writes messages to the console and log file.</param>
+        /// <param name="command">The command name.</param>
+        /// <param name="args">The command arguments.</param>
+        public override void Handle(IMonitor monitor, string command, ArgumentParser args)
+        {
+            Monitor.ForceLogContext = true;
+
+            monitor.Log(
+                Monitor.ForceLogContext ? "OK, logging contextual info until you run this command again." : "OK, no longer logging contextual info.",
+                LogLevel.Info
+            );
+        }
+    }
+}

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/TestInputCommand.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using StardewModdingAPI.Events;
 using StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands;
 
 namespace StardewModdingAPI.Mods.ConsoleCommands
@@ -18,9 +17,6 @@ public class ModEntry : Mod
         /// <summary>The commands which may need to handle update ticks.</summary>
         private IConsoleCommand[] UpdateHandlers = null!;
 
-        /// <summary>The commands which may need to handle input.</summary>
-        private IConsoleCommand[] InputHandlers = null!;
-
 
         /*********
         ** Public methods
@@ -35,27 +31,16 @@ public override void Entry(IModHelper helper)
                 helper.ConsoleCommands.Add(command.Name, command.Description, (name, args) => this.HandleCommand(command, name, args));
 
             // cache commands
-            this.InputHandlers = this.Commands.Where(p => p.MayNeedInput).ToArray();
             this.UpdateHandlers = this.Commands.Where(p => p.MayNeedUpdate).ToArray();
 
             // hook events
             helper.Events.GameLoop.UpdateTicked += this.OnUpdateTicked;
-            helper.Events.Input.ButtonPressed += this.OnButtonPressed;
         }
 
 
         /*********
         ** Private methods
         *********/
-        /// <summary>The method invoked when a button is pressed.</summary>
-        /// <param name="sender">The event sender.</param>
-        /// <param name="e">The event arguments.</param>
-        private void OnButtonPressed(object? sender, ButtonPressedEventArgs e)
-        {
-            foreach (IConsoleCommand command in this.InputHandlers)
-                command.OnButtonPressed(this.Monitor, e.Button);
-        }
-
         /// <summary>The method invoked when the game updates its state.</summary>
         /// <param name="sender">The event sender.</param>
         /// <param name="e">The event arguments.</param>

src/SMAPI.Mods.ConsoleCommands/ModEntry.cs

@@ -22,6 +22,4 @@
   <ItemGroup>
     <None Update="manifest.json" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
-
-  <Import Project="..\SMAPI.Internal\SMAPI.Internal.projitems" Label="Shared" />
 </Project>

src/SMAPI.Mods.ConsoleCommands/SMAPI.Mods.ConsoleCommands.csproj

@@ -102,7 +102,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SMAPI.Tests.ModApiConsumer"
 EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
-		SMAPI.Internal\SMAPI.Internal.projitems*{0634ea4c-3b8f-42db-aea6-ca9e4ef6e92f}*SharedItemsImports = 5
 		SMAPI.Internal\SMAPI.Internal.projitems*{0a9bb24f-15ff-4c26-b1a2-81f7ae316518}*SharedItemsImports = 5
 		SMAPI.Internal\SMAPI.Internal.projitems*{80efd92f-728f-41e0-8a5b-9f6f49a91899}*SharedItemsImports = 5
 		SMAPI.Internal\SMAPI.Internal.projitems*{85208f8d-6fd1-4531-be05-7142490f59fe}*SharedItemsImports = 13

src/SMAPI.sln

@@ -38,6 +38,12 @@ internal class Monitor : IMonitor
         /*********
         ** Accessors
         *********/
+        /// <summary>Whether to log basic contextual info (like buttons pressed and menus opened) even if <see cref="IsVerbose"/> is disabled.</summary>
+        public static bool ForceLogContext { get; set; }
+
+        /// <summary>The current log level for contextual info that's relevant to the <see cref="ForceLogContext"/> flag.</summary>
+        public static LogLevel ContextLogLevel => Monitor.ForceLogContext ? LogLevel.Info : LogLevel.Trace;
+
         /// <inheritdoc />
         public bool IsVerbose { get; }