#include "uicommon.h" #include "modules/Gui.h" #include "df/world.h" #include "df/world_raws.h" #include "df/building_def.h" #include "df/viewscreen_dwarfmodest.h" #include "df/building_stockpilest.h" #include "modules/Items.h" #include "df/building_tradedepotst.h" #include "df/general_ref_building_holderst.h" #include "df/job.h" #include "df/job_item_ref.h" #include "modules/Job.h" #include "df/ui.h" #include "df/caravan_state.h" #include "modules/Maps.h" #include "modules/World.h" using df::global::world; using df::global::cursor; using df::global::ui; using df::building_stockpilest; DFHACK_PLUGIN("autotrade"); #define PLUGIN_VERSION 0.1 /* * Stockpile Access */ static building_stockpilest *get_selected_stockpile() { if (!Gui::dwarfmode_hotkey(Core::getTopViewscreen()) || ui->main.mode != ui_sidebar_mode::QueryBuilding) { return nullptr; } return virtual_cast(world->selected_building); } static bool can_trade() { if (df::global::ui->caravans.size() == 0) return false; for (auto it = df::global::ui->caravans.begin(); it != df::global::ui->caravans.end(); it++) { auto caravan = *it; auto trade_state = caravan->trade_state; auto time_remaining = caravan->time_remaining; if ((trade_state != 1 && trade_state != 2) || time_remaining == 0) return false; } return true; } class StockpileInfo { public: StockpileInfo(df::building_stockpilest *sp_) : sp(sp_) { readBuilding(); } StockpileInfo(PersistentDataItem &config) { this->config = config; id = config.ival(1); } bool inStockpile(df::item *i) { df::item *container = Items::getContainer(i); if (container) return inStockpile(container); if (i->pos.z != z) return false; if (i->pos.x < x1 || i->pos.x >= x2 || i->pos.y < y1 || i->pos.y >= y2) return false; int e = (i->pos.x - x1) + (i->pos.y - y1) * sp->room.width; return sp->room.extents[e] == 1; } bool isValid() { auto found = df::building::find(id); return found && found == sp && found->getType() == building_type::Stockpile; } bool load() { auto found = df::building::find(id); if (!found || found->getType() != building_type::Stockpile) return false; sp = virtual_cast(found); if (!sp) return false; readBuilding(); return true; } int32_t getId() { return id; } bool matches(df::building_stockpilest* sp) { return this->sp == sp; } void save() { config = DFHack::World::AddPersistentData("autotrade/stockpiles"); config.ival(1) = id; } void remove() { DFHack::World::DeletePersistentData(config); } private: PersistentDataItem config; df::building_stockpilest* sp; int x1, x2, y1, y2, z; int32_t id; void readBuilding() { id = sp->id; z = sp->z; x1 = sp->room.x; x2 = sp->room.x + sp->room.width; y1 = sp->room.y; y2 = sp->room.y + sp->room.height; } }; /* * Depot Access */ class TradeDepotInfo { public: TradeDepotInfo() : depot(0) { } bool findDepot() { if (isValid()) return true; reset(); for(auto bld_it = world->buildings.all.begin(); bld_it != world->buildings.all.end(); bld_it++) { auto bld = *bld_it; if (!isUsableDepot(bld)) continue; depot = bld; id = depot->id; break; } return depot; } bool assignItem(df::item *item) { auto href = df::allocate(); if (!href) return false; auto job = new df::job(); df::coord tpos(depot->centerx, depot->centery, depot->z); job->pos = tpos; job->job_type = job_type::BringItemToDepot; // job <-> item link if (!Job::attachJobItem(job, item, df::job_item_ref::Hauled)) { delete job; delete href; return false; } // job <-> building link href->building_id = id; depot->jobs.push_back(job); job->general_refs.push_back(href); // add to job list Job::linkIntoWorld(job); return true; } bool reset() { depot = 0; } private: int32_t id; df::building *depot; bool isUsableDepot(df::building* bld) { if (bld->getType() != building_type::TradeDepot) return false; if (bld->getBuildStage() < bld->getMaxBuildStage()) return false; if (bld->jobs.size() == 1 && bld->jobs[0]->job_type == job_type::DestroyBuilding) return false; return true; } bool isValid() { if (!depot) return false; auto found = df::building::find(id); return found && found == depot && isUsableDepot(found); } }; static TradeDepotInfo depot_info; /* * Item Manipulation */ static bool is_valid_item(df::item *item) { for (size_t i = 0; i < item->general_refs.size(); i++) { df::general_ref *ref = item->general_refs[i]; switch (ref->getType()) { case general_ref_type::CONTAINED_IN_ITEM: return false; case general_ref_type::UNIT_HOLDER: return false; case general_ref_type::BUILDING_HOLDER: return false; default: break; } } for (size_t i = 0; i < item->specific_refs.size(); i++) { df::specific_ref *ref = item->specific_refs[i]; if (ref->type == specific_ref_type::JOB) { // Ignore any items assigned to a job return false; } } return true; } static void mark_all_in_stockpiles(vector &stockpiles, bool announce) { if (!depot_info.findDepot()) { if (announce) Gui::showAnnouncement("Cannot trade, no valid depot available", COLOR_RED, true); return; } std::vector &items = world->items.other[items_other_id::IN_PLAY]; //FIXME filter out mandates // Precompute a bitmask with the bad flags df::item_flags bad_flags; bad_flags.whole = 0; #define F(x) bad_flags.bits.x = true; F(dump); F(forbid); F(garbage_collect); F(hostile); F(on_fire); F(rotten); F(trader); F(in_building); F(construction); F(artifact); F(spider_web); F(owned); F(in_job); #undef F size_t marked_count = 0; size_t error_count = 0; for (size_t i = 0; i < items.size(); i++) { df::item *item = items[i]; if (item->flags.whole & bad_flags.whole) continue; if (!is_valid_item(item)) continue; for (auto it = stockpiles.begin(); it != stockpiles.end(); it++) { if (!it->inStockpile(item)) continue; if (depot_info.assignItem(item)) { ++marked_count; } else { if (++error_count < 5) { Gui::showZoomAnnouncement(df::announcement_type::CANCEL_JOB, item->pos, "Cannot trade item from stockpile " + int_to_string(it->getId()), COLOR_RED, true); } } } } if (marked_count) Gui::showAnnouncement("Marked " + int_to_string(marked_count) + " items for trade", COLOR_GREEN, false); else if (announce) Gui::showAnnouncement("No more items to mark", COLOR_RED, true); if (error_count >= 5) { Gui::showAnnouncement(int_to_string(error_count) + " items were not marked", COLOR_RED, true); } } /* * Stockpile Monitoring */ class StockpileMonitor { public: bool isMonitored(df::building_stockpilest *sp) { for (auto it = monitored_stockpiles.begin(); it != monitored_stockpiles.end(); it++) { if (it->matches(sp)) return true; } return false; } void add(df::building_stockpilest *sp) { auto pile = StockpileInfo(sp); if (pile.isValid()) { monitored_stockpiles.push_back(StockpileInfo(sp)); monitored_stockpiles.back().save(); } } void remove(df::building_stockpilest *sp) { for (auto it = monitored_stockpiles.begin(); it != monitored_stockpiles.end(); it++) { if (it->matches(sp)) { it->remove(); monitored_stockpiles.erase(it); break; } } } void doCycle() { if (!can_trade()) return; for (auto it = monitored_stockpiles.begin(); it != monitored_stockpiles.end();) { if (!it->isValid()) { it = monitored_stockpiles.erase(it); continue; } ++it; } mark_all_in_stockpiles(monitored_stockpiles, false); } void reset() { monitored_stockpiles.clear(); std::vector items; DFHack::World::GetPersistentData(&items, "autotrade/stockpiles"); for (auto i = items.begin(); i != items.end(); i++) { auto pile = StockpileInfo(*i); if (pile.load()) monitored_stockpiles.push_back(StockpileInfo(pile)); else pile.remove(); } } private: vector monitored_stockpiles; }; static StockpileMonitor monitor; #define DELTA_TICKS 600 DFhackCExport command_result plugin_onupdate ( color_ostream &out ) { if(!Maps::IsValid()) return CR_OK; static decltype(world->frame_counter) last_frame_count = 0; if (DFHack::World::ReadPauseState()) return CR_OK; if (world->frame_counter - last_frame_count < DELTA_TICKS) return CR_OK; last_frame_count = world->frame_counter; monitor.doCycle(); return CR_OK; } /* * Interface */ struct trade_hook : public df::viewscreen_dwarfmodest { typedef df::viewscreen_dwarfmodest interpose_base; bool handleInput(set *input) { building_stockpilest *sp = get_selected_stockpile(); if (!sp) return false; if (input->count(interface_key::CUSTOM_M)) { if (!can_trade()) return false; vector wrapper; wrapper.push_back(StockpileInfo(sp)); mark_all_in_stockpiles(wrapper, true); return true; } else if (input->count(interface_key::CUSTOM_U)) { if (monitor.isMonitored(sp)) monitor.remove(sp); else monitor.add(sp); } return false; } DEFINE_VMETHOD_INTERPOSE(void, feed, (set *input)) { if (!handleInput(input)) INTERPOSE_NEXT(feed)(input); } DEFINE_VMETHOD_INTERPOSE(void, render, ()) { INTERPOSE_NEXT(render)(); building_stockpilest *sp = get_selected_stockpile(); if (!sp) return; auto dims = Gui::getDwarfmodeViewDims(); int left_margin = dims.menu_x1 + 1; int x = left_margin; int y = 23; if (can_trade()) OutputHotkeyString(x, y, "Mark all for trade", "m", true, left_margin); OutputToggleString(x, y, "Auto trade", "u", monitor.isMonitored(sp), true, left_margin); } }; IMPLEMENT_VMETHOD_INTERPOSE(trade_hook, feed); IMPLEMENT_VMETHOD_INTERPOSE(trade_hook, render); static command_result autotrade_cmd(color_ostream &out, vector & parameters) { if (!parameters.empty()) { if (parameters.size() == 1 && toLower(parameters[0])[0] == 'v') { out << "Building Plan" << endl << "Version: " << PLUGIN_VERSION << endl; } } return CR_OK; } DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) { switch (event) { case DFHack::SC_MAP_LOADED: depot_info.reset(); monitor.reset(); break; case DFHack::SC_MAP_UNLOADED: break; default: break; } return CR_OK; } DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { if (!gps || !INTERPOSE_HOOK(trade_hook, feed).apply() || !INTERPOSE_HOOK(trade_hook, render).apply()) out.printerr("Could not insert autotrade hooks!\n"); commands.push_back( PluginCommand( "autotrade", "Automatically send items in marked stockpiles to trade depot, when trading is possible.", autotrade_cmd, false, "")); return CR_OK; } DFhackCExport command_result plugin_shutdown ( color_ostream &out ) { return CR_OK; }