modded home points

Author: FabulaFey

worlds/crystal_project/__init__.py

@@ -22,7 +22,7 @@
     display_region_levels_dictionary
 from .options import CrystalProjectOptions, create_option_groups
 from .rules import CrystalProjectLogic
-from .mod_helper import ModLocationData, get_modded_items, get_modded_locations, \
+from .mod_helper import ModLocationData, get_modded_items, get_modded_locations, get_modded_home_points, \
     get_modded_shopsanity_locations, get_modded_bosses, build_condition_rule, update_item_classification, get_mod_info, get_removed_locations
 from typing import List, Set, Dict, Any
 from worlds.AutoWorld import World, WebWorld
@@ -94,6 +94,15 @@ class CrystalProjectWorld(World):
     for modded_boss in modded_bosses:
         location_name_to_id[modded_boss.name] = modded_boss.code
 
+    modded_home_points = get_modded_home_points(mod_info)
+
+    for modded_home_point in modded_home_points:
+        location_name_to_id[modded_home_point.name] = modded_home_point.code + home_point_location_index_offset
+        if modded_home_point.name in item_name_to_id and item_name_to_id[modded_home_point.name] != modded_home_point.code:
+            raise Exception(f"A modded item({modded_home_point.name}) with id {modded_home_point.code} tried to change the code of item_name_to_id and it can never change!")
+        item_name_to_id[modded_home_point.name] = modded_home_point.code + home_point_item_index_offset
+        item_name_groups.setdefault(MOD, set()).add(modded_home_point.name)
+
     removed_locations = get_removed_locations(mod_info)
 
     web = CrystalProjectWeb()
@@ -221,10 +230,20 @@ def create_regions(self) -> None:
         if self.options.home_point_hustle.value != self.options.home_point_hustle.option_disabled:
             home_points = get_home_points()
 
+            # todo removed home points
             for home_point in home_points:
                 home_point_location = LocationData(home_point.ap_region, home_point.name, (home_point.code + home_point_location_index_offset), home_point.rule)
                 locations.append(home_point_location)
 
+            if self.options.use_mods.value == self.options.use_mods.option_true:
+                for modded_home_point in self.modded_home_points:
+                    location = LocationData(display_region_subregions_dictionary[modded_home_point.display_region][0],
+                                            modded_home_point.name,
+                                            modded_home_point.code + home_point_location_index_offset,
+                                            build_condition_rule(modded_home_point.display_region,
+                                                                 modded_home_point.rule_condition, self))
+                    locations.append(location)
+
         #Regionsanity completion locations need to be added after all other locations so they can be removed if the region is empty (e.g. Neptune Shrine w/o Shopsanity)
         if self.options.regionsanity.value != self.options.regionsanity.option_disabled:
             region_completions = get_region_completion_locations()
@@ -381,8 +400,14 @@ def create_item(self, name: str) -> Item:
             return Item(name, data.classification, data.code, self.player)
         else:
             matches_mod = [item for (index, item) in enumerate(self.modded_items) if item.name == name]
+            matches_mod_home_point = [item for (index, item) in enumerate(self.modded_home_points) if item.name == name]
 
-            return Item(matches_mod[0].name, matches_mod[0].classification, matches_mod[0].code, self.player)
+            if len(matches_mod) > 0:
+                return Item(matches_mod[0].name, matches_mod[0].classification, matches_mod[0].code, self.player)
+            elif len(matches_mod_home_point) > 0:
+                return Item(matches_mod_home_point[0].name, ItemClassification.progression, matches_mod_home_point[0].code + home_point_item_index_offset, self.player)
+            else:
+                raise Exception(f"No matches found for name {name}")
 
     def create_items(self) -> None:
         pool = self.get_item_pool(self.get_excluded_items())
@@ -656,6 +681,12 @@ def get_item_pool(self, excluded_items: Set[str]) -> List[Item]:
                 item = self.create_item(modded_item.name)
                 pool.append(item)
 
+            if self.options.home_point_hustle != self.options.home_point_hustle.option_disabled:
+                for modded_home_point in self.modded_home_points:
+                    item = self.create_item(modded_home_point.name)
+                    update_item_classification(item, [location.rule_condition for location in combined_locations], self)
+                    pool.append(item)
+
         if not self.options.level_gating.value == self.options.level_gating.option_none:
             #guarantee space for 2 clamshells
             min_clamshells = 2
@@ -710,7 +741,10 @@ def get_job_id_list(self) -> List[int]:
     def fill_slot_data(self) -> Dict[str, Any]:
         mod_info = []
         slot_data_locations = []
+        slot_data_home_points = []
         slot_data_removed_locations = []
+        slot_data_removed_home_points = []
+
         if self.options.use_mods:
             for mod in self.mod_info:
                 mod_info.append({ "Id": mod.mod_id, "Name": mod.mod_name, "LoadOrder": mod.load_order })
