Merge pull request #59 from Justin99x/master

Load default values for save options

Author: apple1417

changelog.md

@@ -11,6 +11,10 @@
 ### [Mods Base v1.10](https://github.com/bl-sdk/mods_base/blob/master/Readme.md#v19)
 > - Linting fixups.
 
+### Save Options v1.2
+- Fixed issue where loading a character with no save option data inherited option values from
+  previous character.
+
 ### UI Utils v1.3
 - Linting fixes.
 

src/save_options/__init__.py

@@ -25,7 +25,7 @@
     "register_save_options",
 )
 
-__version_info__: tuple[int, int] = (1, 1)
+__version_info__: tuple[int, int] = (1, 2)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

src/save_options/hooks.py

@@ -8,7 +8,7 @@
 
 import save_options.options
 from mods_base import JSON, get_pc, hook
-from save_options.options import trigger_save
+from save_options.options import set_option_to_default, trigger_save
 from save_options.registration import (
     ModSaveOptions,
     load_callbacks,
@@ -126,6 +126,13 @@ def end_load_game(_1: UObject, _2: WrappedStruct, ret: Any, _4: BoundFunction) -
     # loading character in main menu also. No callback here because the timing of when this is
     # called doesn't make much sense to do anything with it. See hook on LoadPlayerSaveGame.
 
+    # Often we'll load a save from a character with no save data. We'll set all save options
+    # to default first to cover for any missing data.
+
+    for mod_save_options in registered_save_options.values():
+        for save_option in mod_save_options.values():
+            set_option_to_default(save_option)
+
     # This function returns the new save game object, so use a post hook and grab it from `ret`
     save_game = ret
     if not save_game:

src/save_options/options.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Any
+from typing import Any, cast
 
 from unrealsdk import make_struct
 from unrealsdk.hooks import Type, prevent_hooking_direct_calls
@@ -15,11 +15,28 @@
     get_pc,
     hook,
 )
-from mods_base.options import DropdownOption, KeybindOption
+from mods_base.options import BaseOption, DropdownOption, GroupedOption, KeybindOption, NestedOption
 
 any_option_changed: bool = False
 
 
+def set_option_to_default(save_option: BaseOption) -> None:
+    """
+    Sets an option's value to its default.
+
+    For GroupedOption and NestedOption, recursively sets all children to their default values.
+    """
+    match save_option:
+        case ValueOption():
+            val_opt = cast(ValueOption[Any], save_option)
+            val_opt.value = val_opt.default_value
+        case GroupedOption() | NestedOption():
+            for child in save_option.children:
+                set_option_to_default(child)
+        case _:
+            pass
+
+
 def can_save() -> bool:
     """Checks if a character is loaded that we can save to."""
     pc = get_pc()