Skip to content
Navigation Menu
{{ message }}
forked from DFHack/dfhack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgetplants.cpp
More file actions
541 lines (483 loc) · 22.3 KB
/
Copy pathgetplants.cpp
File metadata and controls
541 lines (483 loc) · 22.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
#include "Debug.h"
#include "PluginManager.h"
#include "TileTypes.h"
#include "modules/Designations.h"
#include "modules/Maps.h"
#include "modules/Materials.h"
#include "modules/Random.h"
#include "df/map_block.h"
#include "df/map_block_column.h"
#include "df/material.h"
#include "df/material_flags.h"
#include "df/plant.h"
#include "df/plant_growth.h"
#include "df/plant_raw.h"
#include "df/tile_dig_designation.h"
#include "df/plotinfost.h"
#include "df/world.h"
#include "df/world_data.h"
#include "df/world_object_data.h"
#include "df/world_site.h"
#include <set>
using std::string;
using std::vector;
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);
REQUIRE_GLOBAL(cur_year);
REQUIRE_GLOBAL(cur_year_tick);
enum class selectability {
Selectable,
Grass,
Nonselectable,
OutOfSeason,
Unselected
};
// Determination of whether seeds can be collected is somewhat messy:
// - Growths of type SEEDS are collected only if they are edible either raw or cooked.
// - Growths of type PLANT_GROWTH are collected provided the STOCKPILE_PLANT_GROWTH
// flag is set.
// The two points above were determined through examination of the DF code, while the ones
// below were determined through examination of the behavior of bugged, working, and
// RAW manipulated shrubs on embarks.
// - If seeds are defined as explicit growths, they are the source of seeds, overriding
// the default STRUCTURAL part as the source.
// - If a growth has the reaction that extracts seeds as a side effect of other
// processing (brewing, eating raw, etc.), this overrides the STRUCTURAL part as the
// source of seeds. However, for some reason it does not produce seeds from eating
// raw growths unless the structural part is collected (at least for shrubs: other
// processing was not examined).
// - If a growth has a (non vanilla) reaction that produces seeds, seeds are produced,
// provided there is something (such as a workshop order) that triggers it.
// The code below is satisfied with detection of a seed producing reaction, and does not
// detect the bugged case where a seed extraction process is defined but doesn't get
// triggered. Such a process can be triggered either as a side effect of other
// processing, or as a workshop reaction, and it would be overkill for this code to
// try to determine if a workshop reaction exists and has been permitted for the played
// race.
// There are two bugged cases of this in the current vanilla RAWs:
// Both Red Spinach and Elephant-Head Amaranth have the seed extraction reaction
// explicitly specified for the structural part, but no other use for it. This causes
// these parts to be collected (a valid reaction is defined), but remain unusable. This
// 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) {
TRACE(log, out).print("analyzing {}\n", plant->id);
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)) {
DEBUG(log, out).print("{} is a selectable tree\n", plant->id);
if (farming) {
return selectability::Nonselectable;
}
else {
return selectability::Selectable;
}
}
else if (plant->flags.is_set(plant_raw_flags::GRASS)) {
DEBUG(log, out).print("{} is a non selectable Grass\n", plant->id);
return selectability::Grass;
}
if (farming && plant->material_defs.type[plant_material_def::seed] == -1) {
return selectability::Nonselectable;
}
if (basic_mat.isValid() &&
(basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW) ||
basic_mat.material->flags.is_set(material_flags::EDIBLE_COOKED)))
{
DEBUG(log, out).print("{} is edible\n", plant->id);
if (farming) {
if (basic_mat.material->flags.is_set(material_flags::EDIBLE_RAW)) {
result = selectability::Selectable;
}
}
else {
return selectability::Selectable;
}
}
if (plant->flags.is_set(plant_raw_flags::THREAD) ||
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)) {
DEBUG(log, out).print("{} is thread/mill/extract\n", plant->id);
if (farming) {
result = selectability::Selectable;
}
else {
return selectability::Selectable;
}
}
if (basic_mat.isValid() &&
(basic_mat.material->reaction_product.id.size() > 0 ||
basic_mat.material->reaction_class.size() > 0))
{
DEBUG(log, out).print("{} has a reaction\n", plant->id);
if (farming) {
result = selectability::Selectable;
}
else {
return selectability::Selectable;
}
}
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) {
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) ||
growth_mat.material->flags.is_set(material_flags::EDIBLE_RAW))) ||
(plant->growths[i]->item_type == df::item_type::PLANT_GROWTH &&
growth_mat.material->flags.is_set(material_flags::STOCKPILE_PLANT_GROWTH)))
{
bool seedSource = plant->growths[i]->item_type == df::item_type::SEEDS;
if (plant->growths[i]->item_type == df::item_type::PLANT_GROWTH) {
auto& mat = growth_mat.material->reaction_product.material;
for (size_t k = 0; k < mat.mat_type.size(); k++) {
if (mat.mat_type[k] == plant->material_defs.type[plant_material_def::seed] &&
mat.mat_index[k] == plant->material_defs.idx[plant_material_def::seed]) {
seedSource = true;
break;
}
}
}
if (*cur_year_tick >= plant->growths[i]->timing_1 &&
(plant->growths[i]->timing_2 == -1 ||
*cur_year_tick <= plant->growths[i]->timing_2)) {
DEBUG(log, out).print("{} has an edible seed or a stockpile growth\n", plant->id);
if (!farming || seedSource) {
return selectability::Selectable;
}
}
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.
{
const DFHack::MaterialInfo seed_mat = DFHack::MaterialInfo(plant->material_defs.type[plant_material_def::seed], plant->material_defs.idx[plant_material_def::seed]);
if (seed_mat.material->flags.is_set(material_flags::EDIBLE_RAW) ||
seed_mat.material->flags.is_set(material_flags::EDIBLE_COOKED))
{
if (*cur_year_tick >= plant->growths[i]->timing_1 &&
(plant->growths[i]->timing_2 == -1 ||
*cur_year_tick <= plant->growths[i]->timing_2))
{
return selectability::Selectable;
}
else
{
outOfSeason = true;
}
}
} */
}
if (outOfSeason) {
DEBUG(log, out).print("{} has an out of season growth\n", plant->id);
return selectability::OutOfSeason;
}
else {
DEBUG(log, out).print("{} cannot be gathered\n", plant->id);
return result;
}
}
// Formula for determination of the variance in plant growth maturation time, determined via disassembly.
// The coordinates are relative to the embark region.
bool ripe(int32_t x, int32_t y, int32_t z, int32_t start, int32_t end) {
DFHack::Random::SplitmixRNG rng((world->map.region_x * 48 + x) + (world->map.region_y * 48 + y) * 10000 + (world->map.region_z + z) * 100000000);
int32_t time = (rng.df_trandom(2000) + *cur_year_tick) % 403200;
return time >= start && (end == -1 || time <= end);
}
// Looks in the local creation zone's picked growths vector to see if a matching growth has been marked as picked.
bool picked(const df::plant* plant, int32_t growth_subtype, int32_t growth_density) {
int32_t pos_x = plant->pos.x / 48 + world->map.region_x;
int32_t pos_y = plant->pos.y / 48 + world->map.region_y;
size_t cz_id = pos_x + pos_y * 16 * world->world_data->world_width;
auto cz = df::world_object_data::find(cz_id);
if (!cz) {
return false;
}
for (size_t i = 0; i < cz->picked_growths.x.size(); i++) {
if (cz->picked_growths.x[i] == (plant->pos.x % 48) &&
cz->picked_growths.y[i] == (plant->pos.y % 48) &&
cz->picked_growths.z[i] == (plant->pos.z + world->map.region_z) &&
cz->picked_growths.density[i] >= growth_density &&
cz->picked_growths.subtype[i] == growth_subtype &&
cz->picked_growths.year[i] == *cur_year) {
return true;
}
}
return false;
}
bool designate(color_ostream& out, const df::plant* plant, bool farming) {
TRACE(log, out).print("Attempting to designate {} at ({}, {}, {})\n", world->raws.plants.all[plant->material]->id, 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)) {
return Designations::markPlant(plant);
}
if (plant_raw->flags.is_set(plant_raw_flags::THREAD) ||
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)) {
if (!farming) {
return Designations::markPlant(plant);
}
}
if (basic_mat.material->reaction_product.id.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++) {
TRACE(log, out).print("growth item type={}\n", ENUM_AS_STR(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);
TRACE(log, out).print("edible_cooked={} edible_raw={} leaf_mat={}\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::STOCKPILE_PLANT_GROWTH));
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::STOCKPILE_PLANT_GROWTH)))
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 (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]) {
seedSource = true;
break;
}
}
}
if ((!farming || seedSource) &&
ripe(plant->pos.x, plant->pos.y, plant->pos.z, plant_raw->growths[i]->timing_1, plant_raw->growths[i]->timing_2) &&
!picked(plant, i, plant_raw->growths[i]->density))
return Designations::markPlant(plant);
}
return false;
}
command_result df_getplants(color_ostream& out, vector <string>& parameters) {
string plantMatStr = "";
std::vector<selectability> plantSelections;
std::vector<size_t> collectionCount;
set<string> plantNames;
bool deselect = false, exclude = false, treesonly = false, shrubsonly = false, all = false, verbose = false, farming = false;
size_t maxCount = 999999;
int count = 0;
plantSelections.resize(world->raws.plants.all.size());
collectionCount.resize(world->raws.plants.all.size());
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++) {
if (parameters[i] == "help" || parameters[i] == "?")
return CR_WRONG_USAGE;
else if (parameters[i] == "-t")
treesonly = true;
else if (parameters[i] == "-s")
shrubsonly = true;
else if (parameters[i] == "-c")
deselect = true;
else if (parameters[i] == "-x")
exclude = true;
else if (parameters[i] == "-a")
all = true;
else if (parameters[i] == "-v")
verbose = true;
else if (parameters[i] == "-f")
farming = true;
else if (parameters[i] == "-n") {
if (parameters.size() > i + 1) {
maxCount = atoi(parameters[i + 1].c_str());
if (maxCount >= 1) {
i++; // We've consumed the next parameter, so we need to progress the iterator.
}
else {
out.printerr("-n requires a positive integer parameter!\n");
return CR_WRONG_USAGE;
}
}
else {
out.printerr("-n requires a positive integer parameter!\n");
return CR_WRONG_USAGE;
}
}
else
plantNames.insert(toUpper_cp437(parameters[i]));
}
if (treesonly && shrubsonly) {
out.printerr("Cannot specify both -t and -s at the same time!\n");
return CR_WRONG_USAGE;
}
if (treesonly && farming) {
out.printerr("Cannot specify both -t and -f at the same time!\n");
return CR_WRONG_USAGE;
}
if (all && exclude) {
out.printerr("Cannot specify both -a and -x at the same time!\n");
return CR_WRONG_USAGE;
}
if (all && plantNames.size()) {
out.printerr("Cannot specify -a along with plant IDs!\n");
return CR_WRONG_USAGE;
}
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()) {
plantNames.erase(plant->id);
plantSelections[i] = selectablePlant(out, plant, farming);
switch (plantSelections[i]) {
case selectability::Grass:
out.printerr("{} is a grass and cannot be gathered\n", plant->id);
break;
case selectability::Nonselectable:
if (farming) {
out.printerr("{} does not have any parts that can be gathered for seeds for farming\n", plant->id);
}
else {
out.printerr("{} does not have any parts that can be gathered\n", plant->id);
}
break;
case selectability::OutOfSeason:
out.printerr("{} is out of season, with nothing that can be gathered now\n", plant->id);
break;
case selectability::Selectable:
break;
case selectability::Unselected:
break; // We won't get to this option
}
}
}
if (plantNames.size() > 0) {
out.printerr("Invalid plant ID(s):");
for (set<string>::const_iterator it = plantNames.begin(); it != plantNames.end(); it++)
out.printerr(" {}", *it);
out.printerr("\n");
return CR_FAILURE;
}
for (size_t i = 0; i < plantSelections.size(); i++) {
if (plantSelections[i] == selectability::OutOfSeason ||
plantSelections[i] == selectability::Selectable) {
anyPlantsSelected = true;
break;
}
}
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)) {
case selectability::Grass:
case selectability::Nonselectable:
continue;
case selectability::OutOfSeason:
{
if (!treesonly) {
out.print("* (shrub) {} - {} is out of season\n", plant->id, plant->name);
}
break;
}
case selectability::Selectable:
{
if ((treesonly && plant->flags.is_set(plant_raw_flags::TREE)) ||
(shrubsonly && !plant->flags.is_set(plant_raw_flags::TREE)) ||
(!treesonly && !shrubsonly)) // 'farming' weeds out trees when determining selectability, so no need to test that explicitly
{
out.print("* ({}) {} - {}\n", plant->flags.is_set(plant_raw_flags::TREE) ? "tree" : "shrub", plant->id, plant->name);
}
break;
}
case selectability::Unselected: // Should never get this alternative
break;
}
}
return CR_OK;
}
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);
TRACE(log, out).print("Examining {} at ({}, {}, {}) [index={}]\n", world->raws.plants.all[plant->material]->id, 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) {
if (exclude ||
plantSelections[plant->material] == selectability::OutOfSeason)
continue;
}
else {
if (!exclude)
continue;
}
df::tiletype tt = cur->tiletype[x][y];
df::tiletype_material mat = tileMaterial(tt);
if ((treesonly || tt != tiletype::Shrub) && ENUM_ATTR(plant_type, is_shrub, plant->type))
continue;
if ((shrubsonly || mat != tiletype_material::TREE) && !ENUM_ATTR(plant_type, is_shrub, plant->type))
continue;
if (cur->designation[x][y].bits.hidden)
continue;
if (collectionCount[plant->material] >= maxCount)
continue;
if (deselect && Designations::unmarkPlant(plant)) {
collectionCount[plant->material]++;
++count;
}
if (!deselect && designate(out, plant, farming)) {
DEBUG(log, out).print("Designated {} at ({}, {}, {}), {}\n", world->raws.plants.all[plant->material]->id, plant->pos.x, plant->pos.y, plant->pos.z, (int)i);
collectionCount[plant->material]++;
++count;
}
}
if (count && verbose) {
for (size_t i = 0; i < plantSelections.size(); i++) {
if (collectionCount[i] > 0)
out.print("Updated {} {} designations.\n", collectionCount[i], world->raws.plants.all[i]->id);
}
out.print("\n");
}
out.print("Updated {} plant designations.\n", count);
return CR_OK;
}
DFhackCExport command_result plugin_init(color_ostream& out, vector <PluginCommand>& commands) {
commands.push_back(PluginCommand(
"getplants",
"Designate trees for chopping and shrubs for gathering.",
df_getplants));
return CR_OK;
}
DFhackCExport command_result plugin_shutdown(color_ostream& out) {
return CR_OK;
}
You can’t perform that action at this time.