@@ -740,10 +774,21 @@ def fill_slot_data(self) -> Dict[str, Any]:
                                                  "BiomeId": boss.biomeId,
                                                  "Rule": None })
 
+            if self.options.home_point_hustle != self.options.home_point_hustle.option_disabled:
+                for home_point in self.modded_home_points:
+                    slot_data_home_points.append({ "Id": home_point.offsetless_code,
+                                                 "APRegion": display_region_subregions_dictionary[home_point.display_region][0],
+                                                 "Name": home_point.name,
+                                                 "Coordinates": home_point.coordinates,
+                                                 "BiomeId": home_point.biomeId,
+                                                 "Rule": None })
+
             for location in self.removed_locations:
                 slot_data_removed_locations.append({"Id": location.code,
                                             "APRegion": location.ap_region})
 
+            #TODO removed home points
+
         # look into replacing this big chonky return block with self.options.as_dict() and then just adding the extras to the dict after
         return {
             "apworldVersion": self.world_version.as_simple_string(),
@@ -782,6 +827,7 @@ def fill_slot_data(self) -> Dict[str, Any]:
             "useMods": self.options.use_mods.value,
             "modInfo": mod_info,
             "moddedLocations": slot_data_locations,
+            "moddedHomePoints": slot_data_home_points,
             "removedLocations": slot_data_removed_locations,
             # "moddedLocationsForUT": self.modded_locations,
             # "moddedShopsForUT": self.modded_shops,

worlds/crystal_project/mod_helper.py

@@ -9,6 +9,7 @@
 from .items import item_table, equipment_index_offset, item_index_offset, job_index_offset
 from .locations import LocationData, get_treasure_and_npc_locations, get_shop_locations, get_boss_locations, npc_index_offset, treasure_index_offset, crystal_index_offset, \
     boss_index_offset, shop_index_offset, get_crystal_locations
+from .home_point_locations import get_home_points
 from .unused_locations import get_unused_locations
 from .constants.biomes import get_display_region_by_id
 from .constants.display_regions import *
@@ -18,12 +19,13 @@
 import json
 
 if TYPE_CHECKING:
-    from . import CrystalProjectWorld
+    from . import CrystalProjectWorld, home_point_location_index_offset
 
 MAX_SUPPORTED_EDITOR_VERSION: int = 32
 
 NPC_ENTITY_TYPE: int = 0 #Could be a boss or an npc check or a store or not a check at all
 SPARK_ENTITY_TYPE: int = 2 #Could be a boss or not a boss
+HOME_POINT_ENTITY_TYPE: int = 4
 TREASURE_ENTITY_TYPE: int = 5
 CRYSTAL_ENTITY_TYPE: int = 6
 
@@ -327,6 +329,21 @@ def get_modded_bosses(mod_info: List[ModInfoModel]) -> List[ModLocationData]:
 
     return locations
 
+def get_modded_home_points(mod_info: List[ModInfoModel]) -> List[ModLocationData]:
+    locations: List[ModLocationData] = []
+
+    for mod in mod_info:
+        for location in mod.data_model.Entities:
+            entity_type = location['EntityType']
+
+            # Entity type 0 is NPC
+            if entity_type == HOME_POINT_ENTITY_TYPE:
+                location = build_home_point_location(location, mod.shifted_entity_ids)
+                if location is not None:
+                    locations.append(location)
+
+    return locations
+
 def get_removed_locations(mod_info: List[ModInfoModel]) -> List[LocationData]:
     removed_locations: List[LocationData] = []
     vanilla_treasures_and_npcs = get_treasure_and_npc_locations(-1, None)
@@ -694,6 +711,29 @@ def build_spark_location(location, shifted_entity_ids: List[ModIncrementedIdData
 
     return None
 
+def build_home_point_location(location, shifted_entity_ids: List[ModIncrementedIdData]) -> Optional[ModLocationData]:
+    biome_id = location['BiomeID']
+    display_region = get_display_region_by_id(biome_id)
+    item_id = location['ID']
+    name = location['HomePointData']['Name']
+
+    new_id = item_id
+    for incremented_id in shifted_entity_ids:
+        if incremented_id.original_id == item_id:
+            new_id = incremented_id.new_id
+
+    name = 'Home Point - Modded Home Point ' + name + ' ' + str(new_id)
+    coord = location['Coord']
+    coordinates = str(coord['X']) + ',' + str(coord['Y']) + ',' + str(coord['Z'])
+
+    location_in_pool = any(location.code == item_id for location in get_home_points())
+
+    if not location_in_pool:
+        location = ModLocationData(display_region, name, new_id, new_id, coordinates, biome_id, None)
+        return location
+
+    return None
+
 def build_condition_rule(region, condition, world: "CrystalProjectWorld") -> Optional[Callable[[CollectionState], bool]]:
     logic = CrystalProjectLogic(world.player, world.options)
     job_id = None