Add custom chozo seals (#261)

* Add custom Chozo Seals

* Deactivate updated queen dna seal

* Simplify into one function

* Remove spaghetti code

* Minor cleanup

* type changes

src/open_samus_returns_rando/files/levels/s100_area10.lua

@@ -76,6 +76,7 @@ function s100_area10.InitFromBlackboard()
   Scenario.WriteToBlackboard("firstTimeMetroidHatchlingIntroPlayed", "b", true)
   Game.DisableEntity("LE_Baby_Hatchling")
   Game.DisableTrigger("TG_MetroidRadar")
+  Game.GetEntity("LE_RandoDNA_002").USABLE:Activate(false)
   if Game.GetEntity("LE_ValveQueen") ~= nil then
     if Blackboard.GetProp("DEFEATED_ENEMIES", "Metroid") ~= nil and s100_area10.iNumMetroids == Blackboard.GetProp("DEFEATED_ENEMIES", "Metroid") then
       Game.GetEntity("LE_ValveQueen").MODELUPDATER:SetMeshVisible("Valve", false)
@@ -272,6 +273,7 @@ function s100_area10.OnSubAreaChange(_ARG_0_, _ARG_1_, _ARG_2_, _ARG_3_, _ARG_4_
     Game.SetSceneGroupEnabledByName("sg_egg01", false)
     Game.SetSceneGroupEnabledByName("sg_egg02", true)
     Game.EnableEntity("LE_Baby_Hatchling")
+    Game.GetEntity("LE_RandoDNA_002").USABLE:Activate(true)
   end
   if _ARG_2_ == "collision_camera_020" then
     s100_area10.fSafeFarPlaneFactor = Game.GetSafeFarPlaneFactor()

src/open_samus_returns_rando/patcher_editor.py

@@ -73,3 +73,6 @@ def remove_entity(self, reference: dict):
 
         scenario.raw.actors[layer].pop(actor_name)
         scenario.remove_actor_from_all_groups(actor_name)
+
+    def get_asset_names_in_folder(self, folder: str) -> typing.Iterator[str]:
+        yield from (name for name in self._name_for_asset_id.values() if name.startswith(folder))

src/open_samus_returns_rando/specific_patches/chozo_seal_patches.py

@@ -1,5 +1,7 @@
+import typing
+
 from construct import Container, ListContainer
-from mercury_engine_data_structures.formats import Bmsad
+from mercury_engine_data_structures.formats import Bmsad, Bmsmsd
 from open_samus_returns_rando.patcher_editor import PatcherEditor
 
 SCRIPT_COMPONENT = Container({
@@ -45,5 +47,76 @@ def patch_dna_check(editor: PatcherEditor):
     editor.replace_asset(file_name, systemmechdna)
 
 
+class NewChozoSeal(typing.NamedTuple):
+    scenario: str
+    ap_coordinates: list[float]
+    platform_coordinates: list[float]
+    tile_index: int
+    entity_groups: list[str]
+    ap_name: str = "LE_RandoDNA"
+    platform_name: str = "LE_Platform_RandoDNA"
+
+new_seals = [
+    NewChozoSeal(
+        "s033_area3b", [-3800.0, -16800.0, 0.0], [-3800.0, -16800.0, 0.0], 22, ["collision_camera_033", "PostGamma_004"]
+    ),
+    NewChozoSeal(
+        "s050_area5", [12250.0, 6700.0, 20.0], [12250.0, 6700.0, 0.0], 238,
+        ["collision_camera_017", "017_PostGamma_002", "PostGamma_002"]
+    ),
+    NewChozoSeal(
+        "s065_area6b", [-300.0, 5700.0, 25.0], [-300.0, 5700.0, 0.0], 216, ["collision_camera_002"]
+    ),
+    NewChozoSeal(
+        "s100_area10", [-1000.0, -5125.0, 0.0], [-1000.0, -5100.0, 0.0], 94,
+        ["collision_camera_010"], "LE_RandoDNA_001", "LE_Platform_RandoDNA_001"
+    ),
+    NewChozoSeal(
+        "s100_area10", [-4100.0, 11200.0, 0.0], [-4100.0, 11200.0, 0.0], 253,
+        ["collision_camera_022", "collision_camera_024"], "LE_RandoDNA_002", "LE_Platform_RandoDNA_002"
+    ),
+    NewChozoSeal(
+        "s110_surfaceb", [-28150.0, 300.0, 0.0], [-28150.0, 300.0, 0.0], 145, ["collision_camera_017"]
+    ),
+]
+
+def add_chozo_seals(editor: PatcherEditor, new_seal: NewChozoSeal):
+    template_ap = editor.get_scenario("s000_surface").raw.actors[16]["LE_ChozoUnlockAreaDNA"]
+    template_platform = editor.get_scenario("s000_surface").raw.actors[10]["LE_Platform_ChozoUnlockAreaDNA"]
+
+    CHOZO_SEAL_ICON = Container({
+        "actor_name": new_seal.ap_name,
+        "clear_condition": "",
+        "icon": "systemmechdna",
+        "icon_priority": 4,
+        "coordinates": ListContainer(new_seal.ap_coordinates),
+    })
+
+    scenario_name = new_seal.scenario
+    scenario_file = editor.get_scenario(scenario_name)
+
+    editor.copy_actor(scenario_name, new_seal.ap_coordinates, template_ap, new_seal.ap_name, 16)
+    editor.copy_actor(scenario_name, new_seal.platform_coordinates, template_platform, new_seal.platform_name, 10)
+    scenario_file.raw.actors[10][new_seal.platform_name]["components"][0]["arguments"][4]["value"] = new_seal.ap_name
+
+    if scenario_name == "s110_surfaceb":
+        scenario_map = editor.get_file("gui/minimaps/c10_samus/s000_surface.bmsmsd", Bmsmsd)
+    else:
+        scenario_map = editor.get_file(f"gui/minimaps/c10_samus/{scenario_name}.bmsmsd", Bmsmsd)
+
+    scenario_map.raw["tiles"][new_seal.tile_index]["icons"] = ListContainer([CHOZO_SEAL_ICON])
+
+    for entity_group in new_seal.entity_groups:
+        scenario_file.add_actor_to_entity_groups(entity_group, new_seal.ap_name, True)
+        scenario_file.add_actor_to_entity_groups(entity_group, new_seal.platform_name, True)
+
+    # Dependencies
+    editor.ensure_present_in_scenario(scenario_name, "maps/textures/dnaemptyfx_d.bctex")
+    for asset in editor.get_asset_names_in_folder("actors/props/systemmechdna"):
+        editor.ensure_present_in_scenario(scenario_name, asset)
+
+
 def patch_chozo_seals(editor: PatcherEditor):
     patch_dna_check(editor)
+    for new_seal in new_seals:
+        add_chozo_seals(editor, new_seal)