From ca8ffe583d019c9a82928757263e5daee4cafbd3 Mon Sep 17 00:00:00 2001
From: Doug Hoskisson <beauxq@users.noreply.github.com>
Date: Sun, 19 Jan 2025 15:31:09 -0800
Subject: [PATCH] Zillion: Priority Dead Ends Feature (#4220)

---
 worlds/zillion/__init__.py         | 14 ++++++++++++++
 worlds/zillion/options.py          | 15 +++++++++++++++
 worlds/zillion/requirements.txt    |  2 +-
 worlds/zillion/test/TestOptions.py | 17 ++++++++++++++++-
 4 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/worlds/zillion/__init__.py b/worlds/zillion/__init__.py
index 58f513ba..d0064b9c 100644
--- a/worlds/zillion/__init__.py
+++ b/worlds/zillion/__init__.py
@@ -24,6 +24,7 @@ from .patch import ZillionPatch
 from zilliandomizer.system import System
 from zilliandomizer.logic_components.items import RESCUE, items as zz_items, Item as ZzItem
 from zilliandomizer.logic_components.locations import Location as ZzLocation, Req
+from zilliandomizer.map_gen.region_maker import DEAD_END_SUFFIX
 from zilliandomizer.options import Chars
 
 from worlds.AutoWorld import World, WebWorld
@@ -172,6 +173,7 @@ class ZillionWorld(World):
         self.logic_cache = logic_cache
         w = self.multiworld
         self.my_locations = []
+        dead_end_locations: list[ZillionLocation] = []
 
         self.zz_system.randomizer.place_canister_gun_reqs()
         # low probability that place_canister_gun_reqs() results in empty 1st sphere
@@ -224,6 +226,16 @@ class ZillionWorld(World):
                     here.locations.append(loc)
                     self.my_locations.append(loc)
 
+                    if ((
+                        zz_here.name.endswith(DEAD_END_SUFFIX)
+                    ) or (
+                        (self.options.map_gen.value != self.options.map_gen.option_full) and
+                        (loc.name in self.options.priority_dead_ends.vanilla_dead_ends)
+                    ) or (
+                        loc.name in self.options.priority_dead_ends.always_dead_ends
+                    )):
+                        dead_end_locations.append(loc)
+
             for zz_dest in zz_here.connections.keys():
                 dest_name = "Menu" if zz_dest.name == "start" else zz_reg_name_to_reg_name(zz_dest.name)
                 dest = all_regions[dest_name]
@@ -233,6 +245,8 @@ class ZillionWorld(World):
 
                 queue.append(zz_dest)
             done.add(here.name)
+        if self.options.priority_dead_ends.value:
+            self.options.priority_locations.value |= {loc.name for loc in dead_end_locations}
 
     @override
     def create_items(self) -> None:
diff --git a/worlds/zillion/options.py b/worlds/zillion/options.py
index 22a69847..13f3d43a 100644
--- a/worlds/zillion/options.py
+++ b/worlds/zillion/options.py
@@ -272,6 +272,20 @@ class ZillionMapGen(Choice):
         return "full"
 
 
+class ZillionPriorityDeadEnds(DefaultOnToggle):
+    """
+    Single locations that are in a dead end behind a door
+    (example: vanilla Apple location)
+    are prioritized for progression items.
+    """
+    display_name = "priority dead ends"
+
+    vanilla_dead_ends: ClassVar = frozenset(("E-5 top far right", "J-4 top left"))
+    """ dead ends when not generating these rooms """
+    always_dead_ends: ClassVar = frozenset(("A-6 top right",))
+    """ dead ends in rooms that never get generated """
+
+
 @dataclass
 class ZillionOptions(PerGameCommonOptions):
     continues: ZillionContinues
@@ -293,6 +307,7 @@ class ZillionOptions(PerGameCommonOptions):
     skill: ZillionSkill
     starting_cards: ZillionStartingCards
     map_gen: ZillionMapGen
+    priority_dead_ends: ZillionPriorityDeadEnds
 
     room_gen: Removed
 
diff --git a/worlds/zillion/requirements.txt b/worlds/zillion/requirements.txt
index d6b01ac1..4f79626c 100644
--- a/worlds/zillion/requirements.txt
+++ b/worlds/zillion/requirements.txt
@@ -1,2 +1,2 @@
-zilliandomizer @ git+https://github.com/beauxq/zilliandomizer@33045067f626266850f91c8045b9d3a9f52d02b0#0.9.0
+zilliandomizer @ git+https://github.com/beauxq/zilliandomizer@96d9a20f8278cee64bb4db859fbd874e0f332d36#0.9.1
 typing-extensions>=4.7, <5
diff --git a/worlds/zillion/test/TestOptions.py b/worlds/zillion/test/TestOptions.py
index 3820c32d..904063fd 100644
--- a/worlds/zillion/test/TestOptions.py
+++ b/worlds/zillion/test/TestOptions.py
@@ -1,6 +1,7 @@
 from . import ZillionTestBase
 
-from ..options import ZillionJumpLevels, ZillionGunLevels, ZillionOptions, validate
+from .. import ZillionWorld
+from ..options import ZillionJumpLevels, ZillionGunLevels, ZillionOptions, ZillionPriorityDeadEnds, validate
 from zilliandomizer.options import VBLR_CHOICES
 
 
@@ -28,3 +29,17 @@ class OptionsTest(ZillionTestBase):
                 assert getattr(zz_options, option_name) in VBLR_CHOICES
 
     # TODO: test validate with invalid combinations of options
+
+
+class DeadEndsTest(ZillionTestBase):
+    def test_vanilla_dead_end_names(self) -> None:
+        z_world = self.multiworld.worlds[1]
+        assert isinstance(z_world, ZillionWorld)
+        for loc_name in ZillionPriorityDeadEnds.vanilla_dead_ends:
+            assert any(loc.name == loc_name for loc in z_world.my_locations), f"{loc_name=} {z_world.my_locations=}"
+
+    def test_always_dead_end_names(self) -> None:
+        z_world = self.multiworld.worlds[1]
+        assert isinstance(z_world, ZillionWorld)
+        for loc_name in ZillionPriorityDeadEnds.always_dead_ends:
+            assert any(loc.name == loc_name for loc in z_world.my_locations), f"{loc_name=} {z_world.my_locations=}"