Merge pull request #2949 from UmedMuzl/dev-copy1

Helm Barriers/Ice Trap Model Selector

Author: UmedMuzl

base-hack/Build/build_dynamic_bitfields.py

@@ -17,6 +17,8 @@
         "fungi_yellow_tunnel",
         "shipwreck_gate",
         "llama_switches",
+        "helm_star_gates",
+        "helm_punch_gates",
     ],
     "FasterChecks": [
         "piano",

base-hack/include/dynamic_structs.h

@@ -23,6 +23,8 @@ typedef struct RemovedBarriers {
 	unsigned char fungi_yellow_tunnel : 1; // 0x10 
 	unsigned char shipwreck_gate : 1; // 0x8 
 	unsigned char llama_switches : 1; // 0x4 
+	unsigned char helm_star_gates : 1; // 0x2 
+	unsigned char helm_punch_gates : 1; // 0x1 
 } RemovedBarriers;
 
 typedef enum ENUM_RemovedBarriers {
@@ -40,6 +42,8 @@ typedef enum ENUM_RemovedBarriers {
 	/* 11 */ REMOVEDBARRIERS_ENUM_FUNGIYELLOWTUNNEL,
 	/* 12 */ REMOVEDBARRIERS_ENUM_SHIPWRECKGATE,
 	/* 13 */ REMOVEDBARRIERS_ENUM_LLAMASWITCHES,
+	/* 14 */ REMOVEDBARRIERS_ENUM_HELMSTARGATES,
+	/* 15 */ REMOVEDBARRIERS_ENUM_HELMPUNCHGATES,
 } ENUM_RemovedBarriers;
 
 typedef struct FasterChecks {

base-hack/src/fixes/helm.c

@@ -89,13 +89,18 @@ void initHelmSetup(void) {
 	int setting = Rando.fast_start_helm;
 	if (setting > 0) {
 		setPermFlag(FLAG_STORY_HELM); // Helm Story
+		if (setting == 2) {
+			setPermFlag(FLAG_MODIFIER_HELMBOM);
+		}
+	}
+	// Check barrier flags for gates
+	if (Rando.removed_barriers.helm_star_gates) {
 		setFlag(FLAG_HELM_ROMANDOORS_OPEN,1,FLAGTYPE_TEMPORARY); // Roman Numeral Doors
+	}
+	if (Rando.removed_barriers.helm_punch_gates) {
 		for (int j = 0; j < 4; j++) {
 			setFlag(FLAG_HELM_GATE_0 + j,1,FLAGTYPE_TEMPORARY); // Gates knocked down
 		}
-		if (setting == 2) {
-			setPermFlag(FLAG_MODIFIER_HELMBOM);
-		}
 	}
 }
 

morpher.html

@@ -700,6 +700,24 @@ <h5 class="modal-title"></h5>
                         console.log(`Inverting krool_key_count: ${old_value} -> ${setting_data.krool_key_count} (keys pregiven)`);
                     }
                 }
+                if (sel_version_num < numericVersion("5.7.53")) {
+                    // Migrate helm barriers based on helm_setting
+                    if (setting_data.helm_setting === "skip_start" || setting_data.helm_setting === "skip_all") {
+                        console.log('Helm setting is skip_start/skip_all - enabling helm barriers');
+                        if (!setting_data.remove_barriers_selected.includes("helm_star_gates")) {
+                            setting_data.remove_barriers_selected.push("helm_star_gates");
+                        }
+                        if (!setting_data.remove_barriers_selected.includes("helm_punch_gates")) {
+                            setting_data.remove_barriers_selected.push("helm_punch_gates");
+                        }
+                    } else if (setting_data.helm_setting === "default") {
+                        console.log('Helm setting is default - disabling helm barriers');
+                        setting_data.remove_barriers_selected = setting_data.remove_barriers_selected.filter(b => b !== "helm_star_gates" && b !== "helm_punch_gates");
+                    }
+                    // Set ice trap model to complex
+                    console.log('Setting ice_trap_model to complex');
+                    setting_data.ice_trap_model = "complex";
+                }
                 // Update to include all unhandled options to unsorted
                 const all_valid_items = Object.keys(output_json.ItemRandoListSelected);
                 let mentioned_items = [];

randomizer/Enums/Settings.jsonc

@@ -493,6 +493,17 @@
     "unlimited": 5
   },
 
