try address options menu crashes

Author: apple1417

src/willow1_mod_menu/lobby.py

@@ -1,6 +1,6 @@
 # ruff: noqa: D103
 import re
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 import unrealsdk
 from unrealsdk.hooks import Block
@@ -9,34 +9,19 @@
 from mods_base import CoopSupport, Game, Mod, get_ordered_mod_list, hook, html_to_plain_text
 from mods_base.mod_list import base_mod
 
+from .util import find_focused_item
+
 # from .options import create_mod_options_menu
 
 type WillowGFxLobbyMultiplayer = UObject
 type WillowGFxMenuFrontend = UObject
 
-if TYPE_CHECKING:
-    from enum import auto
-
-    from unrealsdk.unreal._uenum import UnrealEnum  # pyright: ignore[reportMissingModuleSource]
-
-    class ASType(UnrealEnum):
-        AS_Undefined = auto()
-        AS_Null = auto()
-        AS_Number = auto()
-        AS_String = auto()
-        AS_Boolean = auto()
-        AS_MAX = auto()
-
-else:
-    from unrealsdk import find_enum
-
-    ASType = find_enum("ASType")
 
 FRIENDLY_DISPLAY_VERSION = unrealsdk.config.get("willow1_mod_menu", {}).get(
     "display_version",
     base_mod.version,
 )
-RE_SELECTED_IDX = re.compile(r"_level\d+\.mMenu\.mList\.item(\d+)$")
+RE_SELECTED_IDX = re.compile(r"^_level\d+\.mMenu\.mList\.item(\d+)$")
 
 current_menu = WeakPointer()
 drawn_mods: list[Mod] = []
@@ -165,15 +150,8 @@ def get_focused_mod(menu: WillowGFxLobbyMultiplayer) -> Mod | None:
     Returns:
         The selected mod, or None if unable to find.
     """
-    # Being a little awkward so we can use .emplace_struct
-    # This pattern isn't that important for single arg functions, but for longer ones it adds up
-    invoke = menu.Invoke
-    invoke_args = WrappedStruct(invoke.func)
-    invoke_args.Method = "findFocusedItem"
-    invoke_args.args.emplace_struct(Type=ASType.AS_Number, N=0)
-    selected = invoke(invoke_args).S
-
-    match = RE_SELECTED_IDX.match(selected)
+    focused = find_focused_item(menu)
+    match = RE_SELECTED_IDX.match(focused)
     if match is None:
         return None
 

src/willow1_mod_menu/options.py

@@ -1,6 +1,7 @@
-# ruff: noqa: D103, TD002, TD003, FIX002
+# ruff: noqa: D103
 from __future__ import annotations
 
+import re
 from typing import TYPE_CHECKING, Any
 
 import unrealsdk
@@ -9,10 +10,14 @@
 
 from mods_base import Mod, NestedOption, hook, html_to_plain_text
 
+from .util import find_focused_item
+
 if TYPE_CHECKING:
-    from .populators import Populator, WillowGFxMenu
+    from .populators import Populator
+    from .util import WillowGFxMenu
 
 CUSTOM_OPTIONS_MENU_TAG = "willow1-mod-menu:custom-option"
+RE_SELECTED_IDX = re.compile(r"^_level\d+\.menu\.selections\.mMenu\.mList\.item(\d+)$")
 
 populator_stack: list[Populator] = []
 
@@ -48,7 +53,7 @@ def open_new_generic_menu(menu: WillowGFxMenu) -> None:
     menu.PlayUISound("Confirm")
 
     tools = menu.GetLobbyTools()
-    tools.menuStart(0, CUSTOM_OPTIONS_MENU_TAG)
+    tools.menuStart(0)
 
     populator = populator_stack[-1]
     populator.populate(tools)
@@ -62,18 +67,40 @@ def open_new_generic_menu(menu: WillowGFxMenu) -> None:
     )
 
 
+def get_selected_idx(menu: WillowGFxMenu) -> int | None:
+    """
+    Gets the index of the currently selected option item.
+
+    Args:
+        menu: The current menu to read the selected item of.
+    Returns:
+        The selected index, or None if unable to find.
+    """
+    focused = find_focused_item(menu)
+    match = RE_SELECTED_IDX.match(focused)
+    if match is None:
+        return None
+
+    try:
+        return int(match.group(1))
+    except ValueError:
+        return None
+
+
 @hook("WillowGame.WillowGFxMenu:extKeybinds")
 def custom_menu_activate(
     obj: UObject,
-    args: WrappedStruct,
+    _args: WrappedStruct,
     _ret: Any,
     _func: BoundFunction,
 ) -> type[Block]:
     try:
         populator = populator_stack[-1]
     except IndexError:
         return Block
-    populator.on_activate(obj, args.MenuTag)
+    if (idx := get_selected_idx(obj)) is None:
+        return Block
+    populator.on_activate(obj, idx)
     return Block
 
 
@@ -88,7 +115,9 @@ def custom_menu_spinner_change(
         populator = populator_stack[-1]
     except IndexError:
         return Block
-    populator.on_spinner_change(obj, args.MenuTag, args.IValue)
+    if (idx := get_selected_idx(obj)) is None:
+        return Block
+    populator.on_spinner_change(obj, idx, args.IValue)
     return Block
 
 
@@ -103,7 +132,9 @@ def custom_menu_slider_change(
         populator = populator_stack[-1]
     except IndexError:
         return Block
-    populator.on_slider_change(obj, args.MenuTag, args.Value)
+    if (idx := get_selected_idx(obj)) is None:
+        return Block
+    populator.on_slider_change(obj, idx, args.Value)
     return Block
 
 

src/willow1_mod_menu/populators/__init__.py

@@ -7,8 +7,8 @@
 from unrealsdk.unreal import UObject
 
 from mods_base import BaseOption, BoolOption, DropdownOption, SliderOption, SpinnerOption
+from willow1_mod_menu.util import WillowGFxMenu
 
-type WillowGFxMenu = UObject
 type WillowGFxLobbyTools = UObject
 
 
@@ -18,10 +18,10 @@
 @dataclass
 class Populator(ABC):
     title: str
-    drawn_options: dict[str, BaseOption] = field(
+    drawn_options: list[BaseOption] = field(
         init=False,
         repr=False,
-        default_factory=dict[str, BaseOption],
+        default_factory=list[BaseOption],
     )
 
     @abstractmethod
@@ -60,7 +60,7 @@ def draw_text(self, tools: WillowGFxLobbyTools, text: str, option: BaseOption) -
         """
         tag = self._get_next_tag(option)
         tools.menuAddItem(0, text, tag, "extKeybinds")
