try remove tags from pause, switch to sound based

also fix the double sound on opening a menu, since everything's triggered off of playing it anyway

Author: apple1417

src/willow1_mod_menu/options.py

@@ -122,7 +122,6 @@ def open_new_generic_menu(menu: WillowGFxMenu) -> None:
 
     menu.ScreenStack.append(text)
     menu.ActivateTopPage(0)
-    menu.PlayUISound("Confirm")
 
     if not original_needs_delayed_init:
         # Can draw immediately

src/willow1_mod_menu/pause.py

@@ -1,14 +1,15 @@
 # ruff: noqa: D103
 from typing import Any
 
-from unrealsdk.hooks import Block, Type
-from unrealsdk.unreal import BoundFunction, UObject, WrappedStruct
+from unrealsdk.hooks import Type
+from unrealsdk.unreal import BoundFunction, UObject, WeakPointer, WrappedStruct
 
 from mods_base import hook
 
 from .options import create_mod_list_options_menu
+from .util import find_focused_item
 
-MODS_MENU_TAG = "willow1-mod-menu:mods-pause"
+current_menu = WeakPointer()
 
 
 # In contrast to the frontend menu, the pause menu uses a generic menu screen, so the best place to
@@ -23,14 +24,18 @@ def inject_mods_into_pause_screen(
     if args.menuCaption != "$WillowMenu.Pause.Exit":
         return
 
-    # We also don't seem to have a great way of detecting generic item activate events, so instead
-    # we hook this to an unused debug function
-    func(0, "Mods", MODS_MENU_TAG, "extMainDebug")
+    func(0, "Mods")
 
 
 @hook("WillowGame.WillowGFxMenuPause:extInitMain", immediately_enable=True)
-def open_pause_pre(*_: Any) -> None:
+def open_pause_pre(obj: UObject, _args: WrappedStruct, _ret: Any, _func: BoundFunction) -> None:
+    global current_menu
+    current_menu = WeakPointer(obj)
+
     inject_mods_into_pause_screen.enable()
+    pause_play_sound.enable()
+    reenable_pause_after_nested.enable()
+    reenable_pause_after_achievements.enable()
 
 
 @hook(
@@ -42,15 +47,67 @@ def open_pause_post(*_: Any) -> None:
     inject_mods_into_pause_screen.disable()
 
 
-@hook("WillowGame.WillowGFxMenuPause:extMainDebug", immediately_enable=True)
-def pause_activate(
+# Since we can't safely pass callback names into ActionScript, have to detect when you click mods by
+# the menu sound. This has quite some complications trying not to trigger while in other menus...
+@hook("GearboxFramework.GearboxGFxMovie:PlaySpecialUISound")
+def pause_play_sound(
     obj: UObject,
-    _args: WrappedStruct,
+    args: WrappedStruct,
     _ret: Any,
     _func: BoundFunction,
-) -> type[Block]:
+) -> None:
+    if args.SoundString != "Confirm":
+        return
+
+    # Disable this hook now, regardless of what screen we actually went into, to try avoid firing
+    # spuriously. If we back out of the next screen, another hook should re-enable us.
+    pause_play_sound.disable()
+
+    if (menu := current_menu()) is None:
+        return
+
+    if len(menu.ScreenStack) > 1:
+        # Sanity check, should only be able to fire on the top screen
+        return
+
+    if menu.GetVariableString(find_focused_item(obj) + ".mLabel.text") != "Mods":
+        return
+
     # We don't seem to be able to open the multiplayer lobby menu from in game - even if we force
     # load it's definition - so instead just open a standard options list showing each mod
     create_mod_list_options_menu(obj)
 
-    return Block
+
+# If we open a nested movie (e.g. lobby, quit), we won't re-init the pause menu when we leave it
+# This hook will detect when we return to the pause movie, so we can re-enable the sound hook
+@hook("WillowGame.WillowGFxUIManager:UpdateFocus", hook_type=Type.POST)
+def reenable_pause_after_nested(
+    obj: UObject,
+    _args: WrappedStruct,
+    _ret: Any,
+    _func: BoundFunction,
+) -> None:
+    if (menu := current_menu()) is None:
+        return
+
+    # If we've re-enabled the current pause movie
+    if menu == obj.GetPlayingMovie():
+        # Re-enable the sound hook
+        pause_play_sound.enable()
+
+
+@hook("WillowGame.WillowGFxMenuPause:extViewAchievements")
+def reenable_pause_after_achievements(*_: Any) -> None:
+    # Since the achievements menu just opens the steam overlay, with no in game menus, immediately
+    # re-enable the sound hook
+    pause_play_sound.enable()
+
+
+@hook("WillowGame.WillowGFxMenuPause:OnClose", immediately_enable=True)
+def pause_close(*_: Any) -> None:
+    global current_menu
+    current_menu = WeakPointer()
+
+    pause_play_sound.disable()
+    reenable_pause_after_nested.disable()
+    reenable_pause_after_achievements.disable()