+  /*
+    IceTrapModel:
+      The Model type for Ice Traps
+    - Simple: Only GB Ice Traps will appear
+    - Complex: Any Ice Trap Model will appear
+  */
+  "IceTrapModel": {
+    "simple": 0,
+    "complex": 1
+  },
+
   /*
     ItemRandoListSelected:
     - Item categories that may be randomized.
@@ -871,7 +882,9 @@
     "caves_igloo_pads": 14,
     "caves_ice_walls": 15,
     "galleon_treasure_room": 16,
-    "aztec_tiny_temple_ice": 17
+    "aztec_tiny_temple_ice": 17,
+    "helm_star_gates": 18,
+    "helm_punch_gates": 19
   },
 
   /*
@@ -1390,7 +1403,8 @@
     "trap_weight_disabletag": 289,
     "random_starting_region_new": 290,
     "kong_model_mode": 291,
-    "win_condition_spawns_ship": 292
+    "win_condition_spawns_ship": 292,
+    "ice_trap_model": 293
   },
   /*
     SettingsStringDataType:
@@ -1446,6 +1460,7 @@
     "helm_room_bonus_count": { "obj": "HelmBonuses" },
     "helm_setting": { "obj": "HelmSetting" },
     "ice_trap_frequency": { "obj": "IceTrapFrequency" },
+    "ice_trap_model": { "obj": "IceTrapModel" },
     "item_rando_list_selected": { "obj": "ItemRandoListSelected" },
     "kasplat_rando_setting": { "obj": "KasplatRandoSetting" },
     "krusha_ui": { "obj": "KrushaUi" },
@@ -2011,6 +2026,7 @@
       "obj": "SettingsStringDataType.bool"
     },
     "SettingsStringEnum.ice_trap_frequency": { "obj": "IceTrapFrequency" },
+    "SettingsStringEnum.ice_trap_model": { "obj": "IceTrapModel" },
     "SettingsStringEnum.ice_traps_damage": {
       "obj": "SettingsStringDataType.bool"
     },

randomizer/Lists/Multiselectors.py

@@ -159,6 +159,8 @@ def __init__(self, name: str, shift: int, tooltip: str = "") -> None:
     MultiselectorItem("Caves Igloo Pads", 3, "The pads to gain access to the five igloo rooms in Caves will be spawned."),
     MultiselectorItem("Caves Ice Walls", -1, "The various ice walls in Caves will be removed."),
     MultiselectorItem("Castle Crypt Doors", -1, "The various doors in the crypt and mausoleum areas of Creepy Castle will be removed."),
+    MultiselectorItem("Helm Star Gates", 14, "The Roman numeral gates in Hideout Helm will be opened."),
+    MultiselectorItem("Helm Punch Gates", 15, "The gates requiring Chunky's punch in Hideout Helm will be knocked down."),
 ]
 FasterCheckItems = [
     MultiselectorItem("Factory Toy Monster Fight", -1, "The toy monster fight in Factory will remove the initial enemy killing phase."),

randomizer/LogicFiles/HideoutHelm.py

@@ -8,7 +8,7 @@
 from randomizer.Enums.MinigameType import MinigameType
 from randomizer.Enums.Regions import Regions
 from randomizer.Enums.HintRegion import HintRegion
-from randomizer.Enums.Settings import HelmSetting
+from randomizer.Enums.Settings import HelmSetting, RemovedBarriersSelected
 from randomizer.Enums.Transitions import Transitions
 from randomizer.LogicClasses import (Event, LocationLogic, Region,
                                      TransitionFront)
@@ -27,8 +27,8 @@
         LocationLogic(Locations.HelmDiddy1, lambda l: not l.settings.helm_diddy or l.settings.helm_setting == HelmSetting.skip_all),
         LocationLogic(Locations.HelmDiddy2, lambda l: not l.settings.helm_diddy or l.settings.helm_setting == HelmSetting.skip_all),
     ], [
-        Event(Events.HelmDoorsOpened, lambda l: l.settings.helm_setting != HelmSetting.default),
-        Event(Events.HelmGatesPunched, lambda l: l.settings.helm_setting != HelmSetting.default),
+        Event(Events.HelmDoorsOpened, lambda l: l.checkBarrier(RemovedBarriersSelected.helm_star_gates)),
+        Event(Events.HelmGatesPunched, lambda l: l.checkBarrier(RemovedBarriersSelected.helm_punch_gates) and Events.HelmDoorsOpened in l.Events),
         Event(Events.HelmFinished, lambda l: l.settings.helm_setting == HelmSetting.skip_all),
     ], [
         # These transitions route you to where the loading zone entering Helm will take you

randomizer/Settings.py

@@ -421,6 +421,7 @@ def generate_main(self):
         self.loading_zone_coupled = None
         self.move_rando = MoveRando.off
         self.ice_trap_frequency = IceTrapFrequency.mild  # Deprecated
+        self.ice_trap_model = IceTrapModel.simple
         self.start_with_slam = False
         self.random_patches = None
         self.random_crates = None
@@ -1408,7 +1409,10 @@ def resolve_settings(self):
             "rockfall": self.trap_weight_rockfall,
             "disabletag": self.trap_weight_disabletag,
         }
-        models_chance = {"gb": 10, "key": 2, "bean": 1, "fairy": 4}
+        if self.ice_trap_model == IceTrapModel.simple:
+            models_chance = {"gb": 1}  # Only GB models
+        else:  # IceTrapModel.complex
+            models_chance = {"gb": 10, "key": 2, "bean": 1, "fairy": 4}  # Weighted distribution
         trap_data = {
             "gb": {
                 "bubble": Items.IceTrapBubble,