TUNIC: Additional Combat Logic Option (#3658)

worlds/tunic/__init__.py

@@ -1,7 +1,8 @@
 from typing import Dict, List, Any, Tuple, TypedDict, ClassVar, Union
 from logging import warning
-from BaseClasses import Region, Location, Item, Tutorial, ItemClassification, MultiWorld
-from .items import item_name_to_id, item_table, item_name_groups, fool_tiers, filler_items, slot_data_item_names
+from BaseClasses import Region, Location, Item, Tutorial, ItemClassification, MultiWorld, CollectionState
+from .items import (item_name_to_id, item_table, item_name_groups, fool_tiers, filler_items, slot_data_item_names,
+                    combat_items)
 from .locations import location_table, location_name_groups, location_name_to_id, hexagon_locations
 from .rules import set_location_rules, set_region_rules, randomize_ability_unlocks, gold_hexagon
 from .er_rules import set_er_location_rules
@@ -10,6 +11,7 @@
 from .er_data import portal_mapping, RegionInfo, tunic_er_regions
 from .options import (TunicOptions, EntranceRando, tunic_option_groups, tunic_option_presets, TunicPlandoConnections,
                       LaurelsLocation, LogicRules, LaurelsZips, IceGrappling, LadderStorage)
+from .combat_logic import area_data, CombatState
 from worlds.AutoWorld import WebWorld, World
 from Options import PlandoConnection
 from decimal import Decimal, ROUND_HALF_UP
@@ -127,11 +129,21 @@ def generate_early(self) -> None:
                 self.options.shuffle_ladders.value = passthrough["shuffle_ladders"]
                 self.options.fixed_shop.value = self.options.fixed_shop.option_false
                 self.options.laurels_location.value = self.options.laurels_location.option_anywhere
+                self.options.combat_logic.value = passthrough["combat_logic"]
 
     @classmethod
     def stage_generate_early(cls, multiworld: MultiWorld) -> None:
         tunic_worlds: Tuple[TunicWorld] = multiworld.get_game_worlds("TUNIC")
         for tunic in tunic_worlds:
+            # setting up state combat logic stuff, see has_combat_reqs for its use
+            # and this is magic so pycharm doesn't like it, unfortunately
+            if tunic.options.combat_logic:
+                multiworld.state.tunic_need_to_reset_combat_from_collect[tunic.player] = False
+                multiworld.state.tunic_need_to_reset_combat_from_remove[tunic.player] = False
+                multiworld.state.tunic_area_combat_state[tunic.player] = {}
+                for area_name in area_data.keys():
+                    multiworld.state.tunic_area_combat_state[tunic.player][area_name] = CombatState.unchecked
+
             # if it's one of the options, then it isn't a custom seed group
             if tunic.options.entrance_rando.value in EntranceRando.options.values():
                 continue
@@ -190,10 +202,12 @@ def stage_generate_early(cls, multiworld: MultiWorld) -> None:
 
     def create_item(self, name: str, classification: ItemClassification = None) -> TunicItem:
         item_data = item_table[name]
-        return TunicItem(name, classification or item_data.classification, self.item_name_to_id[name], self.player)
+        # if item_data.combat_ic is None, it'll take item_data.classification instead
+        itemclass: ItemClassification = ((item_data.combat_ic if self.options.combat_logic else None)
+                                         or item_data.classification)
+        return TunicItem(name, classification or itemclass, self.item_name_to_id[name], self.player)
 
     def create_items(self) -> None:
-
         tunic_items: List[TunicItem] = []
         self.slot_data_items = []
 
@@ -322,15 +336,15 @@ def create_regions(self) -> None:
                 self.ability_unlocks["Pages 42-43 (Holy Cross)"] = passthrough["Hexagon Quest Holy Cross"]
                 self.ability_unlocks["Pages 52-53 (Icebolt)"] = passthrough["Hexagon Quest Icebolt"]
 
-        # ladder rando uses ER with vanilla connections, so that we're not managing more rules files
-        if self.options.entrance_rando or self.options.shuffle_ladders:
+        # Ladders and Combat Logic uses ER rules with vanilla connections for easier maintenance
+        if self.options.entrance_rando or self.options.shuffle_ladders or self.options.combat_logic:
             portal_pairs = create_er_regions(self)
             if self.options.entrance_rando:
                 # these get interpreted by the game to tell it which entrances to connect
                 for portal1, portal2 in portal_pairs.items():
                     self.tunic_portal_pairs[portal1.scene_destination()] = portal2.scene_destination()
         else:
-            # for non-ER, non-ladders
+            # uses the original rules, easier to navigate and reference
             for region_name in tunic_regions:
                 region = Region(region_name, self.player, self.multiworld)
                 self.multiworld.regions.append(region)
@@ -351,7 +365,8 @@ def create_regions(self) -> None:
             victory_region.locations.append(victory_location)
 
     def set_rules(self) -> None:
-        if self.options.entrance_rando or self.options.shuffle_ladders:
+        # same reason as in create_regions, could probably be put into create_regions
+        if self.options.entrance_rando or self.options.shuffle_ladders or self.options.combat_logic:
             set_er_location_rules(self)
         else:
             set_region_rules(self)
@@ -360,6 +375,19 @@ def set_rules(self) -> None:
     def get_filler_item_name(self) -> str:
         return self.random.choice(filler_items)
 
+    # cache whether you can get through combat logic areas
+    def collect(self, state: CollectionState, item: Item) -> bool:
+        change = super().collect(state, item)
+        if change and self.options.combat_logic and item.name in combat_items:
+            state.tunic_need_to_reset_combat_from_collect[self.player] = True
+        return change
+
+    def remove(self, state: CollectionState, item: Item) -> bool:
+        change = super().remove(state, item)
+        if change and self.options.combat_logic and item.name in combat_items:
+            state.tunic_need_to_reset_combat_from_remove[self.player] = True
+        return change
+
     def extend_hint_information(self, hint_data: Dict[int, Dict[int, str]]) -> None:
         if self.options.entrance_rando:
             hint_data.update({self.player: {}})
@@ -426,6 +454,7 @@ def fill_slot_data(self) -> Dict[str, Any]:
             "maskless": self.options.maskless.value,
             "entrance_rando": int(bool(self.options.entrance_rando.value)),
             "shuffle_ladders": self.options.shuffle_ladders.value,
+            "combat_logic": self.options.combat_logic.value,
             "Hexagon Quest Prayer": self.ability_unlocks["Pages 24-25 (Prayer)"],
             "Hexagon Quest Holy Cross": self.ability_unlocks["Pages 42-43 (Holy Cross)"],
             "Hexagon Quest Icebolt": self.ability_unlocks["Pages 52-53 (Icebolt)"],