Merge pull request #147 from gymnast86/kreeb-hints

Add setting for Kreeb Hints Bows

Author: gymnast86

gui/desktop/mainwindow.cpp

@@ -608,6 +608,7 @@ void MainWindow::apply_config_settings()
     APPLY_CHECKBOX_SETTING(config, ui, ho_ho_hints);
     APPLY_CHECKBOX_SETTING(config, ui, ho_ho_triforce_hints);
     APPLY_CHECKBOX_SETTING(config, ui, korl_hints);
+    APPLY_CHECKBOX_SETTING(config, ui, kreeb_bow_hints);
     APPLY_CHECKBOX_SETTING(config, ui, use_always_hints);
     APPLY_CHECKBOX_SETTING(config, ui, clearer_hints);
     APPLY_CHECKBOX_SETTING(config, ui, hint_importance);
@@ -1102,6 +1103,7 @@ void MainWindow::on_player_in_casual_clothes_stateChanged(int arg1) {
 DEFINE_STATE_CHANGE_FUNCTION(ho_ho_hints)
 DEFINE_STATE_CHANGE_FUNCTION(ho_ho_triforce_hints)
 DEFINE_STATE_CHANGE_FUNCTION(korl_hints)
+DEFINE_STATE_CHANGE_FUNCTION(kreeb_bow_hints)
 DEFINE_STATE_CHANGE_FUNCTION(use_always_hints)
 DEFINE_STATE_CHANGE_FUNCTION(clearer_hints)
 DEFINE_STATE_CHANGE_FUNCTION(hint_importance)
@@ -1372,3 +1374,4 @@ void MainWindow::on_paste_permalink_clicked()
     auto permalink = QGuiApplication::clipboard()->text();
     on_permalink_textEdited(permalink);
 }
+

gui/desktop/mainwindow.hpp

@@ -240,6 +240,7 @@ private slots:
     void on_ho_ho_hints_stateChanged(int arg1);
     void on_ho_ho_triforce_hints_stateChanged(int arg1);
     void on_korl_hints_stateChanged(int arg1);
+    void on_kreeb_bow_hints_stateChanged(int arg1);
     void on_use_always_hints_stateChanged(int arg1);
     void on_path_hints_valueChanged(int path_hints);
     void on_barren_hints_valueChanged(int barren_hints);
@@ -304,9 +305,6 @@ private slots:
     void open_chart_mapping_list(uint8_t islandNum);
     void tracker_give_and_map_chart(TrackerLabel* label, GameItem chart);
 
-
-
-
 public:
     void update_items_color();
     void update_locations_color();

gui/desktop/mainwindow.ui

@@ -304,6 +304,10 @@ static std::unordered_map<std::string, std::string> optionDescriptions = {
       "korl_hints",
       "Places hints on the King of Red Lions. Talk to the King of Red Lions to get hints.",
     },
+    {
+      "kreeb_bow_hints",
+      "When this option is selected, Kreeb will give an item hint for each Progressive Bow after Link reactivates the Windfall lighthouse.",
+    },
     {
       "path_hints",
       "Determines the number of path hints that will be placed in the game, distributed using the selected hint placement options.<br>If multiple hint placement options are selected, the hint count will be split evenly among the placement options.",

gui/desktop/option_descriptions.hpp

@@ -352,6 +352,11 @@ namespace OptionCB {
         return fromBool(conf.settings.korl_hints);
     }
 
+    std::string toggleKreebBowHints() {
+        conf.settings.kreeb_bow_hints = !conf.settings.kreeb_bow_hints;
+        return fromBool(conf.settings.kreeb_bow_hints);
+    }
+
     std::string toggleClearHints() {
         conf.settings.clearer_hints = !conf.settings.clearer_hints;
         return fromBool(conf.settings.clearer_hints);
@@ -983,6 +988,8 @@ std::string getValue(const Option& option) {
             return fromBool(conf.settings.ho_ho_triforce_hints);
         case Option::KorlHints:
             return fromBool(conf.settings.korl_hints);
+        case Option::KreebBowHints:
+            return fromBool(conf.settings.kreeb_bow_hints);
         case Option::ClearerHints:
             return fromBool(conf.settings.clearer_hints);
         case Option::UseAlwaysHints:
@@ -1195,6 +1202,8 @@ TriggerCallback getCallback(const Option& option) {
             return &toggleHoHoTriforceHints;
         case Option::KorlHints:
             return &toggleKorlHints;
+        case Option::KreebBowHints:
+            return &toggleKreebBowHints;
         case Option::ClearerHints:
             return &toggleClearHints;
         case Option::UseAlwaysHints:
@@ -1362,6 +1371,7 @@ std::pair<std::string, std::string> getNameDesc(const Option& option) {
         {HoHoHints,                   {"Place Hints on Old Man Ho Ho",        "Places hints on Old Man Ho Ho. Old Man Ho Ho appears at 10 different islands. Simply talk to Old Man Ho Ho to get hints."}},
         {HoHoTriforceHints,           {"Old Man Ho Ho Hints Shards",          "When this option is selected, each Old Man Ho Ho will give an item hint for a Triforce Shard. Hints are not repeated until each shard is hinted once. This setting will override placing other hints on Old Man Ho Ho."}},
         {KorlHints,                   {"Place Hints on King of Red Lions",    "Places hints on the King of Red Lions. Talk to the King of Red Lions to get hints."}},
+        {KreebBowHints,               {"Kreeb Hints Bows",                    "When this option is selected, Kreeb will give an item hint for each Progressive Bow after Link reactivates the Windfall lighthouse."}},
         {ClearerHints,                {"Clearer Hints",                       "When this option is selected, location and item hints will use the standard check or item name, instead of using cryptic hints."}},
         {UseAlwaysHints,              {"Use Always Hints",                    "When the number of location hints is nonzero, certain locations that will always be hinted will take precedence over normal location hints."}},
         {HintImportance,              {"Hint Importance",                     "When this option is selected, item and location hints will also indicate if the hinted item is required, possibly required, or not required. Only progress items will have these additions; non-progress items are trivially not required."}},

gui/wiiu/OptionActions.cpp

@@ -59,6 +59,7 @@ namespace OptionCB {
     std::string toggleHoHoHints();
     std::string toggleHoHoTriforceHints();
     std::string toggleKorlHints();
+    std::string toggleKreebBowHints();
     std::string toggleClearHints();
     std::string toggleAlwaysHints();
     std::string toggleHintImportance();

gui/wiiu/OptionActions.hpp

@@ -270,6 +270,7 @@ HintsPage::HintsPage() {
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::HoHoHints));
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::HoHoTriforceHints));
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::KorlHints));
+    buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::KreebBowHints));
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::ClearerHints));
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::UseAlwaysHints));
     buttonColumns[0].emplace_back(std::make_unique<BasicButton>(Option::HintImportance));

