Made the behavior use to filter items such that it corresponds to number of locations an opion.

Author: neocerber

worlds/enderlilies/Options.py

@@ -38,6 +38,18 @@ class StartingSpirit(Choice):
     option_any = 2
     default = option_vanilla
 
+class ItemFilterBehavior(Choice):
+    """Defines how items are filtered to ensure that the number of items provided by the world match its number of locations.
+
+    filler: Only items classified as filler will be considered. (i.e. lore)
+    nonProgressive: All items that are not progressive will be considered. (i.e. useful + filler)
+    nothing: Do not remove any items prior letting the multiworld choose what it keeps. """
+    display_name = "Item filter behavior"
+    option_filler = 0
+    option_nonProgressive = 1
+    option_nothing = 2
+    default = option_filler
+
 el_options: Dict[str, type(Option)] = {
     # # Not added since not sure if the client can read it right now.
     # "shuffle_slots": ShuffleSlots,
@@ -48,6 +60,7 @@ class StartingSpirit(Choice):
     # "mini_boss_incrememnts_chapter": MiniBossIncrementsChapter,
     # "shuffle_upgrades": ShuffleUpgrades,
     "starting_spirit": StartingSpirit,
+    "item_filter_behavior": ItemFilterBehavior,
 }
 
 

worlds/enderlilies/__init__.py

@@ -38,7 +38,7 @@ def create_item(self, item: str) -> EnderLiliesItem:
     def create_items(self) -> None:
         starting_item = assign_starting_item(self.multiworld, self.player, items)
 
-        filter_items_to_locations_number(self.multiworld, items) 
+        filter_items_to_locations_number(self.multiworld, self.player, items) 
 
         for item, data in items.items():
             if item != starting_item:
@@ -98,22 +98,28 @@ def fill_slot_data(self) -> Dict[str, Any]:
                     slot_data[location.name] = f"AP.{location.address}"
         return slot_data
 
-def filter_items_to_locations_number(multiworld: MultiWorld, items):
-    # Not sure how to differ locations with item and entrance. Using address for now...
-    nb_locations_items = len([x for x in locations if locations[x].address is not None])
-    nb_items = sum([items[x].count for x in items])
-    nb_excedant_items = nb_items - nb_locations_items
-    if nb_excedant_items > 0:
-        items_valid_to_discard = sorted(x for x in items if items[x].classification == ItemClassification.filler)
-        for i in range(nb_excedant_items):
-            discard_candidate = multiworld.random.choice(items_valid_to_discard)
-            if items[discard_candidate].count == 1:
-                del items[discard_candidate] 
-                items_valid_to_discard.remove(discard_candidate)
-            else:
-                items[discard_candidate] = ItemData(code=items[discard_candidate].code, 
-                                                    count=items[discard_candidate].count - 1, 
-                                                    classification=items[discard_candidate].classification)
+def filter_items_to_locations_number(multiworld: MultiWorld, player: int, items):
+    val = get_option_value(multiworld, player, "item_filter_behavior")
+    if val != 2:
+        # Not sure how to differ locations with item and entrance. Using address for now...
+        nb_locations_items = len([x for x in locations if locations[x].address is not None])
+        nb_items = sum([items[x].count for x in items])
+        nb_excedant_items = nb_items - nb_locations_items
+        if nb_excedant_items > 0:
+            if val == 0:
+                discard_candidates = sorted(x for x in items if items[x].classification == ItemClassification.filler)
+            elif val == 1:
+                discard_candidates = sorted(x for x in items if (items[x].classification == ItemClassification.filler
+                                                            or items[x].classification == ItemClassification.useful))
+            for i in range(nb_excedant_items):
+                curr_candidate = multiworld.random.choice(discard_candidates)
+                if items[curr_candidate].count == 1:
+                    del items[curr_candidate] 
+                    discard_candidates.remove(curr_candidate)
+                else:
+                    items[curr_candidate] = ItemData(code=items[curr_candidate].code, 
+                                                        count=items[curr_candidate].count - 1, 
+                                                        classification=items[curr_candidate].classification)
 
 def assign_starting_item(multiworld: MultiWorld, player: int, items) -> str:
     non_local_items = multiworld.non_local_items[player].value