SM: 0.4.1 Fixes and Additional Objective Options

worlds/sm/Options.py

@@ -1,5 +1,5 @@
 import typing
-from Options import Choice, Range, OptionDict, OptionList, Option, Toggle, DefaultOnToggle
+from Options import Choice, Range, OptionDict, OptionList, OptionSet, Option, Toggle, DefaultOnToggle
 from .variaRandomizer.utils.objectives import _goals
 
 class StartItemsRemovesFromPool(Toggle):
@@ -136,7 +136,7 @@ class AreaLayout(Toggle):
 
 class DoorsColorsRando(Toggle):
     """Randomize the color of Red/Green/Yellow doors. Add four new type of doors which require Ice/Wave/Spazer/Plasma
-    beams to open them. When enabled, will force those beams as local items."""
+    beams to open them."""
     display_name = "Doors Colors Rando"
 
 class AllowGreyDoors(Toggle):
@@ -215,7 +215,11 @@ class Hud(Toggle):
     display_name = "Hud"
 
 class Animals(Toggle):
-    """Replace saving the animals in the escape sequence by a random surprise."""
+    """
+    Replace saving the animals in the escape sequence by a random surprise.
+    Note: This setting is not available when Escape Randomization is enabled, as it is replaced by Animals Challenges
+    (see Escape Randomization help for more information).
+    """
     display_name = "Animals"
 
 class NoMusic(Toggle):
@@ -286,17 +290,52 @@ class Tourian(Choice):
     option_Disabled = 2
     default = 0  
 
-class Objective(OptionList):
+class CustomObjective(Toggle):
+    """
+    Use randomized custom objectives. You can choose which objectives are available for the randomizer to choose from. If enabled, the randomizer 
+    will choose "Custom objective count" objectives from "Custom objective list". Otherwise, only objective is used. Default is disabled.
+    """
+    display_name = "Custom objectives"
+
+class CustomObjectiveCount(Range):
     """
-    Choose which objectives are required to sink the Golden Four statue and to open access to Tourian.
-    You can choose from 0 to 5 objectives.
+    By default you need to complete 4 objectives from the list to access Tourian. You can choose between 1 and 5. This setting is ignored if
+    ""Custom objectives"" is set to false.
+    """
+    display_name = "Custom objective count"
+    range_start = 1
+    range_end = 5
+    default = 4
+
+class CustomObjectiveList(OptionSet):
+    """
+    If ""Custom objectives"" is enabled, "Custom Objective count" will be used to pick an amount of objective from the list.
+    This setting is ignored if ""Custom objectives"" is set to false.
     Note: If you leave the list empty no objective is required to access Tourian, ie. it's open.
     Note: See the Tourian parameter to enable fast Tourian or trigger the escape when all objectives are completed.
     Note: Current percentage of collected items is displayed in the inventory pause menu.
-    Note: Collect 100% items is excluded by default when randomizing the objectives list as it requires you to complete all the objectives.
+    Note: Collect 100% items is excluded by default as it requires you to complete all the objectives.
     Note: In AP, Items% and areas objectives are counted toward location checks, not items collected or received, except for "collect all upgrades"
