Merge pull request #159 from gymnast86/barren-fix

Fix some items being incorrectly marked barren

Author: gymnast86

logic/Hints.cpp

@@ -146,8 +146,8 @@ static HintError calculatePossibleBarrenRegions(WorldPool& worlds)
                 auto chainLocations = location->currentItem.getChainLocations();
                 if (!chainLocations.empty())
                 {
-                    // If all of this item's chain locations' items can be in barren regions (or are nonprogression locations), then this item is junk
-                    if (std::ranges::all_of(chainLocations, [](const Location* loc){ return !loc->progression || loc->currentItemCanBeBarren(); }))
+                    // If all of this item's chain locations' are barren as chain locations, then this item is barren too.
+                    if (std::ranges::all_of(chainLocations, [](const Location* loc){ return loc->isBarrenAsChainLocation(); }))
                     {
                         location->currentItem.setAsJunkItem();
                         LOG_TO_DEBUG(location->currentItem.getName() + " is now junk.");
@@ -176,7 +176,7 @@ static HintError calculatePossibleBarrenRegions(WorldPool& worlds)
             newJunkItems = false;
             for (Item* item : potentiallyJunkItems)
             {
-                if (!item->isJunkItem() && std::ranges::all_of(item->getChainLocations(), [](const Location* loc){ return !loc->progression || loc->currentItemCanBeBarren(); }))
+                if (!item->isJunkItem() && std::ranges::all_of(item->getChainLocations(), [](const Location* loc){ return loc->isBarrenAsChainLocation(); }))
                 {
                     newJunkItems = true;
                     item->setAsJunkItem();
@@ -222,7 +222,7 @@ static HintError calculatePossibleBarrenRegions(WorldPool& worlds)
                                 for (auto outsideLoc : location->outsideDependentLocations)
                                 {
                                     // If an outside dependent location is not barren, remove the region from being barren
-                                    if (!outsideLoc->currentItemCanBeBarren())
+                                    if (!outsideLoc->isBarrenAsChainLocation())
                                     {
                                         LOG_TO_DEBUG("Removed " + hintRegion + " from barren pool due to item " + outsideLoc->currentItem.getName() + " at location " + outsideLoc->getName() + " which is dependent on " + location->getName());
                                         world.barrenRegions.erase(hintRegion);

logic/Location.cpp

@@ -170,10 +170,11 @@ bool Location::currentItemCanBeBarren() const
         }
     }
 
-    // If any of the remaining chain locations have an item which can't be barren, then this location's item isn't barren either
+    // If any of the remaining chain locations have an item which can't be barren, or the location is a required race mode location, 
+    // then this location's item isn't barren.
     for (auto& location : chainLocations)
     {
-        if (!location->currentItem.canBeInBarrenRegion())
+        if (!location->isBarrenAsChainLocation())
         {
             return false;
         }
@@ -182,6 +183,13 @@ bool Location::currentItemCanBeBarren() const
     return true;
 }
 
+// When a location is being checked for barreness as a chain location, it should not be considered barren
+// if it's a required race mode location
+bool Location::isBarrenAsChainLocation() const
+{
+    return !progression || (currentItem.canBeInBarrenRegion() && !isRequiredRaceModeLocation);
+}
+
 std::u16string Location::generateImportanceText(const std::string& language)
 {
     auto& item = currentItem;

logic/Location.hpp

@@ -72,6 +72,7 @@ class Location
     std::unordered_set<LocationCategory> categories;
     bool progression;
     bool isRaceModeLocation;
+    bool isRequiredRaceModeLocation;
     uint8_t stageId = 0;
     bool plandomized;
     bool hasBeenHinted;
@@ -112,6 +113,7 @@ class Location
         categories({LocationCategory::INVALID}),
         progression(false),
         isRaceModeLocation(false),
+        isRequiredRaceModeLocation(false),
         stageId(0),
         plandomized(false),
         hasBeenHinted(false),
@@ -141,6 +143,7 @@ class Location
     std::string getName() const;
     std::u16string generateImportanceText(const std::string& language);
     bool currentItemCanBeBarren() const;
+    bool isBarrenAsChainLocation() const;
 };
 
 using LocationSet = std::set<Location*, PointerLess<Location>>;

logic/World.cpp

@@ -552,6 +552,7 @@ World::WorldLoadingError World::determineRaceModeDungeons(WorldPool& worlds)
             if (dungeon.isRequiredDungeon)
             {
                 settings.setRequiredBoss(dungeon.raceModeLocation->getName(), true);
+                dungeon.raceModeLocation->isRequiredRaceModeLocation = true;
             }
         }
     }