LADX: tarins gift improvement

worlds/ladx/LADXR/locations/startItem.py

@@ -7,23 +7,12 @@
 
 
 class StartItem(DroppedKey):
-    # We need to give something here that we can use to progress.
-    # FEATHER
-    OPTIONS = [SWORD, SHIELD, POWER_BRACELET, OCARINA,  BOOMERANG, MAGIC_ROD, TAIL_KEY, SHOVEL, HOOKSHOT, PEGASUS_BOOTS, MAGIC_POWDER, BOMB]
     MULTIWORLD = False
 
     def __init__(self):
         super().__init__(0x2A3)
         self.give_bowwow = False
 
-    def configure(self, options):
-        if options.bowwow != 'normal':
-            # When we have bowwow mode, we pretend to be a sword for logic reasons
-            self.OPTIONS = [SWORD]
-            self.give_bowwow = True
-        if options.randomstartlocation and options.entranceshuffle != 'none':
-            self.OPTIONS.append(FLIPPERS)
-
     def patch(self, rom, option, *, multiworld=None):
         assert multiworld is None
 

worlds/ladx/Options.py

@@ -501,6 +501,18 @@ class AdditionalWarpPoints(DefaultOffToggle):
     """
     display_name = "Additional Warp Points"
 
+
+class TarinsGift(Choice):
+    """
+    [Local Progression] Forces Tarin's gift to be an item that immediately opens up local checks.
+    Has little effect in single player games, and isn't always necessary with randomized entrances.
+    """
+    display_name = "Tarin's Gift"
+    option_local_progression = 0
+    option_any_item = 1
+    default = option_local_progression
+
+
 ladx_option_groups = [
     OptionGroup("Goal Options", [
         Goal,
@@ -521,6 +533,7 @@ class AdditionalWarpPoints(DefaultOffToggle):
     OptionGroup("Miscellaneous", [
         TradeQuest,
         Rooster,
+        TarinsGift,
         TrendyGame,
         NagMessages,
         BootsControls
@@ -579,3 +592,4 @@ class LinksAwakeningOptions(PerGameCommonOptions):
     nag_messages: NagMessages
     ap_title_screen: APTitleScreen
     boots_controls: BootsControls
+    tarins_gift: TarinsGift

worlds/ladx/__init__.py

@@ -8,7 +8,7 @@
 import bsdiff4
 
 import settings
-from BaseClasses import Entrance, Item, ItemClassification, Location, Tutorial, MultiWorld
+from BaseClasses import Entrance, Item, ItemClassification, Location, Tutorial, MultiWorld, CollectionState
 from Fill import fill_restrictive
 from worlds.AutoWorld import WebWorld, World
 from .Common import *
@@ -24,7 +24,7 @@
 from .LADXR.worldSetup import WorldSetup as LADXRWorldSetup
 from .Locations import (LinksAwakeningLocation, LinksAwakeningRegion,
                         create_regions_from_ladxr, get_locations_to_id)
-from .Options import DungeonItemShuffle, ShuffleInstruments, LinksAwakeningOptions, ladx_option_groups
+from .Options import DungeonItemShuffle, ShuffleInstruments, TarinsGift, LinksAwakeningOptions, ladx_option_groups
 from .Rom import LADXDeltaPatch, get_base_rom_path
 
 DEVELOPER_MODE = False
@@ -173,6 +173,8 @@ def create_event(self, event: str):
         return Item(event, ItemClassification.progression, None, self.player)
 
     def create_items(self) -> None:
+        itempool = []
+
         exclude = [item.name for item in self.multiworld.precollected_items[self.player]]
 
         dungeon_item_types = {
@@ -216,7 +218,7 @@ def create_items(self) -> None:
             for _ in range(count):
                 if item_name in exclude:
                     exclude.remove(item_name)  # this is destructive. create unique list above
-                    self.multiworld.itempool.append(self.create_item("Master Stalfos' Message"))
+                    itempool.append(self.create_item("Master Stalfos' Message"))
                 else:
                     item = self.create_item(item_name)
 
@@ -255,9 +257,9 @@ def create_items(self) -> None:
                                 self.prefill_own_dungeons.append(item)
                                 self.pre_fill_items.append(item)
                             else:
-                                self.multiworld.itempool.append(item)
+                                itempool.append(item)
                     else:
-                        self.multiworld.itempool.append(item)
+                        itempool.append(item)
 
         self.multi_key = self.generate_multi_key()
 
@@ -280,21 +282,35 @@ def create_items(self) -> None:
                     # Properly fill locations within dungeon
                     location.dungeon = r.dungeon_index
 
-        # For now, special case first item
-        FORCE_START_ITEM = True
-        if FORCE_START_ITEM:
-            self.force_start_item()
+        if self.options.tarins_gift == TarinsGift.option_local_progression:
+            self.force_start_item(itempool)
+
+        self.multiworld.itempool += itempool
 
-    def force_start_item(self):    
+    def force_start_item(self, itempool):
         start_loc = self.multiworld.get_location("Tarin's Gift (Mabe Village)", self.player)
         if not start_loc.item:
-            possible_start_items = [index for index, item in enumerate(self.multiworld.itempool)
-                if item.player == self.player 
-                    and item.item_data.ladxr_id in start_loc.ladxr_item.OPTIONS and not item.location]
-            if possible_start_items:
-                index = self.random.choice(possible_start_items)
-                start_item = self.multiworld.itempool.pop(index)
-                start_loc.place_locked_item(start_item)
+            """
+            Find an item that forces progression for the player
+            """
+            base_collection_state = CollectionState(self.multiworld)
+            base_collection_state.update_reachable_regions(self.player)
+            reachable_count = len(base_collection_state.reachable_regions[self.player])
+
+            def gives_progression(item):
+                collection_state = base_collection_state.copy()
+                collection_state.collect(item)
+                # Why isn't this needed?
+                # collection_state.update_reachable_regions(self.player)
+                return len(collection_state.reachable_regions[self.player]) > reachable_count
+            possible_start_items = [item for item in itempool if item.advancement]
+            self.random.shuffle(possible_start_items)
+
+            for item in possible_start_items:
+                if gives_progression(item):
+                    itempool.remove(item)
+                    start_loc.place_locked_item(item)
+                    return
 
     def get_pre_fill_items(self):
         return self.pre_fill_items