feat: scrollable history, partially done

Author: LozenChen

Source/Gameplay/ConsoleEnhancement.cs

@@ -1,5 +1,6 @@
 using Celeste.Mod.Core;
 using Celeste.Mod.TASHelper.Utils;
+using Microsoft.Xna.Framework.Input;
 using Mono.Cecil.Cil;
 using Monocle;
 using MonoMod.Cil;
@@ -14,7 +15,11 @@ public static class ConsoleEnhancement {
 
     private static bool lastOpen = false;
 
+    private static int historyLineShift = 0;
 
+    private static int origValue;
+
+    private static bool historyScrollEnabled => TasHelperSettings.EnableScrollableHistoryLog;
     public static void SetOpenConsole() {
         if (Manager.Running && !lastOpen) {
             openConsole = true;
@@ -24,16 +29,24 @@ public static bool GetOpenConsole() { // openConsole.getter may not be called (e
         return openConsole;
     }
 
+    public static void GoBackToBottom() {
+        historyLineShift = 0;
+    }
+
     [Load]
     public static void Load() {
         IL.Monocle.Commands.UpdateClosed += ILCommandUpdateClosed;
         On.Celeste.Level.BeforeRender += OnLevelBeforeRender;
+        IL.Monocle.Commands.Render += ILCommandsRender;
+        On.Monocle.Commands.UpdateOpen += OnCommandUpdateOpen;
     }
 
     [Unload]
     public static void Unload() {
         IL.Monocle.Commands.UpdateClosed -= ILCommandUpdateClosed;
         On.Celeste.Level.BeforeRender -= OnLevelBeforeRender;
+        IL.Monocle.Commands.Render -= ILCommandsRender;
+        On.Monocle.Commands.UpdateOpen -= OnCommandUpdateOpen;
     }
 
     [Initialize]
@@ -42,6 +55,74 @@ public static void Initialize() {
         typeof(Manager).GetMethod("DisableRun").HookAfter(MinorBugFixer);
     }
 
+    private static void ILCommandsRender(ILContext context) {
+        ILCursor cursor = new ILCursor(context);
+        if (cursor.TryGotoNext(
+            ins => ins.MatchLdarg(0),
+            ins => ins.MatchLdfld<Monocle.Commands>("drawCommands"),
+            ins => ins.MatchCallOrCallvirt<List<Monocle.Commands.Line>>("get_Count"),
+            ins => ins.MatchLdcI4(0),
+            ins => ins.OpCode == OpCodes.Ble,
+            ins => ins.MatchLdloc(1))) {
+            cursor.Index += 5;
+            ILLabel end = (ILLabel) cursor.Prev.Operand;
+            cursor.Emit(OpCodes.Ldarg_0);
+            cursor.EmitDelegate(BeforeAction);
+            cursor.GotoLabel(end);
+            cursor.Emit(OpCodes.Ldarg_0);
+            cursor.EmitDelegate(AfterAction);
+        }
+    }
+
+    private static void BeforeAction(Monocle.Commands commands) {
+        origValue = commands.firstLineIndexToDraw;
+        commands.firstLineIndexToDraw = Calc.Clamp(commands.firstLineIndexToDraw + historyLineShift, 0, Math.Max(commands.drawCommands.Count - 1, 0));
+    }
+
+    private static void AfterAction(Monocle.Commands commands) {
+        if (commands.drawCommands.Count > 0) {
+            historyLineShift = commands.firstLineIndexToDraw - origValue; // this automatically bounds our shift
+            commands.firstLineIndexToDraw = origValue;
+        }
+    }
+
+    private static int repeatCounter = 0;
+
+    private static void OnCommandUpdateOpen(On.Monocle.Commands.orig_UpdateOpen orig, Monocle.Commands commands) {
+        orig(commands);
+        if (historyScrollEnabled) {
+            bool controlPressed = commands.currentState[Keys.LeftControl] == KeyState.Down || commands.currentState[Keys.RightControl] == KeyState.Down;
+            if (commands.currentState[Keys.PageUp] == KeyState.Down && commands.oldState[Keys.PageUp] == KeyState.Up) {
+                historyLineShift += (Engine.ViewHeight - 100) / 30;
+            }
+            else if (commands.currentState[Keys.PageDown] == KeyState.Down && commands.oldState[Keys.PageDown] == KeyState.Up) {
+                if (controlPressed) {
+                    historyLineShift = 0;
+                }
+                else {
+                    historyLineShift -= (Engine.ViewHeight - 100) / 30;
+                }
+            }
+            else if (commands.currentState[Keys.Up] == KeyState.Down && controlPressed) {
+                repeatCounter += 1;
+                while (repeatCounter >= 6) {
+                    repeatCounter -= 2;
+                    historyLineShift += 1;
+                }
+            }
+            else if (commands.currentState[Keys.Down] == KeyState.Down && controlPressed) {
+                repeatCounter += 1;
+                while (repeatCounter >= 6) {
+                    repeatCounter -= 2;
+                    historyLineShift -= 1;
+                }
+            }
+            else {
+                repeatCounter = 0;
+            }
+        }
+    }
+
     private static void MinorBugFixer() {
         // if open debugconsole and close it when in tas, then exit tas (without running any frame), debugconsole will show up
 

Source/Module/Menu/TASHelperMenu.cs

@@ -148,6 +148,7 @@ private static EaseInSubMenu CreateMoreOptionsSubMenu(TextMenu menu) {
             subMenu.Add(new TextMenu.OnOff("RotateSpinner Track".ToDialogText(), TasHelperSettings.UsingRotateSpinnerTrack).Change(value => TasHelperSettings.UsingRotateSpinnerTrack = value));
             subMenu.Add(new TextMenu.OnOff("TrackSpinner Track".ToDialogText(), TasHelperSettings.UsingTrackSpinnerTrack).Change(value => TasHelperSettings.UsingTrackSpinnerTrack = value));
             subMenu.Add(new TextMenu.OnOff("Open Console In Tas".ToDialogText(), TasHelperSettings.EnableOpenConsoleInTas).Change(value => TasHelperSettings.EnableOpenConsoleInTas = value));
+            subMenu.Add(new TextMenu.OnOff("Scrollable History Log".ToDialogText(), TasHelperSettings.EnableScrollableHistoryLog).Change(value => TasHelperSettings.EnableScrollableHistoryLog = value));
             TextMenu.Item OoOItem;
             subMenu.Add(OoOItem = new TextMenu.OnOff("Order of Operation Stepping".ToDialogText(), TasHelperSettings.EnableOoO).Change(value => TasHelperSettings.EnableOoO = value));
             subMenu.AddDescription(menu, OoOItem, "Order of Operation Description".ToDialogText());

Source/Module/TASHelperSettings.cs

@@ -97,6 +97,7 @@ internal void Sleep() {
         Awake_PredictFuture = false;
         Awake_EnableOoO = false;
         Awake_OpenConsoleInTas = false;
+        Awake_ScrollableHistoryLog = false;
     }
     internal void Awake(bool awakeAll) {
         MainSwitch = awakeAll ? MainSwitchModes.AllowAll : MainSwitchModes.OnlyDefault;
@@ -115,6 +116,7 @@ internal void Awake(bool awakeAll) {
         Awake_PredictFuture = true;
         Awake_EnableOoO = true;
         Awake_OpenConsoleInTas = true;
+        Awake_ScrollableHistoryLog = true;
     }
 
     #endregion
@@ -652,6 +654,19 @@ public bool EnableOpenConsoleInTas {
         }
     }
 
+    public bool enableScrollableHistoryLog { get; set; } = true;
+
+    public bool Awake_ScrollableHistoryLog = true;
+
+    [YamlIgnore]
+    public bool EnableScrollableHistoryLog {
+        get => Enabled && Awake_ScrollableHistoryLog && enableScrollableHistoryLog;
+        set {
+            enableScrollableHistoryLog = value;
+            Awake_ScrollableHistoryLog = true;
+        }
+    }
+
     #endregion
 
     #region HotKey