Add chat recall (scroll through previous messages)

Author: astra1dev

README.md

@@ -34,6 +34,7 @@
   - Removes the time penalty after disconnecting from too many lobbies
 - 💬 Chat Features
   - Use `Ctrl + C` and `Ctrl + V` to copy-paste chat messages
+  - Scroll through your previously sent chat messages using the Up and Down arrow keys
   - Be able to send URLs and Email addresses
   - Increase the character limit from 100 to 120
   - Modify the maximum amount of chat messages to keep in the chat history

src/AUnlocker.cs

@@ -92,6 +92,7 @@ public override void Load()
 
         AddComponent<KeybindListener>().Plugin = this;
         HudManager_Start_Patch.Plugin = this;
+        ChatJailbreak_ChatController_Update_Postfix.Plugin = this;
     }
 }
 

src/ChatPatches.cs

@@ -1,13 +1,21 @@
 using HarmonyLib;
 using UnityEngine;
+using static AUnlocker.ChatHistory_ChatController_SendChat_Prefix;
 
 namespace AUnlocker;
 
 [HarmonyPatch(typeof(ChatController), nameof(ChatController.Update))]
 public static class ChatJailbreak_ChatController_Update_Postfix
 {
+    public static AUnlocker Plugin { get; internal set; }
+
+    // CurrentHistorySelection: -1 = no selection, 0 = first message, Count - 1 = last message
+    public static int CurrentHistorySelection = -1;
+    private static string inProgressMessage = "";
+    private static bool isNavigatingHistory = false;
+
     /// <summary>
-    /// Remove the chat cooldown and the character limit.
+    /// Remove the chat cooldown and the character limit. Add the ability to scroll through previous chat messages using the up and down arrow keys.
     /// </summary>
     /// <param name="__instance">The <c>ChatController</c> instance.</param>
     public static void Postfix(ChatController __instance)
@@ -33,6 +41,45 @@ public static void Postfix(ChatController __instance)
             __instance.freeChatField.textArea.allowAllCharacters = true;
             __instance.freeChatField.textArea.characterLimit = 120;  // above 120 characters anti-cheat will kick you
         }
+
+        // User is trying to navigate up the chat history
+        if (Input.GetKeyDown(KeyCode.UpArrow) && ChatHistory.Count > 0)
+        {
+            if (!isNavigatingHistory)
+            {
+                // Store the in-progress text so we can restore it later
+                inProgressMessage = __instance.freeChatField.textArea.text;
+                isNavigatingHistory = true;
+            }
+
+            if (CurrentHistorySelection == 0)
+            {
+                SoundManager.Instance.PlaySound(__instance.warningSound, false);
+                Plugin.Log.LogInfo("You have reached the end of your chat history.");
+            }
+            else
+            {
+                // Ensure the index (current selection) is within bounds of the ChatHistory list (0 to Count - 1)
+                CurrentHistorySelection = Mathf.Clamp(--CurrentHistorySelection, 0, ChatHistory.Count - 1);
+                __instance.freeChatField.textArea.SetText(ChatHistory[CurrentHistorySelection]);
+            }
+        }
+
+        // User is trying to navigate down the chat history
+        if (Input.GetKeyDown(KeyCode.DownArrow) && ChatHistory.Count > 0)
+        {
+            CurrentHistorySelection++;
+            if (CurrentHistorySelection < ChatHistory.Count)
+            {
+                __instance.freeChatField.textArea.SetText(ChatHistory[CurrentHistorySelection]);
+            }
+            // User has navigated past the most recent message, restore the in-progress text
+            else
+            {
+                __instance.freeChatField.textArea.SetText(inProgressMessage);
+                isNavigatingHistory = false;
+            }
+        }
     }
 }
 
@@ -98,6 +145,29 @@ public static bool Prefix(ChatController __instance)
     }
 }
 
+[HarmonyPatch(typeof(ChatController), nameof(ChatController.SendChat))]
+public static class ChatHistory_ChatController_SendChat_Prefix
+{
+    // ChatHistory: index 0 = earliest message, highest index = latest message
+    public static readonly List<string> ChatHistory = [];
+
+    /// <summary>
+    /// When sending a chat message (either via pressing enter or clicking the send button), add it to the chat history.
+    /// </summary>
+    /// <param name="__instance">The <c>ChatController</c> instance.</param>
+    /// <returns><c>false</c> to skip the original method, <c>true</c> to allow the original method to run.</returns>
+    public static bool Prefix(ChatController __instance)
+    {
+        var text = __instance.freeChatField.textArea.text;
+        // Add to chat history if empty or not the same as the previous message
+        // Also this intentionally allows empty / whitespace-only messages to be added to history
+        if (ChatHistory.LastOrDefault() != text)
+            ChatHistory.Add(text);
+        ChatJailbreak_ChatController_Update_Postfix.CurrentHistorySelection = ChatHistory.Count;
+        return true;
+    }
+}
+
 [HarmonyPatch(typeof(TextBoxTMP), nameof(TextBoxTMP.IsCharAllowed))]
 public static class AllowAllCharacters_TextBoxTMP_IsCharAllowed_Prefix
 {