Merge pull request DFHack#5560 from chdoc/nestboxes-burrow

[nestboxes] allow limiting egg protection to a designated burrow

Author: ab9rf

docs/changelog.txt

@@ -55,6 +55,8 @@ Template for new versions:
 
 ## New Features
 
+- `nestboxes`: allow limiting egg protection to nestboxes inside a designated burrow
+
 ## Fixes
 - ``Units::getReadableName`` will no longer append a comma to the names of histfigs with no profession
 

docs/plugins/nestboxes.rst

@@ -10,9 +10,16 @@ This plugin will automatically scan for and forbid fertile eggs incubating in a
 nestbox so that dwarves won't come to collect them for eating. The eggs will
 hatch normally, even when forbidden.
 
+You can control which eggs are collected and which eggs are protected by placing
+the nestboxes whose contents should be protected inside a burrow and running
+``nestboxes burrow <burrow_name>``. The default behavior of protecting all
+fertile eggs in nest boxes can be reestablished by running ``nestboxes all``.
+
 Usage
 -----
 
 ::
 
     enable nestboxes
+    nestboxes burrow <burrow_name>
+    nestbox all

plugins/nestboxes.cpp

@@ -1,13 +1,15 @@
 #include "Debug.h"
 #include "PluginManager.h"
 
+#include "modules/Burrows.h"
 #include "modules/Items.h"
 #include "modules/Job.h"
 #include "modules/Persistence.h"
 #include "modules/World.h"
 
 #include "df/buildingitemst.h"
 #include "df/building_nest_boxst.h"
+#include "df/burrow.h"
 #include "df/item.h"
 #include "df/item_eggst.h"
 #include "df/unit.h"
@@ -34,16 +36,24 @@ static PersistentDataItem config;
 
 enum ConfigValues {
     CONFIG_IS_ENABLED = 0,
+    CONFIG_BURROW = 1
 };
 
 static const int32_t CYCLE_TICKS = 7; // need to react quickly when eggs are laid/unforbidden
 static int32_t cycle_timestamp = 0;  // world->frame_counter at last cycle
 
 static void do_cycle(color_ostream &out);
 
+static command_result do_command(color_ostream &out, std::vector<string> &parameters);
 DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands) {
     DEBUG(control,out).print("initializing %s\n", plugin_name);
 
+    // provide a configuration interface for the plugin
+    commands.push_back(PluginCommand(
+        plugin_name,
+        "Protect fertile eggs incubating in a nestbox.",
+        do_command));
+
     return CR_OK;
 }
 
@@ -108,6 +118,65 @@ DFhackCExport command_result plugin_onupdate(color_ostream &out) {
     return CR_OK;
 }
 
+/////////////////////////////////////////////////////
+// configuration logic
+//
+
+static void setBurrow(color_ostream &out, const string &burrow_name){
+    auto burrow = Burrows::findByName(burrow_name);
+    if (burrow) {
+        config.set_int(CONFIG_BURROW, burrow->id);
+    } else {
+        config.set_int(CONFIG_BURROW, -1);
+    }
+}
+
+static df::burrow* getBurrow(color_ostream &out){
+    int id = config.get_int(CONFIG_BURROW);
+    auto burrow = df::burrow::find(id);
+    if (!burrow) {
+        config.set_int(CONFIG_BURROW, -1);
+    }
+    return burrow;
+}
+
+static void printStatus(color_ostream &out){
+    if (!is_enabled)
+        out.print("%s is disabled\n", plugin_name);
+    else {
+        out.print("%s is enabled\n", plugin_name);
+        auto burrow = getBurrow(out);
+        if (burrow)
+        {
+            out.print("only protecting eggs inside burrow: %s\n", burrow->name.c_str());
+        }
+        else
+        {
+            out.print("protecting all fertile eggs\n");
+        }
+    }
+}
+
+static command_result do_command(color_ostream &out, std::vector<string> &parameters){
+    if (!Core::getInstance().isMapLoaded() || !World::isFortressMode()) {
+        out.printerr("Cannot run %s without a loaded fort.\n", plugin_name);
+        return CR_FAILURE;
+    }
+
+    if (parameters.size() == 0 || parameters[0] == "status")
+    {
+        printStatus(out);
+        return CR_OK;
+    } else if (parameters.size() > 1 && parameters[0] == "burrow") {
+        setBurrow(out, parameters[1]);
+        return CR_OK;
+    } else if (parameters[0] == "all") {
+        config.set_int(CONFIG_BURROW, -1);
+        return CR_OK;
+    } else {
+        return CR_WRONG_USAGE;
+    }
+}
 /////////////////////////////////////////////////////
 // cycle logic
 //
@@ -118,6 +187,9 @@ static void do_cycle(color_ostream &out) {
     // mark that we have recently run
     cycle_timestamp = world->frame_counter;
 
+    // see if egg protection is limited to a burrow
+    auto burrow = getBurrow(out);
+
     for (df::building_nest_boxst *nb : world->buildings.other.NEST_BOX) {
         for (auto &contained_item : nb->contained_items) {
             if (contained_item->use_mode == df::building_item_role_type::PERM)
@@ -126,6 +198,9 @@ static void do_cycle(color_ostream &out) {
                 bool fertile = item->egg_flags.bits.fertile;
                 if (item->flags.bits.forbid == fertile)
                     continue;
+                if (burrow && !Burrows::isAssignedTile(burrow, Items::getPosition(item))) {
+                    continue;
+                }
                 item->flags.bits.forbid = fertile;
                 if (fertile && item->flags.bits.in_job) {
                     // cancel any job involving the egg