-        self.drawn_options[tag] = option
+        self.drawn_options.append(option)
 
     def draw_spinner(
         self,
@@ -107,7 +107,7 @@ def draw_spinner(
             config_str,
             "Change:extSpinnerChanged",
         )
-        self.drawn_options[tag] = option
+        self.drawn_options.append(option)
 
     def draw_slider(
         self,
@@ -138,62 +138,67 @@ def draw_slider(
             f"Min:{min_value},Max:{max_value},Step:{step},Value:{value}",
             "Change:extSliderChanged",
         )
-        self.drawn_options[tag] = option
+        self.drawn_options.append(option)
 
-    def on_activate(self, menu: WillowGFxMenu, tag: str) -> None:
+    def on_activate(self, menu: WillowGFxMenu, idx: int) -> None:
         """
         Handles a raw menu item activation.
 
         Args:
             menu: The currently open menu.
-            tag: The tag of the item which was activated.
+            idx: The index of the item which was activated.
         """
-        if (option := self.drawn_options.get(tag)) is None:
-            logging.error(f"Can't find option '{tag}' which was changed")
+        try:
+            option = self.drawn_options[idx]
+        except IndexError:
+            logging.error(f"Can't find option which was changed at index {idx}")
             return
 
         self.handle_activate(menu, option)
 
-    def on_spinner_change(self, menu: WillowGFxMenu, tag: str, idx: int) -> None:
+    def on_spinner_change(self, menu: WillowGFxMenu, idx: int, choice_idx: int) -> None:
         """
         Handles a raw spinner change.
 
         Args:
             menu: The currently open menu.
-            tag: The tag of the item which was activated.
-            idx: The newly selected choice's index.
+            idx: The index of the item which was activated.
+            choice_idx: The newly selected choice's index.
         """
         _ = menu
-
-        if (option := self.drawn_options.get(tag)) is None:
-            logging.error(f"Can't find option '{tag}' which was changed")
+        try:
+            option = self.drawn_options[idx]
+        except IndexError:
+            logging.error(f"Can't find option which was changed at index {idx}")
             return
 
         match option:
             case BoolOption():
-                option.value = bool(idx)
+                option.value = bool(choice_idx)
             case DropdownOption() | SpinnerOption():
-                option.value = option.choices[idx]
+                option.value = option.choices[choice_idx]
             case _:
                 logging.error(
                     f"Option '{option.identifier}' got a spinner change event despite not being a"
                     " spinner",
                 )
 
-    def on_slider_change(self, menu: WillowGFxMenu, tag: str, value: float) -> None:
+    def on_slider_change(self, menu: WillowGFxMenu, idx: int, value: float) -> None:
         """
         Handles a raw slider change.
 
         Args:
             menu: The currently open menu.
-            tag: The tag of the item which was activated.
+            idx: The index of the item which was activated.
             value: The new value of the slider.
         """
         _ = menu
-
-        if (option := self.drawn_options.get(tag)) is None:
-            logging.error(f"Can't find option '{tag}' which was changed")
+        try:
+            option = self.drawn_options[idx]
+        except IndexError:
+            logging.error(f"Can't find option which was changed at index {idx}")
             return
+
         if not isinstance(option, SliderOption):
             logging.error(
                 f"Option '{option.identifier}' got a spinner change event despite not being a"

src/willow1_mod_menu/util.py

@@ -0,0 +1,39 @@
+from typing import TYPE_CHECKING
+
+from unrealsdk.unreal import UObject, WrappedStruct
+
+if TYPE_CHECKING:
+    from enum import auto
+
+    from unrealsdk.unreal._uenum import UnrealEnum  # pyright: ignore[reportMissingModuleSource]
+
+    class ASType(UnrealEnum):
+        AS_Undefined = auto()
+        AS_Null = auto()
+        AS_Number = auto()
+        AS_String = auto()
+        AS_Boolean = auto()
+        AS_MAX = auto()
+
+else:
+    from unrealsdk import find_enum
+
+    ASType = find_enum("ASType")
+
+type WillowGFxMenu = UObject
+
+
+def find_focused_item(menu: WillowGFxMenu) -> str:
+    """
+    Runs the 'findFocusedItem' ActionScript function on the given menu.
+
+    Args:
+        menu: The menu to invoke the function under
+    """
+    # Being a little awkward so we can use .emplace_struct
+    # This pattern isn't that important for single arg functions, but for longer ones it adds up
+    invoke = menu.Invoke
+    invoke_args = WrappedStruct(invoke.func)
+    invoke_args.Method = "findFocusedItem"
+    invoke_args.args.emplace_struct(Type=ASType.AS_Number, N=0)
+    return invoke(invoke_args).S