gui/wiiu/Page.cpp

@@ -724,6 +724,24 @@ static HintError assignHoHoHints(World& world, WorldPool& worlds, std::list<Loca
     return HintError::NONE;
 }
 
+static HintError assignKreebHints(World& world, WorldPool& worlds)
+{
+    // Get all bow locations
+    // Shuffle locations to prevent any possible meta-gaming where the last bow might be
+    // since otherwise they'll appear in order of location id
+    auto allLocations = world.getLocations(/*onlyProgression = */ true);
+    shufflePool(allLocations);
+    for (auto& location : allLocations)
+    {
+        if (location->currentItem.getGameItemId() == GameItem::ProgressiveBow)
+        {
+            world.kreebHints.push_back(location);
+            LOG_AND_RETURN_IF_ERR(generateItemHintMessage(location));
+        }
+    }
+    return HintError::NONE;
+}
+
 HintError generateHints(WorldPool& worlds)
 {
     LOG_AND_RETURN_IF_ERR(calculatePossiblePathLocations(worlds));
@@ -751,6 +769,12 @@ HintError generateHints(WorldPool& worlds)
         uint8_t totalMadeHints = hintLocations.size();
         LOG_AND_RETURN_IF_ERR(generateLocationHintLocations(world, hintLocations, totalNumHints - totalMadeHints));
 
+        // Assign Kreeb Bow Hints if the setting is enabled
+        if (settings.kreeb_bow_hints)
+        {
+            assignKreebHints(world, worlds);
+        }
+
         // Distribute hints evenly among the possible hint placement options
         std::vector<std::string> hintPlacementOptions = {};
         std::unordered_map<std::string, std::list<Location*>> hintsForCategory = {};

logic/Hints.cpp

@@ -184,6 +184,7 @@ void runLogicTests(Config& newConfig)
     TEST(settings1, settings1.ho_ho_hints, "5 item hints");
     settings1.location_hints = 5;
     TEST(settings1, settings1.ho_ho_hints, "5 location hints");
+    TEST(settings1, settings1.kreeb_bow_hints, "kreeb bow hints");
     TEST(settings1, settings1.use_always_hints, "use always hints");
     TEST(settings1, settings1.clearer_hints, "clearer hints");
     TEST(settings1, settings1.hint_importance, "hint importance");
@@ -223,6 +224,7 @@ void runLogicTests(Config& newConfig)
     TEST(settings2, settings2.hint_importance, "hint importance");
     TEST(settings2, settings2.clearer_hints, "clearer hints");
     TEST(settings2, settings2.use_always_hints, "use always hints");
+    TEST(settings2, settings2.kreeb_bow_hints, "kreeb bow hints");
     settings2.path_hints = 5;
     TEST(settings2, settings2.korl_hints, "5 path hints");
     settings2.barren_hints = 5;

logic/LogicTests.cpp

@@ -238,7 +238,7 @@ void generateSpoilerLog(WorldPool& worlds)
     for (auto& world : worlds)
     {
         // Don't print "Hints" if there are none
-        if (world.hohoHints.empty() && world.korlHints.empty() && world.bigOctoFairyHintLocation == nullptr)
+        if (world.hohoHints.empty() && world.korlHints.empty() && world.bigOctoFairyHintLocation == nullptr && world.kreebHints.empty())
         {
             continue;
         }
@@ -291,6 +291,16 @@ void generateSpoilerLog(WorldPool& worlds)
             }
             spoilerLog << "        " << Utility::Str::toUTF8(hintText) << std::endl; 
         }
+
+        if (!world.kreebHints.empty())
+        {
+            spoilerLog << "    Kreeb Hints:" << std::endl;
+            for (auto location : world.kreebHints)
+            {
+                spoilerLog << "        " << getSpoilerFormatHint(location);
+                spoilerLog << std::endl;
+            }
+        }
     }
     spoilerLog << std::endl;