Merge 'Improve settings string parse error message' (#2532)

Author: fenhl

CHANGELOG.md

@@ -18,6 +18,7 @@
 * Fix a vanilla bug where playing the ocarina with vibrato before recording the Scarecrow's Song could prevent Pierre from spawning.
 * Fix unshuffled treasure box shop keys showing the wrong item model while inside the chests if `Key Appearance Matches Dungeon` is enabled.
 * Add two missing locations: `Ganons Castle MQ Shadow Trial Explosives Wonderitem` and a `Bombable Fairy` in MQ Jabu.
+* Improve the error message when a settings string from the wrong randomizer version is imported.
 
 # 9.0
 

Settings.py

@@ -205,6 +205,12 @@ def update_with_settings_string(self, text: str) -> None:
                 index = 0
                 for b in range(setting.bitwidth):
                     index |= cur_bits[b] << b
+                if index >= len(setting.choice_list):
+                    raise ValueError(
+                        f"Settings string is invalid or was generated by a different version "
+                        f"of the randomizer. Setting '{setting.name}' contains index "
+                        f"{index} but only {len(setting.choice_list)} choices are available."
+                    )
                 value = setting.choice_list[index]
             elif setting.type == int:
                 value = 0
@@ -225,7 +231,12 @@ def update_with_settings_string(self, text: str) -> None:
                     if index == max_index:
                         value = [item for item in setting.choice_list if item not in value]
                         break
-
+                    if index - 1 >= len(setting.choice_list):
+                        raise ValueError(
+                            f"Settings string is invalid or was generated by a different version "
+                            f"of the randomizer. Setting '{setting.name}' contains index "
+                            f"{index} but only {len(setting.choice_list)} choices are available."
+                        )
                     value.append(setting.choice_list[index-1])
                     cur_bits = bits[:setting.bitwidth]
                     bits = bits[setting.bitwidth:]

version.py

@@ -1,4 +1,4 @@
-__version__ = '9.0.19'
+__version__ = '9.0.20'
 
 # This is a supplemental version number for branches based off of main dev.
 supplementary_version = 0