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 pathpathable.cpp
More file actions
448 lines (386 loc) · 15.9 KB
/
Copy pathpathable.cpp
File metadata and controls
448 lines (386 loc) · 15.9 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
#include <stack>
#include "Debug.h"
#include "Error.h"
#include "PluginManager.h"
#include "PluginLua.h"
#include "TileTypes.h"
#include "df/building_type.h"
#include "df/building_hatchst.h"
#include "df/building_bars_floorst.h"
#include "df/building_grate_floorst.h"
#include "df/tile_building_occ.h"
#include "modules/Buildings.h"
#include "modules/Gui.h"
#include "modules/Maps.h"
#include "modules/Screen.h"
#include "modules/Textures.h"
#include "df/building_tradedepotst.h"
#include "df/init.h"
#include "df/plotinfost.h"
#include "df/world.h"
using namespace DFHack;
using std::stack;
using std::unordered_set;
DFHACK_PLUGIN("pathable");
REQUIRE_GLOBAL(init);
REQUIRE_GLOBAL(plotinfo);
REQUIRE_GLOBAL(window_x);
REQUIRE_GLOBAL(window_y);
REQUIRE_GLOBAL(window_z);
REQUIRE_GLOBAL(world);
namespace DFHack {
DBG_DECLARE(pathable, log, DebugCategory::LINFO);
}
static std::vector<TexposHandle> textures;
DFhackCExport command_result plugin_init(color_ostream &out, std::vector<PluginCommand> &commands) {
textures = Textures::loadTileset("hack/data/art/pathable.png", 32, 32, true);
return CR_OK;
}
DFhackCExport command_result plugin_shutdown(color_ostream &out) {
return CR_OK;
}
struct PaintCtx {
bool use_graphics;
int selected_tile_texpos;
long pathable_tile_texpos;
long unpathable_tile_texpos;
PaintCtx() {
use_graphics = Screen::inGraphicsMode();
selected_tile_texpos = 0;
Screen::findGraphicsTile("CURSORS", 4, 3, &selected_tile_texpos);
pathable_tile_texpos = init->load_bar_texpos[1];
unpathable_tile_texpos = init->load_bar_texpos[4];
long on_off_texpos = Textures::getTexposByHandle(textures[0]);
if (on_off_texpos > 0) {
pathable_tile_texpos = on_off_texpos;
unpathable_tile_texpos = Textures::getTexposByHandle(textures[1]);
}
}
};
static void paint_screen(const PaintCtx & ctx, const unordered_set<df::coord> & targets,
bool show_hidden, std::function<bool(const df::coord & pos)> get_can_walk)
{
auto dims = Gui::getDwarfmodeViewDims().map();
for (int y = dims.first.y; y <= dims.second.y; ++y) {
for (int x = dims.first.x; x <= dims.second.x; ++x) {
df::coord map_pos(*window_x + x, *window_y + y, *window_z);
if (!Maps::isValidTilePos(map_pos))
continue;
if (!show_hidden && !Maps::isTileVisible(map_pos)) {
TRACE(log).print("skipping hidden tile\n");
continue;
}
DEBUG(log).print("scanning map tile at offset {}, {}\n", x, y);
Screen::Pen cur_tile = Screen::readTile(x, y, true);
DEBUG(log).print("tile data: ch={}, fg={}, bg={}, bold={}\n",
cur_tile.ch, cur_tile.fg, cur_tile.bg, cur_tile.bold ? "true" : "false");
DEBUG(log).print("tile data: tile={}, tile_mode={}, tile_fg={}, tile_bg={}\n",
cur_tile.tile, static_cast<int>(cur_tile.tile_mode), cur_tile.tile_fg, cur_tile.tile_bg);
if (!cur_tile.valid()) {
DEBUG(log).print("cannot read tile at offset {}, {}\n", x, y);
continue;
}
bool can_walk = get_can_walk(map_pos);
DEBUG(log).print("tile is {}walkable at offset {}, {}\n",
can_walk ? "" : "not ", x, y);
if (ctx.use_graphics) {
if (targets.contains(map_pos)) {
cur_tile.tile = ctx.selected_tile_texpos;
} else{
cur_tile.tile = can_walk ?
ctx.pathable_tile_texpos : ctx.unpathable_tile_texpos;
}
} else {
int color = can_walk ? COLOR_GREEN : COLOR_RED;
if (targets.contains(map_pos))
color = COLOR_CYAN;
if (cur_tile.fg && cur_tile.ch != ' ') {
cur_tile.fg = color;
cur_tile.bg = 0;
} else {
cur_tile.fg = 0;
cur_tile.bg = color;
}
cur_tile.bold = false;
if (cur_tile.tile)
cur_tile.tile_mode = Screen::Pen::CharColor;
}
Screen::paintTile(cur_tile, x, y, true);
}
}
}
static void paintScreenPathable(df::coord target, bool show_hidden = false) {
DEBUG(log).print("entering paintScreen\n");
PaintCtx ctx;
unordered_set<df::coord> targets;
targets.emplace(target);
paint_screen(ctx, targets, show_hidden, [&](const df::coord & pos){
return Maps::canWalkBetween(target, pos);
});
}
static bool get_depot_coords(color_ostream &out, unordered_set<df::coord> * depot_coords) {
CHECK_NULL_POINTER(depot_coords);
depot_coords->clear();
for (auto bld : world->buildings.other.TRADE_DEPOT){
DEBUG(log,out).print("found depot at ({}, {}, {})\n", bld->centerx, bld->centery, bld->z);
depot_coords->emplace(bld->centerx, bld->centery, bld->z);
}
return !depot_coords->empty();
}
static bool get_pathability_groups(color_ostream &out, unordered_set<uint16_t> * depot_pathability_groups,
const unordered_set<df::coord> & depot_coords)
{
CHECK_NULL_POINTER(depot_pathability_groups);
for (auto pos : depot_coords) {
auto wgroup = Maps::getWalkableGroup(pos);
if (wgroup) {
DEBUG(log,out).print("walkability group at ({}, {}, {}) is {}\n", pos.x, pos.y, pos.z, wgroup);
depot_pathability_groups->emplace(wgroup);
}
}
return !depot_pathability_groups->empty();
}
// if entry_tiles is given, it is filled with the surface edge tiles that match one of the given
// depot pathability groups. If entry_tiles is NULL, just returns true if such a tile is found.
// returns false if no tiles are found
static bool get_entry_tiles(unordered_set<df::coord> * entry_tiles, const unordered_set<uint16_t> & depot_pathability_groups) {
auto & edge = plotinfo->map_edge;
size_t num_edge_tiles = edge.surface_x.size();
uint32_t count_x, count_y, count_z;
Maps::getTileSize(count_x, count_y, count_z);
if (!count_x || !count_y)
return false;
uint16_t max_x = count_x - 1;
uint16_t max_y = count_y - 1;
bool found = false;
for (size_t idx = 0; idx < num_edge_tiles; ++idx) {
df::coord pos(edge.surface_x[idx], edge.surface_y[idx], edge.surface_z[idx]);
auto wgroup = Maps::getWalkableGroup(pos);
if (depot_pathability_groups.contains(wgroup) &&
(pos.x == 0 || pos.y == 0 || pos.x == max_x || pos.y == max_y)) {
found = true;
if (!entry_tiles)
break;
entry_tiles->emplace(pos);
}
}
return found;
}
static bool getDepotAccessibleByAnimals(color_ostream &out) {
unordered_set<df::coord> depot_coords;
if (!get_depot_coords(out, &depot_coords))
return false;
unordered_set<uint16_t> depot_pathability_groups;
if (!get_pathability_groups(out, &depot_pathability_groups, depot_coords))
return false;
return get_entry_tiles(NULL, depot_pathability_groups);
}
struct FloodCtx {
uint16_t wgroup;
unordered_set<df::coord> & wagon_path;
unordered_set<df::coord> seen; // contains tiles that should not be added to search_edge
stack<df::coord> search_edge; // contains tiles that can be successfully moved into
const unordered_set<df::coord> & entry_tiles;
FloodCtx(uint16_t wgroup, unordered_set<df::coord> & wagon_path, const unordered_set<df::coord> & entry_tiles)
: wgroup(wgroup), wagon_path(wagon_path), entry_tiles(entry_tiles) {}
};
static bool is_wagon_dynamic_traversible(df::tiletype_shape shape, const df::coord & pos) {
auto bld = Buildings::findAtTile(pos);
if (!bld) return false;
auto btype = bld->getType();
// open hatch should be inaccessible regardless of the tile it sits on
if (btype == df::building_type::Hatch) {
if (shape == df::tiletype_shape::RAMP_TOP)
return false;
auto& hatch = *static_cast<df::building_hatchst*>(bld);
if (hatch.door_flags.bits.closed)
return true;
// open floor grate/bar should be inaccessible regardless of the tile it sits on
} else if (btype == df::building_type::GrateFloor) {
auto& b = *static_cast<df::building_grate_floorst*>(bld);
if (b.gate_flags.bits.closed)
return true;
} else if (btype == df::building_type::BarsFloor) {
auto& b = *static_cast<df::building_bars_floorst*>(bld);
if (b.gate_flags.bits.closed)
return true;
}
// Doors, traps..etc
return false;
}
// NOTE: When i.e. tracks, stairs have a bridge over them, the tile will have
// an occupancy of floored.
static bool is_wagon_tile_traversible(df::tiletype tt) {
auto shape = tileShape(tt);
auto special = tileSpecial(tt);
auto material = tileMaterial(tt);
// Allow ramps (murky pool and river tiles are blocked except for ramps)
if (shape == df::tiletype_shape::RAMP_TOP)
return true;
// NOTE: smoothing a boulder turns it into a smoothed floor
else if (shape == df::tiletype_shape::STAIR_UP || shape == df::tiletype_shape::STAIR_DOWN ||
shape == df::tiletype_shape::STAIR_UPDOWN || shape == df::tiletype_shape::BOULDER ||
shape == df::tiletype_shape::EMPTY || shape == df::tiletype_shape::NONE)
return false;
else if (special == df::tiletype_special::TRACK)
return false;
// Fires seem to have their own path group, and group for lava is 0
// According to wiki, the wagon won't path thru pool and river tiles, but ramps are ok
else if (material == df::tiletype_material::POOL || material == df::tiletype_material::RIVER)
return false;
return true;
}
static bool is_wagon_traversible(FloodCtx & ctx, const df::coord & pos, const df::coord & prev_pos) {
auto tt = Maps::getTileType(pos);
if (!tt)
return false;
auto shape = tileShape(*tt);
auto occp = Maps::getTileOccupancy(pos);
if (!occp)
return false;
auto & occ = *occp;
switch (occ.bits.building) {
case tile_building_occ::Obstacle: // Statues, windmills (middle tile)
//FALLTHROUGH
case tile_building_occ::Well:
//FALLTHROUGH
case tile_building_occ::Impassable: // Raised bridges
return false;
case tile_building_occ::Dynamic:
// doors(block), levers (block), traps (block), hatches (OK, but block on down ramp)
// closed floor grates (OK), closed floor bars (OK)
if (is_wagon_dynamic_traversible(shape, pos) == false)
return false;
break;
case tile_building_occ::None: // Not occupied by a building
//FALLTHROUGH
case tile_building_occ::Planned:
//FALLTHROUGH
case tile_building_occ::Passable:
// Any tile with no building or a passable building including
// beds, supports, rollers, armor/weapon stands, cages (not traps),
// open wall grate/vertical bars, retracted bridges, open floodgates,
// workshops (tiles with open space are handled by the tile check)
if (is_wagon_tile_traversible(*tt) == false)
return false;
break;
case tile_building_occ::Floored:
// depot, lowered bridges or retractable bridges, forbidden hatches
break;
}
if (ctx.wgroup == Maps::getWalkableGroup(pos))
return true;
if (shape == df::tiletype_shape::RAMP_TOP ) {
df::coord pos_below = pos + df::coord(0, 0, -1);
if (Maps::getWalkableGroup(pos_below)) {
ctx.search_edge.emplace(pos_below);
return true;
}
} else if (shape == df::tiletype_shape::WALL) {
auto prev_tt = Maps::getTileType(prev_pos);
if (prev_tt && tileShape(*prev_tt) == df::tiletype_shape::RAMP) {
df::coord pos_above = pos + df::coord(0, 0, 1);
if (Maps::getWalkableGroup(pos_above)) {
ctx.search_edge.emplace(pos_above);
return true;
}
}
}
return false;
}
static void check_wagon_tile(FloodCtx & ctx, const df::coord & pos) {
if (ctx.seen.contains(pos))
return;
ctx.seen.emplace(pos);
if (ctx.entry_tiles.contains(pos)) {
ctx.wagon_path.emplace(pos); // Is this needed?
ctx.search_edge.emplace(pos);
return;
}
if (is_wagon_traversible(ctx, pos, pos) &&
is_wagon_traversible(ctx, pos+df::coord(-1, -1, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord( 0, -1, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord( 1, -1, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord(-1, 0, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord( 1, 0, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord(-1, 1, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord( 0, 1, 0), pos) &&
is_wagon_traversible(ctx, pos+df::coord( 1, 1, 0), pos))
{
ctx.wagon_path.emplace(pos);
ctx.search_edge.emplace(pos);
}
}
// returns true if a continuous 3-wide path can be found to an entry tile
// assumes:
// - wagons can only move in orthogonal directions
// - if three adjacent tiles are in the same pathability group, then they are traversible by a wagon
// - a wagon needs a single ramp to move elevations as long as the adjacent tiles are walkable
// TODO: cannot traverse doors, up stairs, or up/down stairs
static bool wagon_flood(color_ostream &out, unordered_set<df::coord> * wagon_path, const df::coord & depot_pos,
const unordered_set<df::coord> & entry_tiles)
{
unordered_set<df::coord> temp_wagon_path;
FloodCtx ctx(Maps::getWalkableGroup(depot_pos), wagon_path ? *wagon_path : temp_wagon_path, entry_tiles);
if (!ctx.wgroup)
return false;
bool found = false;
ctx.wagon_path.emplace(depot_pos);
ctx.seen.emplace(depot_pos);
ctx.search_edge.emplace(depot_pos);
while (!ctx.search_edge.empty()) {
df::coord pos = ctx.search_edge.top();
ctx.search_edge.pop();
TRACE(log,out).print("checking tile: ({}, {}, {}); pathability group: {}\n", pos.x, pos.y, pos.z,
Maps::getWalkableGroup(pos));
if (entry_tiles.contains(pos)) {
found = true;
if (!wagon_path)
break;
continue;
}
check_wagon_tile(ctx, pos+df::coord( 0, -1, 0));
check_wagon_tile(ctx, pos+df::coord( 0, 1, 0));
check_wagon_tile(ctx, pos+df::coord(-1, 0, 0));
check_wagon_tile(ctx, pos+df::coord( 1, 0, 0));
}
return found;
}
static unordered_set<df::coord> wagon_path;
static unordered_set<df::coord> entry_tiles;
static bool getDepotAccessibleByWagons(color_ostream &out, bool cache_scan_for_painting) {
if (cache_scan_for_painting) {
entry_tiles.clear();
wagon_path.clear();
}
unordered_set<df::coord> depot_coords;
if (!get_depot_coords(out, &depot_coords))
return false;
unordered_set<uint16_t> depot_pathability_groups;
if (!get_pathability_groups(out, &depot_pathability_groups, depot_coords))
return false;
if (!get_entry_tiles(&entry_tiles, depot_pathability_groups))
return false;
bool found_edge = false;
for (auto depot_pos : depot_coords) {
if (wagon_flood(out, cache_scan_for_painting ? &wagon_path : NULL, depot_pos, entry_tiles)) {
found_edge = true;
if (!cache_scan_for_painting)
break;
}
}
return found_edge;
}
static void paintScreenDepotAccess() {
PaintCtx ctx;
paint_screen(ctx, entry_tiles, false, [&](const df::coord & pos){
return wagon_path.contains(pos);
});
}
DFHACK_PLUGIN_LUA_FUNCTIONS {
DFHACK_LUA_FUNCTION(paintScreenPathable),
DFHACK_LUA_FUNCTION(getDepotAccessibleByAnimals),
DFHACK_LUA_FUNCTION(getDepotAccessibleByWagons),
DFHACK_LUA_FUNCTION(paintScreenDepotAccess),
DFHACK_LUA_END
};
You can’t perform that action at this time.