+
+    Format as a comma-separated list of objective names: ["kill three G4", "collect 75% items"] or ["random"] to specify the whole list except
+    "collect 100% items" and "nothing". The default is ["random"]. A full list of supported objectives can be found at:
+    https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/sm/variaRandomizer/utils/objectives.py
+    """
+    display_name = "Custom objective list"
+    default = ["random"]
+    valid_keys = frozenset([name for name in _goals.keys()] + ["random"])
+    #valid_keys_casefold = True
 
-    Format as a comma-separated list of objective names: ["kill three G4", "collect 75% items"].
+class Objective(OptionSet):
+    """
+    If ""Custom objectives"" is disabled, choose which objectives are required to sink the Golden Four statue and to open access to Tourian.
+    You can choose from 0 to 5 objectives. Up to the first 5 objectives from the list will be selected.
+    Note: If you leave the list empty no objective is required to access Tourian, ie. it's open.
+    Note: See the Tourian parameter to enable fast Tourian or trigger the escape when all objectives are completed.
+    Note: Current percentage of collected items is displayed in the inventory pause menu.
+    Note: In AP, Items% and areas objectives are counted toward location checks, not items collected or received, except for "collect all upgrades"
+
+    Format as a comma-separated list of objective names: ["kill three G4", "collect 75% items"]. The default is ["kill all G4"].
     A full list of supported objectives can be found at:
     https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/sm/variaRandomizer/utils/objectives.py
     """
@@ -386,6 +425,9 @@ class RelaxedRoundRobinCF(Toggle):
     "custom_preset": CustomPreset,
     "varia_custom_preset": VariaCustomPreset,
     "tourian": Tourian,
+    "custom_objective": CustomObjective,
+    "custom_objective_list": CustomObjectiveList,
+    "custom_objective_count": CustomObjectiveCount,
     "objective": Objective,
     "relaxed_round_robin_cf": RelaxedRoundRobinCF,
     }

worlds/sm/__init__.py

@@ -40,7 +40,7 @@ def init_mixin(self, parent: MultiWorld):
         # for unit tests where MultiWorld is instantiated before worlds
         if hasattr(parent, "state"):
             self.smbm = {player: SMBoolManager(player, parent.state.smbm[player].maxDiff,
-                                    parent.state.smbm[player].onlyBossLeft, parent.state.smbm[player].lastAP) for player in
+                                    parent.state.smbm[player].onlyBossLeft) for player in
                                         parent.get_game_players("Super Metroid")}
             for player, group in parent.groups.items():
                 if (group["game"] == "Super Metroid"):
@@ -99,13 +99,15 @@ class SMWorld(World):
     required_client_version = (0, 2, 6)
 
     itemManager: ItemManager
+    spheres = None
 
     Logic.factory('vanilla')
 
     def __init__(self, world: MultiWorld, player: int):
         self.rom_name_available_event = threading.Event()
         self.locations = {}
-        self.need_comeback_check = True
+        if SMWorld.spheres != None:
+            SMWorld.spheres = None
         super().__init__(world, player)
 
     @classmethod
@@ -118,7 +120,7 @@ def generate_early(self):
         Logic.factory('vanilla')
 
         self.variaRando = VariaRandomizer(self.multiworld, get_base_rom_path(), self.player)
-        self.multiworld.state.smbm[self.player] = SMBoolManager(self.player, self.variaRando.maxDifficulty, lastAP = self.variaRando.args.startLocation)
+        self.multiworld.state.smbm[self.player] = SMBoolManager(self.player, self.variaRando.maxDifficulty)
 
         # keeps Nothing items local so no player will ever pickup Nothing
         # doing so reduces contribution of this world to the Multiworld the more Nothing there is though
@@ -177,12 +179,7 @@ def create_items(self):
                             item.Type,
                             None if itemClass == 'Boss' else self.item_name_to_id[item.Name], 
                             player=self.player)
-
-            beamItems = ['Spazer', 'Ice', 'Wave' ,'Plasma']
-            if self.multiworld.doors_colors_rando[self.player].value != 0:
-                if item.Type in beamItems:
-                    self.multiworld.local_items[self.player].value.add(item.Name)
-
+
             if itemClass == 'Boss':
                 self.locked_items[item.Name] = smitem
             elif item.Category == 'Nothing':
@@ -217,19 +214,13 @@ def set_entrance_rule(entrance, player, func):
 
         self.multiworld.completion_condition[self.player] = lambda state: state.has('Mother Brain', self.player)
 
-        ammoItems = ['Missile', 'Super', 'PowerBomb']
         for key, value in locationsDict.items():
             location = self.multiworld.get_location(key, self.player)
             set_available_rule(location, self.player, value.Available)
             if value.AccessFrom is not None:
                 add_accessFrom_rule(location, self.player, value.AccessFrom)
             if value.PostAvailable is not None:
                 add_postAvailable_rule(location, self.player, value.PostAvailable)
-
-            if self.multiworld.doors_colors_rando[self.player].value != 0:
-                add_item_rule(location, lambda item:    item.game != self.game or item.type not in ammoItems or 
-                                                        (item.type in ammoItems and \
-                                                        (not item.advancement or (item.advancement and item.player == self.player))))
 
         for accessPoint in Logic.accessPoints:
             if not accessPoint.Escape:
@@ -304,11 +295,6 @@ def create_regions(self):
 
     def collect(self, state: CollectionState, item: Item) -> bool:
         state.smbm[self.player].addItem(item.type)
-        if item.location != None and item.location.game == self.game:
-            for entrance in self.multiworld.get_region(item.location.parent_region.name, item.location.player).entrances:
-                if (entrance.parent_region.can_reach(state)):
-                    state.smbm[item.location.player].lastAP = entrance.parent_region.name
-                    break
         return super(SMWorld, self).collect(state, item)
 
     def remove(self, state: CollectionState, item: Item) -> bool:
@@ -359,42 +345,57 @@ def pre_fill(self):
                 loc.address = loc.item.code = None
 
     def post_fill(self):
+        # Having a sorted itemLocs from collection order is required for escapeTrigger when Tourian is Disabled.
+        # We cant use stage_post_fill for this as its called after worlds' post_fill.
+        # get_spheres could be cached in multiworld?
+        # Another possible solution would be to have a globally accessible list of items in the order in which the get placed in push_item
+        # and use the inversed starting from the first progression item.
+        if (SMWorld.spheres == None):
+            SMWorld.spheres = [itemLoc for sphere in self.multiworld.get_spheres() for itemLoc in sorted(sphere, key=lambda location: location.name)]
+
         self.itemLocs = [
-            ItemLocation(ItemManager.Items[itemLoc.item.type
+            ItemLocation(copy.copy(ItemManager.Items[itemLoc.item.type
                          if isinstance(itemLoc.item, SMItem) and itemLoc.item.type in ItemManager.Items else
-                         'ArchipelagoItem'],
-                         locationsDict[itemLoc.name], itemLoc.item.player, True)
+                         'ArchipelagoItem']),
+                         copy.copy(locationsDict[itemLoc.name]), itemLoc.item.player, True)
             for itemLoc in self.multiworld.get_locations(self.player)
         ]
-        self.progItemLocs = [
-            ItemLocation(ItemManager.Items[itemLoc.item.type
-                         if isinstance(itemLoc.item, SMItem) and itemLoc.item.type in ItemManager.Items else
-                         'ArchipelagoItem'],
-                         locationsDict[itemLoc.name], itemLoc.item.player, True)
-            for itemLoc in self.multiworld.get_locations(self.player) if itemLoc.item.advancement
-        ]
-        for itemLoc in self.itemLocs:
-            if itemLoc.Item.Class == "Boss":
-                itemLoc.Item.Class = "Minor"
-        for itemLoc in self.progItemLocs:
-            if itemLoc.Item.Class == "Boss":
-                itemLoc.Item.Class = "Minor"
 
-        localItemLocs = [il for il in self.itemLocs if il.player == self.player]
-        localprogItemLocs = [il for il in self.progItemLocs if il.player == self.player]
+        escapeTrigger = None
+        if self.variaRando.randoExec.randoSettings.restrictions["EscapeTrigger"]:
+            #used to simulate received items
+            first_local_collected_loc = next(itemLoc for itemLoc in SMWorld.spheres if itemLoc.player == self.player)
+
+            playerItemsItemLocs =   [
+                                    ItemLocation(copy.copy(ItemManager.Items[
+                                        itemLoc.item.type if isinstance(itemLoc.item, SMItem) and itemLoc.item.type in ItemManager.Items else
+                                        'ArchipelagoItem']),
+                                        copy.copy(locationsDict[itemLoc.name] if itemLoc.game == self.game else
+                                                  locationsDict[first_local_collected_loc.name]), 
+                                        itemLoc.item.player, 
+                                        True)
+                                        for itemLoc in SMWorld.spheres if itemLoc.item.player == self.player
+                                    ]
+            for itemLoc in playerItemsItemLocs:
+                if itemLoc.Item.Class == "Boss":
+                    itemLoc.Item.Class = "Minor"
+
+            playerProgItemsItemLocs = [itemLoc for itemLoc in playerItemsItemLocs if itemLoc.item.advancement]
+
+            escapeTrigger = (playerItemsItemLocs, playerProgItemsItemLocs, 'Full')
 
-        escapeTrigger = (localItemLocs, localprogItemLocs, 'Full') if self.variaRando.randoExec.randoSettings.restrictions["EscapeTrigger"] else None
         escapeOk = self.variaRando.randoExec.graphBuilder.escapeGraph(self.variaRando.container, self.variaRando.randoExec.areaGraph, self.variaRando.randoExec.randoSettings.maxDiff, escapeTrigger)
-        assert escapeOk, "Could not find a solution for escape"
-
+        if (not escapeOk):
+            logger.warning(f"Escape Rando forced to 'Off' for player {self.multiworld.get_player_name(self.player)} because could not find a solution for escape")
+
+        # if we couldn't find an area layout then the escape graph is not created either
+        # and getDoorConnections will crash if random escape is activated.
         self.variaRando.doors = GraphUtils.getDoorConnections(self.variaRando.randoExec.areaGraph,
                                     self.variaRando.args.area, self.variaRando.args.bosses,
-                                    self.variaRando.args.escapeRando)
+                                    self.variaRando.args.escapeRando if escapeOk else False)
 
         self.variaRando.randoExec.postProcessItemLocs(self.itemLocs, self.variaRando.args.hideItems)
 
-        self.need_comeback_check = False
-
     @classmethod
     def stage_post_fill(cls, world):
         new_state = CollectionState(world)
@@ -872,29 +873,6 @@ class SMLocation(Location):
     def __init__(self, player: int, name: str, address=None, parent=None):
         super(SMLocation, self).__init__(player, name, address, parent)
 
-    def can_reach(self, state: CollectionState) -> bool:
-        # self.access_rule computes faster on average, so placing it first for faster abort
-        assert self.parent_region, "Can't reach location without region"
-        return super(SMLocation, self).can_reach(state) and \
-                (not state.multiworld.worlds[self.player].need_comeback_check or \
-                self.can_comeback(state, self.item))
-
-    def can_comeback(self, state: CollectionState, item):
-        randoExec = state.multiworld.worlds[self.player].variaRando.randoExec
-        randoService = randoExec.setup.services
-
-        comebackCheck = ComebackCheckType.JustComeback        
-        n = 2 if GraphUtils.isStandardStart(randoExec.graphSettings.startAP) else 3
-        # is early game
-        if (len([loc for loc in state.locations_checked if loc.player == self.player]) <= n or randoExec.graphSettings.startAP == state.smbm[self.player].lastAP):
-            comebackCheck = ComebackCheckType.NoCheck
-        container = ItemLocContainer(state.smbm[self.player], [], [])
-        return randoService.fullComebackCheck(  container, 
-                                                state.smbm[self.player].lastAP, 
-                                                ItemManager.Items[item.type] if item is not None and item.player == self.player else None,
-                                                locationsDict[self.name], 
-                                                comebackCheck) 
-
 class SMItem(Item):
     game = "Super Metroid"
     type: str