fix(input): drain custom key bindings the open menu does not handle

Author: TomGrobbe

MenuAPI/Menu.cs

@@ -1479,6 +1479,26 @@ public void SetVehicleUpgradeStats(float topSpeed, float acceleration, float bra
     #endregion
 
     #region internal/private task functions
+    // Answers what MenuInput.DrainUnhandled needs to know: whether a press on this binding is going
+    // to reach a handler, so everything else can be thrown away instead of firing later.
+    internal bool Handles(MenuKeyBinding binding)
+    {
+        if (KeyBindingHandlers.Count == 0 || MenuController.DisableMenuButtons)
+        {
+            return false;
+        }
+
+        foreach (KeyBindingHandler entry in KeyBindingHandlers)
+        {
+            if (entry.Handler is not null && ReferenceEquals(entry.Binding, binding))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     internal void ProcessKeyBindings()
     {
         if (KeyBindingHandlers.Count == 0 || MenuController.DisableMenuButtons)

MenuAPI/MenuController.cs

@@ -462,6 +462,8 @@ private static async Task ProcessMainButtons()
         bool selectPressed = MenuInput.ConsumeSelect();
         bool backPressed = MenuInput.ConsumeBack();
 
+        MenuInput.DrainUnhandled(MenuReadingKeyBindings());
+
         if (FrameState.IsPauseMenuActive)
         {
             return;
@@ -1118,6 +1120,18 @@ private static void RefreshTextures()
     public static void RefreshNui() => MenuNui.Invalidate();
 
     /// <summary>The game states that stop a menu being drawn, none of which announce a change.</summary>
+    private static Menu? MenuReadingKeyBindings()
+    {
+        if (!CanDraw() || DontOpenAnyMenu)
+        {
+            return null;
+        }
+
+        Menu? menu = GetCurrentMenu();
+
+        return menu is not null && menu.Visible ? menu : null;
+    }
+
     private static bool CanDraw() =>
         FrameState.IsScreenFadedIn &&
         !FrameState.IsPauseMenuActive &&

MenuAPI/MenuInput.cs

@@ -1,4 +1,4 @@
-using CitizenFX.FiveM.Client;
+using CitizenFX.FiveM.Client;
 using CitizenFX.FiveM.Shared;
 
 namespace MenuAPI;
@@ -205,6 +205,23 @@ internal static void ClearHeld()
         }
     }
 
+    /// <summary>
+    /// Drops the pending press and release on every custom binding <paramref name="menu"/> is not
+    /// about to read this frame.
+    /// </summary>
+    internal static void DrainUnhandled(Menu? menu)
+    {
+        foreach (MenuKeyBinding binding in Custom.Values)
+        {
+            if (menu is not null && menu.Handles(binding))
+            {
+                continue;
+            }
+
+            binding.ClearPending();
+        }
+    }
+
     internal static void ClearPending()
     {
         foreach (MenuKeyBinding binding in Own)