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 pathblueprint.cpp
More file actions
1556 lines (1361 loc) · 53.9 KB
/
Copy pathblueprint.cpp
File metadata and controls
1556 lines (1361 loc) · 53.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
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Translates a region of tiles specified by the cursor and arguments/prompts
* into a series of blueprint files suitable for replay via quickfort.
*
* Written by cdombroski.
*/
#include <sstream>
#include <unordered_map>
#include "Console.h"
#include "DataDefs.h"
#include "DataFuncs.h"
#include "DataIdentity.h"
#include "Debug.h"
#include "LuaTools.h"
#include "PluginManager.h"
#include "TileTypes.h"
#include "modules/Buildings.h"
#include "modules/Filesystem.h"
#include "modules/Gui.h"
#include "df/building_axle_horizontalst.h"
#include "df/building_bridgest.h"
#include "df/building_civzonest.h"
#include "df/building_constructionst.h"
#include "df/building_furnacest.h"
#include "df/building_rollersst.h"
#include "df/building_screw_pumpst.h"
#include "df/building_siegeenginest.h"
#include "df/building_trapst.h"
#include "df/building_water_wheelst.h"
#include "df/building_workshopst.h"
#include "df/engraving.h"
#include "df/world.h"
using std::endl;
using std::ofstream;
using std::pair;
using std::map;
using std::string;
using std::vector;
using namespace DFHack;
DFHACK_PLUGIN("blueprint");
REQUIRE_GLOBAL(world);
namespace DFHack {
DBG_DECLARE(blueprint,log);
}
struct blueprint_options {
// whether to display help
bool help = false;
// starting tile coordinate of the translation area (if not set then all
// coordinates are set to -30000)
df::coord start;
// output file format. this could be an enum if we set up the boilerplate
// for it.
string format;
// whether to skip generating meta blueprints
bool nometa = false;
// offset and comment to write in the quickfort start() modeline marker
// if not set, coordinates are set to 0 and the comment will be empty
df::coord2d playback_start = df::coord2d(0, 0);
string playback_start_comment;
// file splitting strategy. this could be an enum if we set up the
// boilerplate for it.
string split_strategy;
// dimensions of translation area. width and height are guaranteed to be
// greater than 0. depth can be positive or negative, but not zero.
int32_t width = 0;
int32_t height = 0;
int32_t depth = 0;
// base name to use for generated files
string name;
// whether to capture all smoothed tiles
bool smooth = false;
// whether to capture engravings and smooth the tiles that will be engraved
bool engrave = false;
// whether to autodetect which phases to output
bool auto_phase = false;
// if not autodetecting, which phases to output
bool dig = false;
bool carve = false;
bool construct = false;
bool build = false;
bool place = false;
bool zone = false;
bool query = false;
bool rooms = false;
static struct_identity _identity;
};
static const struct_field_info blueprint_options_fields[] = {
{ struct_field_info::PRIMITIVE, "help", offsetof(blueprint_options, help), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::SUBSTRUCT, "start", offsetof(blueprint_options, start), &df::coord::_identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "format", offsetof(blueprint_options, format), df::identity_traits<string>::get(), 0, 0 },
{ struct_field_info::PRIMITIVE, "nometa", offsetof(blueprint_options, nometa), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::SUBSTRUCT, "playback_start", offsetof(blueprint_options, playback_start), &df::coord2d::_identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "playback_start_comment", offsetof(blueprint_options, playback_start_comment), df::identity_traits<string>::get(), 0, 0 },
{ struct_field_info::PRIMITIVE, "split_strategy", offsetof(blueprint_options, split_strategy), df::identity_traits<string>::get(), 0, 0 },
{ struct_field_info::PRIMITIVE, "width", offsetof(blueprint_options, width), &df::identity_traits<int32_t>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "height", offsetof(blueprint_options, height), &df::identity_traits<int32_t>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "depth", offsetof(blueprint_options, depth), &df::identity_traits<int32_t>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "name", offsetof(blueprint_options, name), df::identity_traits<string>::get(), 0, 0 },
{ struct_field_info::PRIMITIVE, "smooth", offsetof(blueprint_options, smooth), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "engrave", offsetof(blueprint_options, engrave), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "auto_phase", offsetof(blueprint_options, auto_phase), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "dig", offsetof(blueprint_options, dig), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "carve", offsetof(blueprint_options, carve), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "construct", offsetof(blueprint_options, construct), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "build", offsetof(blueprint_options, build), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "place", offsetof(blueprint_options, place), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "zone", offsetof(blueprint_options, zone), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "query", offsetof(blueprint_options, query), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::PRIMITIVE, "rooms", offsetof(blueprint_options, rooms), &df::identity_traits<bool>::identity, 0, 0 },
{ struct_field_info::END }
};
struct_identity blueprint_options::_identity(sizeof(blueprint_options), &df::allocator_fn<blueprint_options>, NULL, "blueprint_options", NULL, blueprint_options_fields);
command_result blueprint(color_ostream &, vector<string> &);
DFhackCExport command_result plugin_init(color_ostream &, vector<PluginCommand> &commands) {
commands.push_back(
PluginCommand("blueprint",
"Record a live game map in a quickfort blueprint.",
blueprint));
return CR_OK;
}
DFhackCExport command_result plugin_shutdown(color_ostream &) {
return CR_OK;
}
struct blueprint_processor;
struct tile_context {
blueprint_processor *processor;
bool pretty = false;
df::building* b = NULL;
};
typedef vector<const char *> bp_row; // index is x coordinate
typedef map<int16_t, bp_row> bp_area; // key is y coordinate
typedef map<int16_t, bp_area> bp_volume; // key is z coordinate
typedef const char * (get_tile_fn)(const df::coord &pos,
const tile_context &ctx);
typedef void (init_ctx_fn)(const df::coord &pos, tile_context &ctx);
struct blueprint_processor {
bp_volume mapdata;
const string mode;
const string phase;
const bool force_create;
get_tile_fn * const get_tile;
init_ctx_fn * const init_ctx;
std::set<df::building *> seen;
blueprint_processor(const string &mode, const string &phase,
bool force_create, get_tile_fn *get_tile,
init_ctx_fn *init_ctx)
: mode(mode), phase(phase), force_create(force_create),
get_tile(get_tile), init_ctx(init_ctx) { }
};
// global engravings cache, cleared when the string cache is cleared
struct PosHash {
size_t operator()(const df::coord &c) const {
return c.x * 65537 + c.y * 513 + c.z;
}
};
static std::unordered_map<df::coord, df::engraving *, PosHash> engravings_cache;
// We use const char * throughout this code instead of std::string to avoid
// having to allocate memory for all the small string literals. This
// significantly speeds up processing and allows us to handle very large maps
// (e.g. 16x16 embarks) without running out of memory. This cache provides a
// mechanism for storing dynamically created strings so their memory stays
// allocated until we write out the blueprints at the end.
// If NULL is passed as the str, the cache is cleared.
static const char * cache(const char *str) {
// this local static assumes that no two blueprints are being generated at
// the same time, which is currently ensured by the higher-level DFHack
// command handling code. if this assumption ever becomes untrue, we'll
// need to protect the cache with thread synchronization primitives.
static std::set<string> _cache;
if (!str) {
_cache.clear();
engravings_cache.clear();
return NULL;
}
return _cache.emplace(str).first->c_str();
}
// Convenience wrapper for std::string.
static const char * cache(const string &str) {
return cache(str.c_str());
}
// Convenience wrapper for std::ostringstream.
static const char * cache(std::ostringstream &str) {
return cache(str.str());
}
static const char * get_tile_dig(const df::coord &pos, const tile_context &) {
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::EMPTY:
case tiletype_shape::RAMP_TOP:
return "h";
case tiletype_shape::FLOOR:
case tiletype_shape::BOULDER:
case tiletype_shape::PEBBLES:
case tiletype_shape::BROOK_TOP:
return "d";
case tiletype_shape::STAIR_UP:
return "u";
case tiletype_shape::STAIR_DOWN:
return "j";
case tiletype_shape::STAIR_UPDOWN:
return "i";
case tiletype_shape::RAMP:
return "r";
case tiletype_shape::WALL:
default:
return NULL;
}
}
static const char * get_tile_smooth_minimal(const df::coord &pos,
const tile_context &) {
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::FORTIFICATION:
return "s";
default:
break;
}
return NULL;
}
static const char * get_tile_smooth_with_engravings(const df::coord &pos,
const tile_context &tc) {
const char * smooth_minimal = get_tile_smooth_minimal(pos, tc);
if (smooth_minimal)
return smooth_minimal;
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::FLOOR:
case tiletype_shape::WALL:
if (tileSpecial(*tt) == tiletype_special::SMOOTH &&
engravings_cache.count(pos))
return "s";
break;
default:
break;
}
return NULL;
}
static const char * get_tile_smooth_all(const df::coord &pos,
const tile_context &tc) {
const char * smooth_minimal = get_tile_smooth_minimal(pos, tc);
if (smooth_minimal)
return smooth_minimal;
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::FLOOR:
case tiletype_shape::WALL:
if (tileSpecial(*tt) == tiletype_special::SMOOTH)
return "s";
break;
default:
break;
}
return NULL;
}
static const char * get_track_str(const char *prefix, df::tiletype tt) {
TileDirection tdir = tileDirection(tt);
string dir;
if (tdir.north) dir += "N";
if (tdir.south) dir += "S";
if (tdir.east) dir += "E";
if (tdir.west) dir += "W";
return cache(prefix + dir);
}
static const char * get_tile_carve_minimal(const df::coord &pos,
const tile_context &) {
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::FLOOR:
if (tileSpecial(*tt) == tiletype_special::TRACK)
return get_track_str("track", *tt);
break;
case tiletype_shape::RAMP:
if (tileSpecial(*tt) == tiletype_special::TRACK)
return get_track_str("trackramp", *tt);
break;
case tiletype_shape::FORTIFICATION:
return "F";
default:
break;
}
return NULL;
}
static const char * get_tile_carve(const df::coord &pos, const tile_context &tc) {
const char * tile_carve_minimal = get_tile_carve_minimal(pos, tc);
if (tile_carve_minimal)
return tile_carve_minimal;
df::tiletype *tt = Maps::getTileType(pos);
if (!tt)
return NULL;
switch (tileShape(*tt))
{
case tiletype_shape::FLOOR:
case tiletype_shape::WALL:
if (tileSpecial(*tt) == tiletype_special::SMOOTH &&
engravings_cache.count(pos))
return "e";
break;
default:
break;
}
return NULL;
}
static const char * get_construction_str(df::building *b) {
df::building_constructionst *cons =
virtual_cast<df::building_constructionst>(b);
if (!cons)
return "~";
switch (cons->type) {
case construction_type::Fortification: return "CF";
case construction_type::Wall: return "Cw";
case construction_type::Floor: return "Cf";
case construction_type::UpStair: return "Cu";
case construction_type::DownStair: return "Cd";
case construction_type::UpDownStair: return "Cx";
case construction_type::Ramp: return "Cr";
case construction_type::TrackN: return "trackN";
case construction_type::TrackS: return "trackS";
case construction_type::TrackE: return "trackE";
case construction_type::TrackW: return "trackW";
case construction_type::TrackNS: return "trackNS";
case construction_type::TrackNE: return "trackNE";
case construction_type::TrackNW: return "trackNW";
case construction_type::TrackSE: return "trackSE";
case construction_type::TrackSW: return "trackSW";
case construction_type::TrackEW: return "trackEW";
case construction_type::TrackNSE: return "trackNSE";
case construction_type::TrackNSW: return "trackNSW";
case construction_type::TrackNEW: return "trackNEW";
case construction_type::TrackSEW: return "trackSEW";
case construction_type::TrackNSEW: return "trackNSEW";
case construction_type::TrackRampN: return "trackrampN";
case construction_type::TrackRampS: return "trackrampS";
case construction_type::TrackRampE: return "trackrampE";
case construction_type::TrackRampW: return "trackrampW";
case construction_type::TrackRampNS: return "trackrampNS";
case construction_type::TrackRampNE: return "trackrampNE";
case construction_type::TrackRampNW: return "trackrampNW";
case construction_type::TrackRampSE: return "trackrampSE";
case construction_type::TrackRampSW: return "trackrampSW";
case construction_type::TrackRampEW: return "trackrampEW";
case construction_type::TrackRampNSE: return "trackrampNSE";
case construction_type::TrackRampNSW: return "trackrampNSW";
case construction_type::TrackRampNEW: return "trackrampNEW";
case construction_type::TrackRampSEW: return "trackrampSEW";
case construction_type::TrackRampNSEW: return "trackrampNSEW";
case construction_type::NONE:
default:
return "~";
}
}
static const char * get_constructed_track_str(df::tiletype *tt,
const char * base) {
TileDirection dir = tileDirection(*tt);
if (!dir.whole)
return "~";
std::ostringstream str;
str << base;
if (dir.north) str << "N";
if (dir.south) str << "S";
if (dir.east) str << "E";
if (dir.west) str << "W";
return cache(str);
}
static const char * get_constructed_floor_str(df::tiletype *tt) {
if (tileSpecial(*tt) != df::tiletype_special::TRACK)
return "Cf";
return get_constructed_track_str(tt, "track");
}
static const char * get_constructed_ramp_str(df::tiletype *tt) {
if (tileSpecial(*tt) != df::tiletype_special::TRACK)
return "Cr";
return get_constructed_track_str(tt, "trackramp");
}
static const char * get_tile_construct(const df::coord &pos,
const tile_context &ctx) {
if (ctx.b && ctx.b->getType() == building_type::Construction)
return get_construction_str(ctx.b);
df::tiletype *tt = Maps::getTileType(pos);
if (!tt || tileMaterial(*tt) != df::tiletype_material::CONSTRUCTION)
return NULL;
switch (tileShape(*tt)) {
case tiletype_shape::WALL: return "Cw";
case tiletype_shape::FLOOR: return get_constructed_floor_str(tt);
case tiletype_shape::RAMP: return get_constructed_ramp_str(tt);
case tiletype_shape::FORTIFICATION: return "CF";
case tiletype_shape::STAIR_UP: return "Cu";
case tiletype_shape::STAIR_DOWN: return "Cd";
case tiletype_shape::STAIR_UPDOWN: return "Cx";
default:
return "~";
}
return NULL;
}
static pair<uint32_t, uint32_t> get_building_size(const df::building *b) {
return pair<uint32_t, uint32_t>(b->x2 - b->x1 + 1, b->y2 - b->y1 + 1);
}
static const char * if_pretty(const tile_context &ctx, const char *c) {
return ctx.pretty ? c : NULL;
}
static bool is_rectangular(const df::building *bld) {
const df::building_extents &room = bld->room;
if (!room.extents)
return true;
for (int32_t y = 0; y < room.height; ++y) {
for (int32_t x = 0; x < room.width; ++x) {
if (!room.extents[y * room.width + x])
return false;
}
}
return true;
}
static bool is_rectangular(const tile_context &ctx) {
return is_rectangular(ctx.b);
}
static const char * do_block_building(const tile_context &ctx, const char *s,
bool at_target_pos,
bool *add_size = NULL) {
if(!at_target_pos) {
return if_pretty(ctx, "`");
}
if (add_size)
*add_size = true;
return s;
}
static const char * do_extent_building(const tile_context &ctx, const char *s,
bool at_target_pos,
bool *add_size = NULL) {
// use expansion syntax for rectangular or one-tile buildings
if (is_rectangular(ctx))
return do_block_building(ctx, s, at_target_pos, add_size);
return s;
}
static const char * get_bridge_str(df::building *b) {
df::building_bridgest *bridge = virtual_cast<df::building_bridgest>(b);
if (!bridge)
return "g";
switch(bridge->direction) {
case df::building_bridgest::T_direction::Retracting: return "gs";
case df::building_bridgest::T_direction::Left: return "ga";
case df::building_bridgest::T_direction::Right: return "gd";
case df::building_bridgest::T_direction::Up: return "gw";
case df::building_bridgest::T_direction::Down: return "gx";
default:
return "g";
}
}
static const char * get_siege_str(df::building *b) {
df::building_siegeenginest *se =
virtual_cast<df::building_siegeenginest>(b);
return !se || se->type == df::siegeengine_type::Catapult ? "ic" : "ib";
}
static const char * get_workshop_str(df::building *b) {
df::building_workshopst *ws = virtual_cast<df::building_workshopst>(b);
if (!ws)
return "~";
switch (ws->type) {
case workshop_type::Leatherworks: return "we";
case workshop_type::Quern: return "wq";
case workshop_type::Millstone: return "wM";
case workshop_type::Loom: return "wo";
case workshop_type::Clothiers: return "wk";
case workshop_type::Bowyers: return "wb";
case workshop_type::Carpenters: return "wc";
case workshop_type::MetalsmithsForge: return "wf";
case workshop_type::MagmaForge: return "wv";
case workshop_type::Jewelers: return "wj";
case workshop_type::Masons: return "wm";
case workshop_type::Butchers: return "wu";
case workshop_type::Tanners: return "wn";
case workshop_type::Craftsdwarfs: return "wr";
case workshop_type::Siege: return "ws";
case workshop_type::Mechanics: return "wt";
case workshop_type::Still: return "wl";
case workshop_type::Farmers: return "ww";
case workshop_type::Kitchen: return "wz";
case workshop_type::Fishery: return "wh";
case workshop_type::Ashery: return "wy";
case workshop_type::Dyers: return "wd";
case workshop_type::Kennels: return "k";
case workshop_type::Custom:
{
int32_t custom = b->getCustomType();
if (custom == 0) return "wS";
if (custom == 1) return "wp";
}
// fallthrough
case workshop_type::Tool:
default:
return "~";
}
}
static const char * get_furnace_str(df::building *b) {
df::building_furnacest *furnace = virtual_cast<df::building_furnacest>(b);
if (!furnace)
return "~";
switch (furnace->type) {
case furnace_type::WoodFurnace: return "ew";
case furnace_type::Smelter: return "es";
case furnace_type::GlassFurnace: return "eg";
case furnace_type::Kiln: return "ek";
case furnace_type::MagmaSmelter: return "el";
case furnace_type::MagmaGlassFurnace: return "ea";
case furnace_type::MagmaKiln: return "en";
case furnace_type::Custom:
default:
return "~";
}
}
static const char * get_trap_str(df::building *b) {
df::building_trapst *trap = virtual_cast<df::building_trapst>(b);
if (!trap)
return "~";
switch (trap->trap_type) {
case trap_type::StoneFallTrap: return "Ts";
case trap_type::WeaponTrap: return "Tw";
case trap_type::Lever: return "Tl";
case trap_type::PressurePlate: return "Tp";
case trap_type::CageTrap: return "Tc";
case trap_type::TrackStop:
{
std::ostringstream buf;
buf << "CS";
if (trap->use_dump) {
if (trap->dump_x_shift == 0) {
buf << "d";
if (trap->dump_y_shift > 0)
buf << "d";
} else {
buf << "ddd";
if (trap->dump_x_shift < 0)
buf << "d";
}
}
// each case falls through and is additive
switch (trap->friction) {
case 10: buf << "a";
case 50: buf << "a";
case 500: buf << "a";
case 10000: buf << "a";
}
return cache(buf);
}
default:
return "~";
}
}
static const char * get_screw_pump_str(df::building *b) {
df::building_screw_pumpst *sp = virtual_cast<df::building_screw_pumpst>(b);
if (!sp)
return "~";
switch (sp->direction)
{
case screw_pump_direction::FromNorth: return "Msu";
case screw_pump_direction::FromEast: return "Msk";
case screw_pump_direction::FromSouth: return "Msm";
case screw_pump_direction::FromWest: return "Msh";
default:
return "~";
}
}
static const char * get_water_wheel_str(df::building *b) {
df::building_water_wheelst *ww =
virtual_cast<df::building_water_wheelst>(b);
if (!ww)
return "~";
return ww->is_vertical ? "Mw" : "Mws";
}
static const char * get_axle_str(df::building *b) {
df::building_axle_horizontalst *ah =
virtual_cast<df::building_axle_horizontalst>(b);
if (!ah)
return "~";
return ah->is_vertical ? "Mhs" : "Mh";
}
static const char * add_speed_suffix(df::building_rollersst *r,
const char *prefix) {
int32_t speed = r->speed;
if (speed >= 50000) return prefix;
string sprefix(prefix);
if (speed >= 40000) return cache(sprefix + "q");
if (speed >= 30000) return cache(sprefix + "qq");
if (speed >= 20000) return cache(sprefix + "qqq");
return cache(sprefix + "qqqq");
}
static const char * get_roller_str(df::building *b) {
df::building_rollersst *r = virtual_cast<df::building_rollersst>(b);
if (!r)
return "~";
switch (r->direction) {
case screw_pump_direction::FromNorth: return add_speed_suffix(r, "Mr");
case screw_pump_direction::FromEast: return add_speed_suffix(r, "Mrs");
case screw_pump_direction::FromSouth: return add_speed_suffix(r, "Mrss");
case screw_pump_direction::FromWest: return add_speed_suffix(r, "Mrsss");
default:
return "~";
}
}
static const char * get_build_keys(const df::coord &pos,
const tile_context &ctx,
bool &add_size) {
bool at_nw_corner = static_cast<int32_t>(pos.x) == ctx.b->x1
&& static_cast<int32_t>(pos.y) == ctx.b->y1;
bool at_se_corner = static_cast<int32_t>(pos.x) == ctx.b->x2
&& static_cast<int32_t>(pos.y) == ctx.b->y2;
bool at_center = static_cast<int32_t>(pos.x) == ctx.b->centerx
&& static_cast<int32_t>(pos.y) == ctx.b->centery;
// building_type::Construction is handled by the construction phase
switch(ctx.b->getType()) {
case building_type::Armorstand:
return "a";
case building_type::Bed:
return "b";
case building_type::Chair:
return "c";
case building_type::Door:
return "d";
case building_type::Floodgate:
return "x";
case building_type::Cabinet:
return "f";
case building_type::Box:
return "h";
case building_type::FarmPlot:
return do_extent_building(ctx, "p", at_nw_corner, &add_size);
case building_type::Weaponrack:
return "r";
case building_type::Statue:
return "s";
case building_type::Table:
return "t";
case building_type::Coffin:
return "n";
case building_type::RoadPaved:
return do_extent_building(ctx, "o", at_nw_corner, &add_size);
case building_type::RoadDirt:
return do_extent_building(ctx, "O", at_nw_corner, &add_size);
case building_type::Bridge:
return do_block_building(ctx, get_bridge_str(ctx.b), at_nw_corner,
&add_size);
case building_type::Well:
return "l";
case building_type::SiegeEngine:
return do_block_building(ctx, get_siege_str(ctx.b), at_center);
case building_type::Workshop:
return do_block_building(ctx, get_workshop_str(ctx.b), at_center);
case building_type::Furnace:
return do_block_building(ctx, get_furnace_str(ctx.b), at_center);
case building_type::WindowGlass:
return "y";
case building_type::WindowGem:
return "Y";
case building_type::Shop:
return do_block_building(ctx, "z", at_center);
case building_type::AnimalTrap:
return "m";
case building_type::Chain:
return "v";
case building_type::Cage:
return "j";
case building_type::TradeDepot:
return do_block_building(ctx, "D", at_center);
case building_type::Trap:
return get_trap_str(ctx.b);
case building_type::Weapon:
return "TS";
case building_type::ScrewPump:
return do_block_building(ctx, get_screw_pump_str(ctx.b), at_se_corner);
case building_type::WaterWheel:
return do_block_building(ctx, get_water_wheel_str(ctx.b), at_center);
case building_type::Windmill:
return do_block_building(ctx, "Mm", at_center);
case building_type::GearAssembly:
return "Mg";
case building_type::AxleHorizontal:
return do_block_building(ctx, get_axle_str(ctx.b), at_nw_corner,
&add_size);
case building_type::AxleVertical:
return "Mv";
case building_type::Rollers:
return do_block_building(ctx, get_roller_str(ctx.b), at_nw_corner,
&add_size);
case building_type::Support:
return "S";
case building_type::ArcheryTarget:
return "A";
case building_type::TractionBench:
return "R";
case building_type::Hatch:
return "H";
case building_type::Slab:
return "~s";
case building_type::NestBox:
return "N";
case building_type::Hive:
return "~h";
case building_type::GrateWall:
return "W";
case building_type::GrateFloor:
return "G";
case building_type::BarsVertical:
return "B";
case building_type::BarsFloor:
return "~b";
case building_type::Bookcase:
return "~c";
case building_type::DisplayFurniture:
return "F";
case building_type::OfferingPlace:
return "~a";
default:
return "~";
}
}
// returns "~" if keys is NULL; otherwise returns the keys with the building
// dimensions in the expansion syntax
static const char * add_expansion_syntax(const df::building *bld,
const char *keys) {
if (!keys)
return "~";
std::ostringstream s;
pair<uint32_t, uint32_t> size = get_building_size(bld);
s << keys << "(" << size.first << "x" << size.second << ")";
return cache(s);
}
static const char * add_expansion_syntax(const tile_context &ctx,
const char *keys) {
return add_expansion_syntax(ctx.b, keys);
}
static const char * get_tile_build(const df::coord &pos,
const tile_context &ctx) {
if (!ctx.b || ctx.b->getType() == building_type::Stockpile) {
return NULL;
}
bool add_size = false;
const char *keys = get_build_keys(pos, ctx, add_size);
if (!add_size)
return keys;
return add_expansion_syntax(ctx, keys);
}
/* TODO: understand how this changes for v50
static const char * get_place_keys(const tile_context &ctx) {
df::building_stockpilest* sp =
virtual_cast<df::building_stockpilest>(ctx.b);
if (!sp) {
return NULL;
}
string keys;
df::stockpile_group_set &flags = sp->settings.flags;
if (flags.bits.animals) keys += 'a';
if (flags.bits.food) keys += 'f';
if (flags.bits.furniture) keys += 'u';
if (flags.bits.coins) keys += 'n';
if (flags.bits.corpses) keys += 'y';
if (flags.bits.refuse) keys += 'r';
if (flags.bits.stone) keys += 's';
if (flags.bits.wood) keys += 'w';
if (flags.bits.gems) keys += 'e';
if (flags.bits.bars_blocks) keys += 'b';
if (flags.bits.cloth) keys += 'h';
if (flags.bits.leather) keys += 'l';
if (flags.bits.ammo) keys += 'z';
if (flags.bits.sheet) keys += 'S';
if (flags.bits.finished_goods) keys += 'g';
if (flags.bits.weapons) keys += 'p';
if (flags.bits.armor) keys += 'd';
if (keys.empty())
return "c";
return cache(keys);
}
static bool is_single_tile(const tile_context &ctx) {
return ctx.b->x1 == ctx.b->x2 && ctx.b->y1 == ctx.b->y2;
}
static const char * get_tile_place(const df::coord &pos,
const tile_context &ctx) {
if (!ctx.b || ctx.b->getType() != building_type::Stockpile)
return NULL;
if (!is_rectangular(ctx) || is_single_tile(ctx))
return get_place_keys(ctx);
if (ctx.b->x1 != static_cast<int32_t>(pos.x)
|| ctx.b->y1 != static_cast<int32_t>(pos.y)) {
return if_pretty(ctx, "`");
}
return add_expansion_syntax(ctx, get_place_keys(ctx));
}
static bool hospital_maximums_eq(const df::hospital_supplies &a,
const df::hospital_supplies &b) {
return a.max_thread == b.max_thread &&
a.max_cloth == b.max_cloth &&
a.max_splints == b.max_splints &&
a.max_crutches == b.max_crutches &&
a.max_plaster == b.max_plaster &&
a.max_buckets == b.max_buckets &&
a.max_soap == b.max_soap;
}
static const char * get_zone_keys(const df::building_civzonest *zone) {
static const uint32_t DEFAULT_GATHER_FLAGS =
df::building_civzonest::T_gather_flags::mask_pick_trees |
df::building_civzonest::T_gather_flags::mask_pick_shrubs |
df::building_civzonest::T_gather_flags::mask_gather_fallen;
static const df::hospital_supplies DEFAULT_HOSPITAL;
std::ostringstream keys;
const df::building_civzonest::T_zone_flags &flags = zone->zone_flags;
// inverted logic for Active since it's on by default
if (!flags.bits.active) keys << 'a';
// in UI order
if (flags.bits.water_source) keys << 'w';
if (flags.bits.fishing) keys << 'f';
if (flags.bits.gather) {
keys << 'g';
if (zone->gather_flags.whole != DEFAULT_GATHER_FLAGS) {
keys << 'G';
// logic is inverted since they're all on by default
if (!zone->gather_flags.bits.pick_trees) keys << 't';
if (!zone->gather_flags.bits.pick_shrubs) keys << 's';
if (!zone->gather_flags.bits.gather_fallen) keys << 'f';
keys << '^';
}
}
if (flags.bits.garbage_dump) keys << 'd';
if (flags.bits.pen_pasture) keys << 'n';
if (flags.bits.pit_pond) {
keys << 'p';
if (zone->pit_flags.bits.is_pond)
keys << "Pf^";
}
if (flags.bits.sand) keys << 's';
if (flags.bits.clay) keys << 'c';
if (flags.bits.meeting_area) keys << 'm';
if (flags.bits.hospital) {
keys << 'h';
const df::hospital_supplies &hospital = zone->hospital;
if (!hospital_maximums_eq(hospital, DEFAULT_HOSPITAL)) {
keys << "H{hospital";
if (hospital.max_thread != DEFAULT_HOSPITAL.max_thread)
keys << " thread=" << hospital.max_thread;
if (hospital.max_cloth != DEFAULT_HOSPITAL.max_cloth)
keys << " cloth=" << hospital.max_cloth;
if (hospital.max_splints != DEFAULT_HOSPITAL.max_splints)
keys << " splints=" << hospital.max_splints;
if (hospital.max_crutches != DEFAULT_HOSPITAL.max_crutches)
keys << " crutches=" << hospital.max_crutches;
if (hospital.max_plaster != DEFAULT_HOSPITAL.max_plaster)
keys << " plaster=" << hospital.max_plaster;
if (hospital.max_buckets != DEFAULT_HOSPITAL.max_buckets)
keys << " buckets=" << hospital.max_buckets;
if (hospital.max_soap != DEFAULT_HOSPITAL.max_soap)
keys << " soap=" << hospital.max_soap;
keys << "}^";
}
}
if (flags.bits.animal_training) keys << 't';
string keys_str = keys.str();
// there is no way to represent an active, but empty zone in quickfort
if (keys_str.empty())
return NULL;
// remove final '^' character if there is one
if (keys_str.back() == '^')
keys_str.pop_back();
return cache(keys_str);
}
static const char * get_tile_zone(const df::coord &pos,
const tile_context &ctx) {
vector<df::building_civzonest*> civzones;
if (!Buildings::findCivzonesAt(&civzones, pos))
return NULL;
// we only have one "zone" blueprint, so use the "topmost" zone (that is,
// the one that is highlighted when the cursor is over this tile).
// overlapping zones are outside the scope of this plugin, I think.
df::building_civzonest *zone = civzones.back();
You can’t perform that action at this time.