-
Notifications
You must be signed in to change notification settings - Fork 496
Expand file tree
/
Copy pathnestboxes.cpp
More file actions
216 lines (183 loc) · 6.75 KB
/
nestboxes.cpp
File metadata and controls
216 lines (183 loc) · 6.75 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
#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"
#include "df/world.h"
using std::string;
using namespace DFHack;
using namespace df::enums;
DFHACK_PLUGIN("nestboxes");
DFHACK_PLUGIN_IS_ENABLED(is_enabled);
REQUIRE_GLOBAL(world);
namespace DFHack {
// for configuration-related logging
DBG_DECLARE(nestboxes, control, DebugCategory::LINFO);
// for logging during the periodic scan
DBG_DECLARE(nestboxes, cycle, DebugCategory::LINFO);
}
static const string CONFIG_KEY = string(plugin_name) + "/config";
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> ¶meters);
DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands) {
DEBUG(control,out).print("initializing {}\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;
}
DFhackCExport command_result plugin_enable(color_ostream &out, bool enable) {
if (!Core::getInstance().isMapLoaded() || !World::isFortressMode()) {
out.printerr("Cannot enable {} without a loaded fort.\n", plugin_name);
return CR_FAILURE;
}
if (enable != is_enabled) {
is_enabled = enable;
DEBUG(control,out).print("{} from the API; persisting\n",
is_enabled ? "enabled" : "disabled");
config.set_bool(CONFIG_IS_ENABLED, is_enabled);
if (enable)
do_cycle(out);
} else {
DEBUG(control,out).print("{} from the API, but already {}; no action\n",
is_enabled ? "enabled" : "disabled",
is_enabled ? "enabled" : "disabled");
}
return CR_OK;
}
DFhackCExport command_result plugin_shutdown (color_ostream &out) {
DEBUG(control,out).print("shutting down {}\n", plugin_name);
return CR_OK;
}
DFhackCExport command_result plugin_load_site_data (color_ostream &out) {
cycle_timestamp = 0;
config = World::GetPersistentSiteData(CONFIG_KEY);
if (!config.isValid()) {
DEBUG(control,out).print("no config found in this save; initializing\n");
config = World::AddPersistentSiteData(CONFIG_KEY);
config.set_bool(CONFIG_IS_ENABLED, is_enabled);
}
is_enabled = config.get_bool(CONFIG_IS_ENABLED);
DEBUG(control,out).print("loading persisted enabled state: {}\n",
is_enabled ? "true" : "false");
return CR_OK;
}
DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) {
if (event == DFHack::SC_WORLD_UNLOADED) {
if (is_enabled) {
DEBUG(control,out).print("world unloaded; disabling {}\n",
plugin_name);
is_enabled = false;
}
}
return CR_OK;
}
DFhackCExport command_result plugin_onupdate(color_ostream &out) {
if (world->frame_counter - cycle_timestamp >= CYCLE_TICKS)
do_cycle(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("{} is disabled\n", plugin_name);
else {
out.print("{} is enabled\n", plugin_name);
auto burrow = getBurrow(out);
if (burrow)
{
out.print("only protecting eggs inside burrow: {}\n", burrow->name);
}
else
{
out.print("protecting all fertile eggs\n");
}
}
}
static command_result do_command(color_ostream &out, std::vector<string> ¶meters){
if (!Core::getInstance().isMapLoaded() || !World::isFortressMode()) {
out.printerr("Cannot run {} 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
//
static void do_cycle(color_ostream &out) {
DEBUG(cycle,out).print("running {} cycle\n", plugin_name);
// 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)
continue;
if (auto *item = virtual_cast<df::item_eggst>(contained_item->item)) {
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
df::specific_ref *sref = Items::getSpecificRef(
item, df::specific_ref_type::JOB);
if (sref && sref->data.job)
Job::removeJob(sref->data.job);
}
out.print("nestboxes: {} eggs {}\n", item->getStackSize(), fertile ? "forbidden" : "unforbidden");
}
}
}
}