MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3212 from myk002/myk_plants 

[getplants] fix designation of non-fruit trees
develop
Myk 2023-04-11 02:58:37 -07:00 committed by GitHub
parent 99d1b85f13 cbf1e23672
commit 5ade6c8282
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 156 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

313
plugins/getplants.cpp
Unescape Escape View File

@ -1,13 +1,6 @@
// (un)designate matching plants for gathering/cutting
#include <set>
#include "Core.h"
#include "Console.h"
#include "Export.h"
#include "Debug.h"
#include "PluginManager.h"
#include "DataDefs.h"
#include "TileTypes.h"
#include "MiscUtils.h"
#include "df/map_block.h"
#include "df/map_block_column.h"
@ -32,6 +25,11 @@ using std::set;
using namespace DFHack;
using namespace df::enums;
namespace DFHack
{
DBG_DECLARE(getplants, log, DebugCategory::LINFO);
}
DFHACK_PLUGIN("getplants");
REQUIRE_GLOBAL(plotinfo);
REQUIRE_GLOBAL(world);
@ -75,49 +73,38 @@ enum class selectability {
// is one of the issues in bug 6940 on the bug tracker (the others cases are detected and
// result in the plants not being usable for farming or even collectable at all).
//selectability selectablePlant(color_ostream &out, const df::plant_raw *plant, bool farming)
selectability selectablePlant(const df::plant_raw *plant, bool farming)
{
selectability selectablePlant(color_ostream& out, const df::plant_raw* plant, bool farming) {
const DFHack::MaterialInfo basic_mat = DFHack::MaterialInfo(plant->material_defs.type[plant_material_def::basic_mat], plant->material_defs.idx[plant_material_def::basic_mat]);
bool outOfSeason = false;
selectability result = selectability::Nonselectable;
if (plant->flags.is_set(plant_raw_flags::TREE))
{
// out.print("%s is a selectable tree\n", plant->id.c_str());
if (farming)
{
if (plant->flags.is_set(plant_raw_flags::TREE)) {
DEBUG(log, out).print("%s is a selectable tree\n", plant->id.c_str());
if (farming) {
return selectability::Nonselectable;
}
else
{
else {
return selectability::Selectable;
}
}
else if (plant->flags.is_set(plant_raw_flags::GRASS))
{
// out.print("%s is a non selectable Grass\n", plant->id.c_str());
else if (plant->flags.is_set(plant_raw_flags::GRASS)) {
DEBUG(log, out).print("%s is a non selectable Grass\n", plant->id.c_str());
return selectability::Grass;
}
if (farming && plant->material_defs.type[plant_material_def::seed] == -1)
{
if (farming && plant->material_defs.type[plant_material_def::seed] == -1) {
return selectability::Nonselectable;
}
if (basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW) ||
basic_mat.material->flags.is_set(material_flags::EDIBLE_COOKED))
{
// out.print("%s is edible\n", plant->id.c_str());
if (farming)
{
if (basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW))
{
basic_mat.material->flags.is_set(material_flags::EDIBLE_COOKED)) {
DEBUG(log, out).print("%s is edible\n", plant->id.c_str());
if (farming) {
if (basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW)) {
result = selectability::Selectable;
}
}
else
{
else {
return selectability::Selectable;
}
}
@ -126,38 +113,30 @@ selectability selectablePlant(const df::plant_raw *plant, bool farming)
plant->flags.is_set(plant_raw_flags::MILL) ||
plant->flags.is_set(plant_raw_flags::EXTRACT_VIAL) ||
plant->flags.is_set(plant_raw_flags::EXTRACT_BARREL) ||
plant->flags.is_set(plant_raw_flags::EXTRACT_STILL_VIAL))
{
// out.print("%s is thread/mill/extract\n", plant->id.c_str());
if (farming)
{
plant->flags.is_set(plant_raw_flags::EXTRACT_STILL_VIAL)) {
DEBUG(log, out).print("%s is thread/mill/extract\n", plant->id.c_str());
if (farming) {
result = selectability::Selectable;
}
else
{
else {
return selectability::Selectable;
}
}
if (basic_mat.material->reaction_product.id.size() > 0 ||
basic_mat.material->reaction_class.size() > 0)
{
// out.print("%s has a reaction\n", plant->id.c_str());
if (farming)
{
basic_mat.material->reaction_class.size() > 0) {
DEBUG(log, out).print("%s has a reaction\n", plant->id.c_str());
if (farming) {
result = selectability::Selectable;
}
else
{
else {
return selectability::Selectable;
}
}
for (size_t i = 0; i < plant->growths.size(); i++)
{
for (size_t i = 0; i < plant->growths.size(); i++) {
if (plant->growths[i]->item_type == df::item_type::SEEDS || // Only trees have seed growths in vanilla, but raws can be modded...
plant->growths[i]->item_type == df::item_type::PLANT_GROWTH)
{
plant->growths[i]->item_type == df::item_type::PLANT_GROWTH) {
const DFHack::MaterialInfo growth_mat = DFHack::MaterialInfo(plant->growths[i]->mat_type, plant->growths[i]->mat_index);
if ((plant->growths[i]->item_type == df::item_type::SEEDS &&
(growth_mat.material->flags.is_set(material_flags::EDIBLE_COOKED) ||
@ -167,13 +146,10 @@ selectability selectablePlant(const df::plant_raw *plant, bool farming)
{
bool seedSource = plant->growths[i]->item_type == df::item_type::SEEDS;
if (plant->growths[i]->item_type == df::item_type::PLANT_GROWTH)
{
for (size_t k = 0; growth_mat.material->reaction_product.material.mat_type.size(); k++)
{
if (plant->growths[i]->item_type == df::item_type::PLANT_GROWTH) {
for (size_t k = 0; growth_mat.material->reaction_product.material.mat_type.size(); k++) {
if (growth_mat.material->reaction_product.material.mat_type[k] == plant->material_defs.type[plant_material_def::seed] &&
growth_mat.material->reaction_product.material.mat_index[k] == plant->material_defs.idx[plant_material_def::seed])
{
growth_mat.material->reaction_product.material.mat_index[k] == plant->material_defs.idx[plant_material_def::seed]) {
seedSource = true;
break;
}
@ -182,24 +158,20 @@ selectability selectablePlant(const df::plant_raw *plant, bool farming)
if (*cur_year_tick >= plant->growths[i]->timing_1 &&
(plant->growths[i]->timing_2 == -1 ||
*cur_year_tick <= plant->growths[i]->timing_2))
{
// out.print("%s has an edible seed or a stockpile growth\n", plant->id.c_str());
if (!farming || seedSource)
{
*cur_year_tick <= plant->growths[i]->timing_2)) {
DEBUG(log, out).print("%s has an edible seed or a stockpile growth\n", plant->id.c_str());
if (!farming || seedSource) {
return selectability::Selectable;
}
}
else
{
if (!farming || seedSource)
{
else {
if (!farming || seedSource) {
outOfSeason = true;
}
}
}
}
/* else if (plant->growths[i]->behavior.bits.has_seed) // This code designates beans, etc. when DF doesn't, but plant gatherers still fail to collect anything, so it's useless: bug #0006940.
/* else if (plant->growths[i]->behavior.bits.has_seed) // This code designates beans, etc. when DF doesn't, but plant gatherers still fail to collect anything, so it's useless: bug #0006940.
{
const DFHack::MaterialInfo seed_mat = DFHack::MaterialInfo(plant->material_defs.type[plant_material_def::seed], plant->material_defs.idx[plant_material_def::seed]);
@ -220,14 +192,12 @@ selectability selectablePlant(const df::plant_raw *plant, bool farming)
} */
}
if (outOfSeason)
{
// out.print("%s has an out of season growth\n", plant->id.c_str());
if (outOfSeason) {
DEBUG(log, out).print("%s has an out of season growth\n", plant->id.c_str());
return selectability::OutOfSeason;
}
else
{
// out.printerr("%s cannot be gathered\n", plant->id.c_str());
else {
DEBUG(log, out).print("%s cannot be gathered\n", plant->id.c_str());
return result;
}
}
@ -241,17 +211,17 @@ bool ripe(int32_t x, int32_t y, int32_t start, int32_t end) {
}
// Looks in the picked growths vector to see if a matching growth has been marked as picked.
bool picked(const df::plant *plant, int32_t growth_subtype) {
df::world_data *world_data = world->world_data;
df::world_site *site = df::world_site::find(plotinfo->site_id);
bool picked(const df::plant* plant, int32_t growth_subtype) {
df::world_data* world_data = world->world_data;
df::world_site* site = df::world_site::find(plotinfo->site_id);
int32_t pos_x = site->global_min_x + plant->pos.x / 48;
int32_t pos_y = site->global_min_y + plant->pos.y / 48;
size_t id = pos_x + pos_y * 16 * world_data->world_width;
df::world_object_data *object_data = df::world_object_data::find(id);
df::world_object_data* object_data = df::world_object_data::find(id);
if (!object_data) {
return false;
}
df::map_block_column *column = world->map.map_block_columns[(plant->pos.x / 16) * world->map.x_count_block + (plant->pos.y / 16)];
df::map_block_column* column = world->map.map_block_columns[(plant->pos.x / 16) * world->map.x_count_block + (plant->pos.y / 16)];
for (size_t i = 0; i < object_data->picked_growths.x.size(); i++) {
if (object_data->picked_growths.x[i] == plant->pos.x &&
@ -266,13 +236,20 @@ bool picked(const df::plant *plant, int32_t growth_subtype) {
return false;
}
bool designate(const df::plant *plant, bool farming) {
df::plant_raw *plant_raw = world->raws.plants.all[plant->material];
bool designate(color_ostream& out, const df::plant* plant, bool farming) {
TRACE(log, out).print("Attempting to designate %s at (%i, %i, %i)\n", world->raws.plants.all[plant->material]->id.c_str(), plant->pos.x, plant->pos.y, plant->pos.z);
if (!farming) {
bool istree = (tileMaterial(Maps::getTileBlock(plant->pos)->tiletype[plant->pos.x % 16][plant->pos.y % 16]) == tiletype_material::TREE);
if (istree)
return Designations::markPlant(plant);
}
df::plant_raw* plant_raw = world->raws.plants.all[plant->material];
const DFHack::MaterialInfo basic_mat = DFHack::MaterialInfo(plant_raw->material_defs.type[plant_material_def::basic_mat], plant_raw->material_defs.idx[plant_material_def::basic_mat]);
if (basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW) ||
basic_mat.material->flags.is_set(material_flags::EDIBLE_COOKED))
{
basic_mat.material->flags.is_set(material_flags::EDIBLE_COOKED)) {
return Designations::markPlant(plant);
}
@ -280,63 +257,60 @@ bool designate(const df::plant *plant, bool farming) {
plant_raw->flags.is_set(plant_raw_flags::MILL) ||
plant_raw->flags.is_set(plant_raw_flags::EXTRACT_VIAL) ||
plant_raw->flags.is_set(plant_raw_flags::EXTRACT_BARREL) ||
plant_raw->flags.is_set(plant_raw_flags::EXTRACT_STILL_VIAL))
{
plant_raw->flags.is_set(plant_raw_flags::EXTRACT_STILL_VIAL)) {
if (!farming) {
return Designations::markPlant(plant);
}
}
if (basic_mat.material->reaction_product.id.size() > 0 ||
basic_mat.material->reaction_class.size() > 0)
{
basic_mat.material->reaction_class.size() > 0) {
if (!farming) {
return Designations::markPlant(plant);
}
}
for (size_t i = 0; i < plant_raw->growths.size(); i++)
{
if (plant_raw->growths[i]->item_type == df::item_type::SEEDS || // Only trees have seed growths in vanilla, but raws can be modded...
plant_raw->growths[i]->item_type == df::item_type::PLANT_GROWTH)
{
for (size_t i = 0; i < plant_raw->growths.size(); i++) {
TRACE(log, out).print("growth item type=%d\n", plant_raw->growths[i]->item_type);
// Only trees have seed growths in vanilla, but raws can be modded...
if (plant_raw->growths[i]->item_type != df::item_type::SEEDS &&
plant_raw->growths[i]->item_type != df::item_type::PLANT_GROWTH)
continue;
const DFHack::MaterialInfo growth_mat = DFHack::MaterialInfo(plant_raw->growths[i]->mat_type, plant_raw->growths[i]->mat_index);
if ((plant_raw->growths[i]->item_type == df::item_type::SEEDS &&
TRACE(log, out).print("edible_cooked=%d edible_raw=%d leaf_mat=%d\n",
growth_mat.material->flags.is_set(material_flags::EDIBLE_COOKED),
growth_mat.material->flags.is_set(material_flags::EDIBLE_RAW),
growth_mat.material->flags.is_set(material_flags::LEAF_MAT));
if (!(plant_raw->growths[i]->item_type == df::item_type::SEEDS &&
(growth_mat.material->flags.is_set(material_flags::EDIBLE_COOKED) ||
growth_mat.material->flags.is_set(material_flags::EDIBLE_RAW))) ||
(plant_raw->growths[i]->item_type == df::item_type::PLANT_GROWTH &&
growth_mat.material->flags.is_set(material_flags::EDIBLE_RAW))) &&
!(plant_raw->growths[i]->item_type == df::item_type::PLANT_GROWTH &&
growth_mat.material->flags.is_set(material_flags::LEAF_MAT))) // Will change name to STOCKPILE_PLANT_GROWTH any day now...
{
continue;
bool seedSource = plant_raw->growths[i]->item_type == df::item_type::SEEDS;
if (plant_raw->growths[i]->item_type == df::item_type::PLANT_GROWTH)
{
for (size_t k = 0; growth_mat.material->reaction_product.material.mat_type.size(); k++)
{
if (plant_raw->growths[i]->item_type == df::item_type::PLANT_GROWTH) {
for (size_t k = 0; growth_mat.material->reaction_product.material.mat_type.size(); k++) {
if (growth_mat.material->reaction_product.material.mat_type[k] == plant_raw->material_defs.type[plant_material_def::seed] &&
growth_mat.material->reaction_product.material.mat_index[k] == plant_raw->material_defs.idx[plant_material_def::seed])
{
growth_mat.material->reaction_product.material.mat_index[k] == plant_raw->material_defs.idx[plant_material_def::seed]) {
seedSource = true;
break;
}
}
}
bool istree = (tileMaterial(Maps::getTileBlock(plant->pos)->tiletype[plant->pos.x % 16][plant->pos.y % 16]) == tiletype_material::TREE);
bool isripe = ripe(plant->pos.x, plant->pos.y, plant_raw->growths[i]->timing_1, plant_raw->growths[i]->timing_2);
if ((!farming || seedSource) && (istree || isripe) && !picked(plant, i))
{
if ((!farming || seedSource) &&
ripe(plant->pos.x, plant->pos.y, plant_raw->growths[i]->timing_1, plant_raw->growths[i]->timing_2) &&
!picked(plant, i))
return Designations::markPlant(plant);
}
}
}
}
return false;
}
command_result df_getplants (color_ostream &out, vector <string> & parameters)
{
command_result df_getplants(color_ostream& out, vector <string>& parameters) {
string plantMatStr = "";
std::vector<selectability> plantSelections;
std::vector<size_t> collectionCount;
@ -348,16 +322,14 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
plantSelections.resize(world->raws.plants.all.size());
collectionCount.resize(world->raws.plants.all.size());
for (size_t i = 0; i < plantSelections.size(); i++)
{
for (size_t i = 0; i < plantSelections.size(); i++) {
plantSelections[i] = selectability::Unselected;
collectionCount[i] = 0;
}
bool anyPlantsSelected = false;
for (size_t i = 0; i < parameters.size(); i++)
{
for (size_t i = 0; i < parameters.size(); i++) {
if (parameters[i] == "help" || parameters[i] == "?")
return CR_WRONG_USAGE;
else if (parameters[i] == "-t")
@ -374,23 +346,18 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
verbose = true;
else if (parameters[i] == "-f")
farming = true;
else if (parameters[i] == "-n")
{
if (parameters.size() > i + 1)
{
else if (parameters[i] == "-n") {
if (parameters.size() > i + 1) {
maxCount = atoi(parameters[i + 1].c_str());
if (maxCount >= 1)
{
if (maxCount >= 1) {
i++; // We've consumed the next parameter, so we need to progress the iterator.
}
else
{
else {
out.printerr("-n requires a positive integer parameter!\n");
return CR_WRONG_USAGE;
}
}
else
{
else {
out.printerr("-n requires a positive integer parameter!\n");
return CR_WRONG_USAGE;
}
@ -398,55 +365,43 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
else
plantNames.insert(toUpper(parameters[i]));
}
if (treesonly && shrubsonly)
{
if (treesonly && shrubsonly) {
out.printerr("Cannot specify both -t and -s at the same time!\n");
return CR_WRONG_USAGE;
}
if (treesonly && farming)
{
if (treesonly && farming) {
out.printerr("Cannot specify both -t and -f at the same time!\n");
return CR_WRONG_USAGE;
}
if (all && exclude)
{
if (all && exclude) {
out.printerr("Cannot specify both -a and -x at the same time!\n");
return CR_WRONG_USAGE;
}
if (all && plantNames.size())
{
if (all && plantNames.size()) {
out.printerr("Cannot specify -a along with plant IDs!\n");
return CR_WRONG_USAGE;
}
CoreSuspender suspend;
for (size_t i = 0; i < world->raws.plants.all.size(); i++)
{
df::plant_raw *plant = world->raws.plants.all[i];
if (all)
{
// plantSelections[i] = selectablePlant(out, plant, farming);
plantSelections[i] = selectablePlant(plant, farming);
for (size_t i = 0; i < world->raws.plants.all.size(); i++) {
df::plant_raw* plant = world->raws.plants.all[i];
if (all) {
plantSelections[i] = selectablePlant(out, plant, farming);
}
else if (plantNames.find(plant->id) != plantNames.end())
{
else if (plantNames.find(plant->id) != plantNames.end()) {
plantNames.erase(plant->id);
// plantSelections[i] = selectablePlant(out, plant, farming);
plantSelections[i] = selectablePlant(plant, farming);
switch (plantSelections[i])
{
plantSelections[i] = selectablePlant(out, plant, farming);
switch (plantSelections[i]) {
case selectability::Grass:
out.printerr("%s is a grass and cannot be gathered\n", plant->id.c_str());
break;
case selectability::Nonselectable:
if (farming)
{
if (farming) {
out.printerr("%s does not have any parts that can be gathered for seeds for farming\n", plant->id.c_str());
}
else
{
else {
out.printerr("%s does not have any parts that can be gathered\n", plant->id.c_str());
}
break;
@ -463,8 +418,7 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
}
}
}
if (plantNames.size() > 0)
{
if (plantNames.size() > 0) {
out.printerr("Invalid plant ID(s):");
for (set<string>::const_iterator it = plantNames.begin(); it != plantNames.end(); it++)
out.printerr(" %s", it->c_str());
@ -472,33 +426,26 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
return CR_FAILURE;
}
for (size_t i = 0; i < plantSelections.size(); i++)
{
for (size_t i = 0; i < plantSelections.size(); i++) {
if (plantSelections[i] == selectability::OutOfSeason ||
plantSelections[i] == selectability::Selectable)
{
plantSelections[i] == selectability::Selectable) {
anyPlantsSelected = true;
break;
}
}
if (!anyPlantsSelected)
{
if (!anyPlantsSelected) {
out.print("Valid plant IDs:\n");
for (size_t i = 0; i < world->raws.plants.all.size(); i++)
{
df::plant_raw *plant = world->raws.plants.all[i];
// switch (selectablePlant(out, plant, farming))
switch (selectablePlant(plant, farming))
{
for (size_t i = 0; i < world->raws.plants.all.size(); i++) {
df::plant_raw* plant = world->raws.plants.all[i];
switch (selectablePlant(out, plant, farming)) {
case selectability::Grass:
case selectability::Nonselectable:
continue;
case selectability::OutOfSeason:
{
if (!treesonly)
{
if (!treesonly) {
out.print("* (shrub) %s - %s is out of season\n", plant->id.c_str(), plant->name.c_str());
}
break;
@ -523,22 +470,21 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
}
count = 0;
for (size_t i = 0; i < world->plants.all.size(); i++)
{
const df::plant *plant = world->plants.all[i];
df::map_block *cur = Maps::getTileBlock(plant->pos);
for (size_t i = 0; i < world->plants.all.size(); i++) {
const df::plant* plant = world->plants.all[i];
df::map_block* cur = Maps::getTileBlock(plant->pos);
TRACE(log, out).print("Examining %s at (%i, %i, %i) [index=%d]\n", world->raws.plants.all[plant->material]->id.c_str(), plant->pos.x, plant->pos.y, plant->pos.z, (int)i);
int x = plant->pos.x % 16;
int y = plant->pos.y % 16;
if (plantSelections[plant->material] == selectability::OutOfSeason ||
plantSelections[plant->material] == selectability::Selectable)
{
plantSelections[plant->material] == selectability::Selectable) {
if (exclude ||
plantSelections[plant->material] == selectability::OutOfSeason)
continue;
}
else
{
else {
if (!exclude)
continue;
}
@ -553,37 +499,29 @@ command_result df_getplants (color_ostream &out, vector <string> & parameters)
continue;
if (collectionCount[plant->material] >= maxCount)
continue;
if (deselect && Designations::unmarkPlant(plant))
{
if (deselect && Designations::unmarkPlant(plant)) {
collectionCount[plant->material]++;
++count;
}
if (!deselect && designate(plant, farming))
{
// out.print("Designated %s at (%i, %i, %i), %d\n", world->raws.plants.all[plant->material]->id.c_str(), plant->pos.x, plant->pos.y, plant->pos.z, (int)i);
if (!deselect && designate(out, plant, farming)) {
DEBUG(log, out).print("Designated %s at (%i, %i, %i), %d\n", world->raws.plants.all[plant->material]->id.c_str(), plant->pos.x, plant->pos.y, plant->pos.z, (int)i);
collectionCount[plant->material]++;
++count;
}
}
if (count)
{
if (verbose)
{
for (size_t i = 0; i < plantSelections.size(); i++)
{
if (count && verbose) {
for (size_t i = 0; i < plantSelections.size(); i++) {
if (collectionCount[i] > 0)
out.print("Updated %d %s designations.\n", (int)collectionCount[i], world->raws.plants.all[i]->id.c_str());
}
out.print("\n");
}
}
out.print("Updated %d plant designations.\n", (int)count);
return CR_OK;
}
DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCommand> &commands)
{
DFhackCExport command_result plugin_init(color_ostream& out, vector <PluginCommand>& commands) {
commands.push_back(PluginCommand(
"getplants",
"Designate trees for chopping and shrubs for gathering.",
@ -591,7 +529,6 @@ DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCom
return CR_OK;
}
DFhackCExport command_result plugin_shutdown ( color_ostream &out )
{
DFhackCExport command_result plugin_shutdown(color_ostream& out) {
return CR_OK;
}