autopasture: only process domesticated own units to avoid problems with wild animals forgetting their training and going on a rampage

README.rst

@@ -878,7 +878,7 @@ Examples
    
 autonestbox
 ===========
-Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless of the size. The age of the units is currently not checked, most birds grow up quite fast. Egglayers who are also grazers will be ignored, since confining them to a 1x1 pasture is not a good idea. When called without options autonestbox will instantly run once.
+Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless of the size. The age of the units is currently not checked, most birds grow up quite fast. Egglayers who are also grazers will be ignored, since confining them to a 1x1 pasture is not a good idea. Only tame and domesticated own units are processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.
 
 Options:
 --------

plugins/probe.cpp

@@ -382,6 +382,10 @@ command_result df_bprobe (color_ostream &out, vector <string> & parameters)
                 out.print(", subtype %i", building.subtype);
             break;
         }
+        if(building.origin->isRoom())
+            out << ", is room";
+        else
+            out << ", not a room";
         out.print("\n");
 
     }

plugins/zone.cpp

@@ -410,6 +410,7 @@ void doMarkForSlaughter(df::unit* unit)
     unit->flags2.bits.slaughter = 1;
 }
 
+// check if creature is tame
 bool isTame(df::unit* creature)
 {
     bool tame = false;
@@ -437,6 +438,26 @@ bool isTame(df::unit* creature)
     return tame;
 }
 
+// check if creature is domesticated
+// seems to be the only way to really tell if it's completely safe to autonestbox it (training can revert)
+bool isDomesticated(df::unit* creature)
+{
+    bool tame = false;
+    if(creature->flags1.bits.tame)
+    {
+        switch (creature->training_level)
+        {
+        case df::animal_training_level::Domesticated:
+            tame=true;
+            break;
+        default:
+            tame=false;
+            break;
+        }
+    }
+    return tame;
+}
+
 // check if trained (might be useful if pasturing war dogs etc)
 bool isTrained(df::unit* unit)
 {
@@ -1181,7 +1202,7 @@ bool isFreeEgglayer(df::unit * unit)
 {
     if( !isDead(unit) && !isUndead(unit)
         && isFemale(unit)
-        && isTame(unit)
+        && isDomesticated(unit) // better strict than sorry (medium trained wild animals can revert into wild state)
         && isOwnCiv(unit)
         && isEggLayer(unit)
         && !isAssigned(unit)
@@ -1436,10 +1457,6 @@ command_result assignUnitsToCagezone(color_ostream& out, vector<df::unit*> units
     int32_t y1 = building->y1;
     int32_t y2 = building->y2;
     int32_t z  = building->z;
-    //out << " x1:"<<x1<<" x2:"<<x2
-    //    << " y1:"<<y1<<" y2:"<<x2
-    //    << " z:"<<z<<endl;
-    //out << "filling vector with cages on this zone" << endl;
     vector <df::building_cagest*> cages;
     for (int32_t x = x1; x<=x2; x++)
     {
@@ -1477,10 +1494,10 @@ command_result assignUnitsToCagezone(color_ostream& out, vector<df::unit*> units
             }
         }
         df::unit* unit = units.back();
+        units.pop_back();
         command_result result = assignUnitToCage(out, unit, (df::building*) bestcage, verbose);
         if(result!=CR_OK)
             return result;
-        units.pop_back();
     }
 
     return CR_OK;
@@ -2416,12 +2433,6 @@ command_result df_zone (color_ostream &out, vector <string> & parameters)
 
                 if(cagezone_assign)
                 {
-                    // !!! optimize me: collect a vector of unit pointers which match the search and pass it to
-                    // a method assignUnitsToCagezone(out, units, building) which only builds the vector of cages once
-                    //command_result result = assignUnitToCagezone(out, unit, building, verbose);
-                    //if(result != CR_OK)
-                    //    return result;
-                    //continue;
                     units_for_cagezone.push_back(unit);
                 }
                 else if(building_assign)
@@ -2472,7 +2483,7 @@ command_result df_zone (color_ostream &out, vector <string> & parameters)
             }
             else if(unit_slaughter)
             {
-                // by default behave like the game: only allow slaughtering of named war/hunting pets
+                // by default behave like the game? only allow slaughtering of named war/hunting pets
                 //if(unit->name.has_name && !find_named && !(isWar(unit)||isHunter(unit)))
                 //{
                 //    out << "Slaughter of named unit denied. Use the filter 'named' to override this check." << endl;
@@ -3453,7 +3464,6 @@ command_result start_autonestbox(color_ostream &out)
         config_autonestbox = pworld->AddPersistentData("autonestbox/config");
         config_autonestbox.ival(0) = enable_autonestbox;
         config_autonestbox.ival(1) = sleep_autonestbox;
-        //out << "autonestbox created persistent config object." << endl;
     }
     out << "Starting autonestbox." << endl;
 	init_autonestbox(out);