// Quick Dumper : Moves items marked as "dump" to cursor // FIXME: local item cache in map blocks needs to be fixed after teleporting items #include #include #include #include #include #include #include #include using namespace std; #include "Core.h" #include "Console.h" #include "Export.h" #include "PluginManager.h" #include "modules/Maps.h" #include "modules/Gui.h" #include "modules/Items.h" #include "modules/Materials.h" #include "modules/MapCache.h" #include "DataDefs.h" #include "df/item.h" #include "df/world.h" #include "df/general_ref.h" using namespace DFHack; using namespace df::enums; using MapExtras::Block; using MapExtras::MapCache; using df::global::world; DFHACK_PLUGIN("autodump"); command_result df_autodump(color_ostream &out, vector & parameters); command_result df_autodump_destroy_here(color_ostream &out, vector & parameters); command_result df_autodump_destroy_item(color_ostream &out, vector & parameters); DFhackCExport command_result plugin_init ( color_ostream &out, vector &commands) { commands.push_back(PluginCommand( "autodump", "Teleport items marked for dumping to the cursor.", df_autodump, false, " This utility lets you quickly move all items designated to be dumped.\n" " Items are instantly moved to the cursor position, the dump flag is unset,\n" " and the forbid flag is set, as if it had been dumped normally.\n" " Be aware that any active dump item tasks still point at the item.\n" "Options:\n" " destroy - instead of dumping, destroy the items instantly.\n" " destroy-here - only affect the tile under cursor.\n" " visible - only process items that are not hidden.\n" " hidden - only process hidden items.\n" " forbidden - only process forbidden items (default: only unforbidden).\n" )); commands.push_back(PluginCommand( "autodump-destroy-here", "Destroy items marked for dumping under cursor.", df_autodump_destroy_here, Gui::cursor_hotkey, " Identical to autodump destroy-here, but intended for use as keybinding.\n" )); commands.push_back(PluginCommand( "autodump-destroy-item", "Destroy the selected item.", df_autodump_destroy_item, Gui::any_item_hotkey, " Destroy the selected item. The item may be selected\n" " in the 'k' list, or inside a container. If called\n" " again before the game is resumed, cancels destroy.\n" )); return CR_OK; } DFhackCExport command_result plugin_shutdown ( color_ostream &out ) { return CR_OK; } typedef map coordmap; static command_result autodump_main(color_ostream &out, vector & parameters) { // Command line options bool destroy = false; bool here = false; bool need_visible = false; bool need_hidden = false; bool need_forbidden = false; for (size_t i = 0; i < parameters.size(); i++) { string & p = parameters[i]; if(p == "destroy") destroy = true; else if (p == "destroy-here") destroy = here = true; else if (p == "visible") need_visible = true; else if (p == "hidden") need_hidden = true; else if (p == "forbidden") need_forbidden = true; else return CR_WRONG_USAGE; } if (need_visible && need_hidden) { out.printerr("An item can't be both hidden and visible.\n"); return CR_WRONG_USAGE; } //DFHack::VersionInfo *mem = Core::getInstance().vinfo; if (!Maps::IsValid()) { out.printerr("Map is not available!\n"); return CR_FAILURE; } size_t numItems = world->items.all.size(); MapCache MC; int i = 0; int dumped_total = 0; int cx, cy, cz; DFCoord pos_cursor; if(!destroy || here) { if (!Gui::getCursorCoords(cx,cy,cz)) { out.printerr("Cursor position not found. Please enabled the cursor.\n"); return CR_FAILURE; } pos_cursor = DFCoord(cx,cy,cz); } if (!destroy) { { Block * b = MC.BlockAt(pos_cursor / 16); if(!b) { out.printerr("Cursor is in an invalid/uninitialized area. Place it over a floor.\n"); return CR_FAILURE; } df::tiletype ttype = MC.tiletypeAt(pos_cursor); if(!DFHack::isFloorTerrain(ttype)) { out.printerr("Cursor should be placed over a floor.\n"); return CR_FAILURE; } } } bool inventoryDumpingSkipped = false; // proceed with the dumpification operation for(size_t i=0; i< numItems; i++) { df::item * itm = world->items.all[i]; DFCoord pos_item(itm->pos.x, itm->pos.y, itm->pos.z); // only dump the stuff marked for dumping and laying on the ground if ( !itm->flags.bits.dump // || !itm->flags.bits.on_ground || itm->flags.bits.construction || itm->flags.bits.in_building || itm->flags.bits.in_chest // || itm->flags.bits.in_inventory || itm->flags.bits.artifact1 ) continue; if (need_visible && itm->flags.bits.hidden) continue; if (need_hidden && !itm->flags.bits.hidden) continue; if (need_forbidden && !itm->flags.bits.forbid) continue; if (!need_forbidden && itm->flags.bits.forbid) continue; if (itm->flags.bits.in_inventory && Gui::getSelectedUnit(out, true)) { // Due to GUI caching/redraw rules, Dwarf Fortress tends to crash if we make any changes to a unit's inventory // while the player is looking at the inventory menu. Therefore, we'll simply skip such items until they // change something (e.g. switch from "v" to "k" mode). inventoryDumpingSkipped = true; continue; } if(!destroy) // move to cursor { // Change flags to indicate the dump was completed, as if by super-dwarfs itm->flags.bits.dump = false; itm->flags.bits.forbid = true; // Don't move items if they're already at the cursor if (pos_cursor != pos_item) Items::moveToGround(MC, itm, pos_cursor); } else // destroy { if (here && pos_item != pos_cursor) continue; itm->flags.bits.garbage_collect = true; // Cosmetic changes: make them disappear from view instantly itm->flags.bits.forbid = true; itm->flags.bits.hidden = true; } dumped_total++; } // write map changes back to DF. if(!destroy) MC.WriteAll(); if (inventoryDumpingSkipped) { out.printerr("Some inventory items could not be autodumped because the unit/inventory screen is currently active. Please close the unit screen and repeat the operation.\n"); } out.print("Done. %d items %s.\n", dumped_total, destroy ? "marked for destruction" : "quickdumped"); return CR_OK; } command_result df_autodump(color_ostream &out, vector & parameters) { CoreSuspender suspend; return autodump_main(out, parameters); } command_result df_autodump_destroy_here(color_ostream &out, vector & parameters) { // HOTKEY COMMAND; CORE ALREADY SUSPENDED if (!parameters.empty()) return CR_WRONG_USAGE; vector args; args.push_back("destroy-here"); return autodump_main(out, args); } static map pending_destroy; static int last_frame = 0; command_result df_autodump_destroy_item(color_ostream &out, vector & parameters) { // HOTKEY COMMAND; CORE ALREADY SUSPENDED if (!parameters.empty()) return CR_WRONG_USAGE; df::item *item = Gui::getSelectedItem(out); if (!item) return CR_FAILURE; // Allow undoing the destroy if (world->frame_counter != last_frame) { last_frame = world->frame_counter; pending_destroy.clear(); } if (pending_destroy.count(item->id)) { df::item_flags old_flags = pending_destroy[item->id]; pending_destroy.erase(item->id); item->flags.bits.garbage_collect = false; item->flags.bits.hidden = old_flags.bits.hidden; item->flags.bits.dump = old_flags.bits.dump; item->flags.bits.forbid = old_flags.bits.forbid; return CR_OK; } // Check the item is good to destroy if (item->flags.bits.garbage_collect) { out.printerr("Item is already marked for destroy.\n"); return CR_FAILURE; } if (item->flags.bits.construction || item->flags.bits.in_building || item->flags.bits.artifact1) { out.printerr("Choosing not to destroy buildings, constructions and artifacts.\n"); return CR_FAILURE; } for (size_t i = 0; i < item->itemrefs.size(); i++) { df::general_ref *ref = item->itemrefs[i]; if (ref->getType() == general_ref_type::UNIT_HOLDER) { out.printerr("Choosing not to destroy items in unit inventory.\n"); return CR_FAILURE; } } // Set the flags pending_destroy[item->id] = item->flags; item->flags.bits.garbage_collect = true; item->flags.bits.hidden = true; item->flags.bits.dump = true; item->flags.bits.forbid = true; return CR_OK; }