More ladder data

worlds/tunic/ladder_data.py

@@ -1,36 +1,63 @@
-from typing import Dict, List
+# for making rules for ladder storage in overworld
+from typing import Dict, Set, NamedTuple
+
+
+class LadderInfo(NamedTuple):
+    ladders: Set[str]  # ladders where the top or bottom is at the same elevation
+    portals: Set[str]  # portals at the same elevation
+    regions: Set[str]  # regions where a melee enemy can hit you out of ladder storage
+
 
 # groups for ladders at the same elevation, for use in determing whether you can ls to entrances in diff rulesets
-overworld_ladder_groups: Dict[str, List[str]] = {
-    # lowest elevation, in-line with swamp lower, rotating lights, atoll lower, west garden lower
-    "Group 1": ["Ladders in Overworld Town", "Ladder to Ruined Atoll", "Ladder to Swamp"],
-    # in-line with furnace from beach, swamp upper entrance
-    "Group 2": ["Ladders near Weathervane", "Ladders in Overworld Town", "Ladder to Swamp"],
-    # in-line with west garden upper, ruined passage
-    "Group 3": ["Ladders near Weathervane", "Ladders to West Bell"],
-    # in-line with old house door, chest above ruined passage
-    "Group 4": ["Ladders near Weathervane", "Ladder to Quarry", "Ladders to West Bell", "Ladders in Overworld Town"],
+overworld_ladder_groups: Dict[str, LadderInfo] = {
+    # lowest elevation
+    "Group 0": LadderInfo({"Ladders in Overworld Town", "Ladder to Ruined Atoll", "Ladder to Swamp"},
+                          {"Swamp Redux 2_conduit", "Overworld Cave_", "Atoll Redux_lower", "Maze Room_",
+                           "Town Basement_beach", "Archipelagos Redux_lowest"},
+                          {"Overworld Beach"}),
+    "Group 1": LadderInfo({"Ladders near Weathervane", "Ladders in Overworld Town", "Ladder to Swamp"},
+                          {"Furnace_gyro_lower", "Swamp Redux 2_wall"},
+                          {"Overworld Tunnel Turret"}),
+    "Group 2": LadderInfo({"Ladders near Weathervane", "Ladders to West Bell"},
+                          {"Archipelagos Redux_lower", "Ruins Passage_east", "Ruins Passage_west"},
+                          {"After Ruined Passage"}),
+    "Group 3": LadderInfo({"Ladders near Weathervane", "Ladder to Quarry", "Ladders to West Bell",
+                           "Ladders in Overworld Town"},
+                          {"Overworld Interiors_house"},
+                          {"Overworld after Envoy", "East Overworld"}),
     # skip top of top ladder next to weathervane level, does not provide logical access to anything
-    # in-line with quarry
-    "Group 5": ["Ladders near Dark Tomb", "Ladder to Quarry", "Ladders to West Bell", "Ladders in Overworld Town",
-                "Ladders in Well"],
-    # in-line with patrol cave, east forest, fortress, and stairs towards special shop
-    "Group 6": ["Ladders near Overworld Checkpoint", "Ladders near Patrol Cave"],
-    # skip top of belltower and middle of dark tomb ladders, does not grant access to anything
-    # in-line with temple rafters entrance, can get you to patrol cave ladders via knocking out of ls
-    "Group 7": ["Ladders near Patrol Cave", "Ladder near Temple Rafters"],
+    "Group 4": LadderInfo({"Ladders near Dark Tomb", "Ladder to Quarry", "Ladders to West Bell",
+                           "Ladders in Overworld Town", "Ladders in Well"},
+                          {"Darkwoods Tunnel_"},
+                          set()),
+    "Group 5": LadderInfo({"Ladders near Overworld Checkpoint", "Ladders near Patrol Cave"},
+                          {"Temple_main", "PatrolCave_", "Forest Belltower_", "Fortress Courtyard_", "ShopSpecial_"},
+                          {"East Overworld"}),
+    # skip top of belltower, middle of dark tomb ladders, and top of checkpoint, does not grant access to anything
+    "Group 6": LadderInfo({"Ladders near Patrol Cave", "Ladder near Temple Rafters"},
+                          {"Temple_rafters"},
+                          {"Overworld above Patrol Cave"}),
     # in-line with the chest above dark tomb, gets you up the mountain stairs
-    "Group 8": ["Ladders near Patrol Cave", "Ladder near Temple Rafters", "Ladders near Dark Tomb"],
+    "Group 7": LadderInfo({"Ladders near Patrol Cave", "Ladder near Temple Rafters", "Ladders near Dark Tomb"},
+                          {"Mountain_"},
+                          {"Upper Overworld"}),
 }
 
 
 # ladders accessible within different regions of overworld, only those that are relevant
 # other scenes will just have them hardcoded since this type of structure is not necessary there
-region_ladders: Dict[str, List[str]] = {
-    "Overworld": ["Ladders near Weathervane", "Ladders near Overworld Checkpoint", "Ladders near Dark Tomb",
-                  "Ladders in Overworld Town", "Ladder to Swamp", "Ladders in Well"],
-    "Overworld Beach": ["Ladder to Ruined Atoll"],
-    "Overworld at Patrol Cave": ["Ladders near Patrol Cave"],
-    "Overworld Quarry Entry": ["Ladder to Quarry"],
-    "Overworld Belltower": ["Ladders to West Bell"],
-}
+region_ladders: Dict[str, Set[str]] = {
+    "Overworld": {"Ladders near Weathervane", "Ladders near Overworld Checkpoint", "Ladders near Dark Tomb",
+                  "Ladders in Overworld Town", "Ladder to Swamp", "Ladders in Well"},
+    "Overworld Beach": {"Ladder to Ruined Atoll"},
+    "Overworld at Patrol Cave": {"Ladders near Patrol Cave"},
+    "Overworld Quarry Entry": {"Ladder to Quarry"},
+    "Overworld Belltower": {"Ladders to West Bell"},
+}
+
+
+def ladder_and_lower(index: int) -> Set[str]:
+    ladder_set: Set[str] = set()
+    for i in range(index):
+        ladder_set.update(overworld_ladder_groups[f"Group {i}"].ladders)
+    return ladder_set