Merge remote-tracking branch 'DFHack/develop' into Autoclothing
# Conflicts: # docs/changelog.txtdevelop
Rose
commit
840f728c66
Binary file not shown.
|
After Width: | Height: | Size: 639 B |
@ -1,58 +0,0 @@
|
||||
autohauler
|
||||
==========
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Automatically manage hauling labors.
|
||||
:tags: untested fort auto labors
|
||||
|
||||
Similar to `autolabor`, but instead of managing all labors, autohauler only
|
||||
addresses hauling labors, leaving the assignment of skilled labors entirely up
|
||||
to you. You can use the in-game `manipulator` UI or an external tool like Dwarf
|
||||
Therapist to do so.
|
||||
|
||||
Idle dwarves who are not on active military duty will be assigned the hauling
|
||||
labors; everyone else (including those currently hauling) will have the hauling
|
||||
labors removed. This is to encourage every dwarf to do their assigned skilled
|
||||
labors whenever possible, but resort to hauling when those jobs are not
|
||||
available. This also implies that the user will have a very tight skill
|
||||
assignment, with most skilled labors only being assigned to just a few dwarves
|
||||
and almost every non-military dwarf having at least one skilled labor assigned.
|
||||
|
||||
Autohauler allows a skill to be used as a flag to exempt a dwarf from
|
||||
autohauler's effects. By default, this is the unused ALCHEMIST labor, but it
|
||||
can be changed by the user.
|
||||
|
||||
Autohauler uses DFHack's `debug` functionality to display information about the changes it makes. The amount of
|
||||
information displayed can be controlled through appropriate use of the ``debugfilter`` command.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
``enable autohauler``
|
||||
Start managing hauling labors. This is normally all you need to do.
|
||||
Autohauler works well on default settings.
|
||||
``autohauler status``
|
||||
Show autohauler status and status of fort dwarves.
|
||||
``autohauler <labor> haulers``
|
||||
Set whether a particular labor should be assigned to haulers.
|
||||
``autohauler <labor> allow|forbid``
|
||||
Set whether a particular labor should mark a dwarf as exempt from hauling.
|
||||
By default, only the ``ALCHEMIST`` labor is set to ``forbid``.
|
||||
``autohauler reset-all|<labor> reset``
|
||||
Reset a particular labor (or all labors) to their default
|
||||
haulers/allow/forbid state.
|
||||
``autohauler list``
|
||||
Show the active configuration for all labors.
|
||||
``autohauler frameskip <number>``
|
||||
Set the number of frames between runs of autohauler.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
``autohauler HAUL_STONE haulers``
|
||||
Set stone hauling as a hauling labor (this is already the default).
|
||||
``autohauler RECOVER_WOUNDED allow``
|
||||
Allow the "Recover wounded" labor to be manually assigned by the player. By
|
||||
default it is automatically given to haulers.
|
||||
``autohauler MINE forbid``
|
||||
Don't assign hauling labors to dwarves with the Mining labor enabled.
|
||||
@ -0,0 +1,23 @@
|
||||
autoslab
|
||||
========
|
||||
|
||||
.. dfhack-tool::
|
||||
:summary: Automatically engrave slabs for ghostly citizens.
|
||||
:tags: fort auto workorders
|
||||
:no-command:
|
||||
|
||||
Automatically queue orders to engrave slabs of existing ghosts. Will only queue
|
||||
an order if there is no existing slab with that unit's memorial engraved and
|
||||
there is not already an existing work order to engrave a slab for that unit.
|
||||
Make sure you have spare slabs on hand for engraving! If you run
|
||||
`orders import library/rockstock <orders>`, you'll be sure to always have
|
||||
some slabs in stock.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
``enable autoslab``
|
||||
Enables the plugin and starts checking for ghosts that need memorializing.
|
||||
|
||||
``disable autoslab``
|
||||
Disables the plugin.
|
||||
@ -1 +1 @@
|
||||
Subproject commit a3b6cd5507753207ce28fe0872c98d6434d58a90
|
||||
Subproject commit e5332147871bbf3293931d3ea268ec30b1023297
|
||||
@ -1,727 +0,0 @@
|
||||
#include "Core.h"
|
||||
#include <Console.h>
|
||||
#include <Debug.h>
|
||||
#include <Export.h>
|
||||
#include <PluginManager.h>
|
||||
|
||||
#include <vector>
|
||||
#include <algorithm>
|
||||
|
||||
#include "modules/Units.h"
|
||||
#include "modules/World.h"
|
||||
|
||||
// DF data structure definition headers
|
||||
#include "DataDefs.h"
|
||||
#include <df/plotinfost.h>
|
||||
#include <df/world.h>
|
||||
#include <df/unit.h>
|
||||
#include <df/unit_soul.h>
|
||||
#include <df/unit_labor.h>
|
||||
#include <df/unit_skill.h>
|
||||
#include <df/job.h>
|
||||
#include <df/building.h>
|
||||
#include <df/workshop_type.h>
|
||||
#include <df/unit_misc_trait.h>
|
||||
#include <df/entity_position_responsibility.h>
|
||||
#include <df/historical_figure.h>
|
||||
#include <df/historical_entity.h>
|
||||
#include <df/histfig_entity_link.h>
|
||||
#include <df/histfig_entity_link_positionst.h>
|
||||
#include <df/entity_position_assignment.h>
|
||||
#include <df/entity_position.h>
|
||||
#include <df/building_tradedepotst.h>
|
||||
#include <df/building_stockpilest.h>
|
||||
#include <df/items_other_id.h>
|
||||
#include <df/plotinfost.h>
|
||||
#include <df/activity_info.h>
|
||||
|
||||
#include <MiscUtils.h>
|
||||
|
||||
#include "modules/MapCache.h"
|
||||
#include "modules/Items.h"
|
||||
#include "modules/Units.h"
|
||||
|
||||
#include "laborstatemap.h"
|
||||
|
||||
using namespace DFHack;
|
||||
using namespace df::enums;
|
||||
|
||||
DFHACK_PLUGIN("autohauler");
|
||||
REQUIRE_GLOBAL(plotinfo);
|
||||
REQUIRE_GLOBAL(world);
|
||||
|
||||
#define ARRAY_COUNT(array) (sizeof(array)/sizeof((array)[0]))
|
||||
|
||||
/*
|
||||
* Autohauler module for dfhack
|
||||
* Fork of autolabor, DFHack version 0.40.24-r2
|
||||
*
|
||||
* Rather than the all-of-the-above means of autolabor, autohauler will instead
|
||||
* only manage hauling labors and leave skilled labors entirely to the user, who
|
||||
* will probably use Dwarf Therapist to do so.
|
||||
* Idle dwarves will be assigned the hauling labors; everyone else (including
|
||||
* those currently hauling) will have the hauling labors removed. This is to
|
||||
* encourage every dwarf to do their assigned skilled labors whenever possible,
|
||||
* but resort to hauling when those jobs are not available. This also implies
|
||||
* that the user will have a very tight skill assignment, with most skilled
|
||||
* labors only being assigned to just one dwarf, no dwarf having more than two
|
||||
* active skilled labors, and almost every non-military dwarf having at least
|
||||
* one skilled labor assigned.
|
||||
* Autohauler allows skills to be flagged as to prevent hauling labors from
|
||||
* being assigned when the skill is present. By default this is the unused
|
||||
* ALCHEMIST labor but can be changed by the user.
|
||||
* It is noteworthy that, as stated in autolabor.cpp, "for almost all labors,
|
||||
* once a dwarf begins a job it will finish that job even if the associated
|
||||
* labor is removed." This is why we can remove hauling labors by default to try
|
||||
* to force dwarves to do "real" jobs whenever they can.
|
||||
* This is a standalone plugin. However, it would be wise to delete
|
||||
* autolabor.plug.dll as this plugin is mutually exclusive with it.
|
||||
*/
|
||||
|
||||
DFHACK_PLUGIN_IS_ENABLED(enable_autohauler);
|
||||
|
||||
namespace DFHack {
|
||||
DBG_DECLARE(autohauler, cycle, DebugCategory::LINFO);
|
||||
}
|
||||
|
||||
static std::vector<int> state_count(NUM_STATE);
|
||||
|
||||
const static int DEFAULT_FRAME_SKIP = 30;
|
||||
|
||||
static PersistentDataItem config;
|
||||
|
||||
command_result autohauler (color_ostream &out, std::vector <std::string> & parameters);
|
||||
|
||||
static int frame_skip;
|
||||
|
||||
static bool isOptionEnabled(unsigned flag)
|
||||
{
|
||||
return config.isValid() && (config.ival(0) & flag) != 0;
|
||||
}
|
||||
|
||||
enum ConfigFlags {
|
||||
CF_ENABLED = 1,
|
||||
};
|
||||
|
||||
static void setOptionEnabled(ConfigFlags flag, bool on)
|
||||
{
|
||||
if (!config.isValid())
|
||||
return;
|
||||
|
||||
if (on)
|
||||
config.ival(0) |= flag;
|
||||
else
|
||||
config.ival(0) &= ~flag;
|
||||
}
|
||||
|
||||
enum labor_mode {
|
||||
ALLOW,
|
||||
HAULERS,
|
||||
FORBID
|
||||
};
|
||||
|
||||
struct labor_info
|
||||
{
|
||||
PersistentDataItem config;
|
||||
|
||||
int active_dwarfs;
|
||||
|
||||
labor_mode mode() { return (labor_mode) config.ival(0); }
|
||||
|
||||
void set_mode(labor_mode mode) { config.ival(0) = mode; }
|
||||
|
||||
void set_config(PersistentDataItem a) { config = a; }
|
||||
|
||||
};
|
||||
|
||||
struct labor_default
|
||||
{
|
||||
labor_mode mode;
|
||||
int active_dwarfs;
|
||||
};
|
||||
|
||||
static std::vector<struct labor_info> labor_infos;
|
||||
|
||||
static const struct labor_default default_labor_infos[] = {
|
||||
/* MINE */ {ALLOW, 0},
|
||||
/* HAUL_STONE */ {HAULERS, 0},
|
||||
/* HAUL_WOOD */ {HAULERS, 0},
|
||||
/* HAUL_BODY */ {HAULERS, 0},
|
||||
/* HAUL_FOOD */ {HAULERS, 0},
|
||||
/* HAUL_REFUSE */ {HAULERS, 0},
|
||||
/* HAUL_ITEM */ {HAULERS, 0},
|
||||
/* HAUL_FURNITURE */ {HAULERS, 0},
|
||||
/* HAUL_ANIMAL */ {HAULERS, 0},
|
||||
/* CLEAN */ {HAULERS, 0},
|
||||
/* CUTWOOD */ {ALLOW, 0},
|
||||
/* CARPENTER */ {ALLOW, 0},
|
||||
/* DETAIL */ {ALLOW, 0},
|
||||
/* MASON */ {ALLOW, 0},
|
||||
/* ARCHITECT */ {ALLOW, 0},
|
||||
/* ANIMALTRAIN */ {ALLOW, 0},
|
||||
/* ANIMALCARE */ {ALLOW, 0},
|
||||
/* DIAGNOSE */ {ALLOW, 0},
|
||||
/* SURGERY */ {ALLOW, 0},
|
||||
/* BONE_SETTING */ {ALLOW, 0},
|
||||
/* SUTURING */ {ALLOW, 0},
|
||||
/* DRESSING_WOUNDS */ {ALLOW, 0},
|
||||
/* FEED_WATER_CIVILIANS */ {HAULERS, 0}, // This could also be ALLOW
|
||||
/* RECOVER_WOUNDED */ {HAULERS, 0},
|
||||
/* BUTCHER */ {ALLOW, 0},
|
||||
/* TRAPPER */ {ALLOW, 0},
|
||||
/* DISSECT_VERMIN */ {ALLOW, 0},
|
||||
/* LEATHER */ {ALLOW, 0},
|
||||
/* TANNER */ {ALLOW, 0},
|
||||
/* BREWER */ {ALLOW, 0},
|
||||
/* ALCHEMIST */ {FORBID, 0},
|
||||
/* SOAP_MAKER */ {ALLOW, 0},
|
||||
/* WEAVER */ {ALLOW, 0},
|
||||
/* CLOTHESMAKER */ {ALLOW, 0},
|
||||
/* MILLER */ {ALLOW, 0},
|
||||
/* PROCESS_PLANT */ {ALLOW, 0},
|
||||
/* MAKE_CHEESE */ {ALLOW, 0},
|
||||
/* MILK */ {ALLOW, 0},
|
||||
/* COOK */ {ALLOW, 0},
|
||||
/* PLANT */ {ALLOW, 0},
|
||||
/* HERBALIST */ {ALLOW, 0},
|
||||
/* FISH */ {ALLOW, 0},
|
||||
/* CLEAN_FISH */ {ALLOW, 0},
|
||||
/* DISSECT_FISH */ {ALLOW, 0},
|
||||
/* HUNT */ {ALLOW, 0},
|
||||
/* SMELT */ {ALLOW, 0},
|
||||
/* FORGE_WEAPON */ {ALLOW, 0},
|
||||
/* FORGE_ARMOR */ {ALLOW, 0},
|
||||
/* FORGE_FURNITURE */ {ALLOW, 0},
|
||||
/* METAL_CRAFT */ {ALLOW, 0},
|
||||
/* CUT_GEM */ {ALLOW, 0},
|
||||
/* ENCRUST_GEM */ {ALLOW, 0},
|
||||
/* WOOD_CRAFT */ {ALLOW, 0},
|
||||
/* STONE_CRAFT */ {ALLOW, 0},
|
||||
/* BONE_CARVE */ {ALLOW, 0},
|
||||
/* GLASSMAKER */ {ALLOW, 0},
|
||||
/* EXTRACT_STRAND */ {ALLOW, 0},
|
||||
/* SIEGECRAFT */ {ALLOW, 0},
|
||||
/* SIEGEOPERATE */ {ALLOW, 0},
|
||||
/* BOWYER */ {ALLOW, 0},
|
||||
/* MECHANIC */ {ALLOW, 0},
|
||||
/* POTASH_MAKING */ {ALLOW, 0},
|
||||
/* LYE_MAKING */ {ALLOW, 0},
|
||||
/* DYER */ {ALLOW, 0},
|
||||
/* BURN_WOOD */ {ALLOW, 0},
|
||||
/* OPERATE_PUMP */ {ALLOW, 0},
|
||||
/* SHEARER */ {ALLOW, 0},
|
||||
/* SPINNER */ {ALLOW, 0},
|
||||
/* POTTERY */ {ALLOW, 0},
|
||||
/* GLAZING */ {ALLOW, 0},
|
||||
/* PRESSING */ {ALLOW, 0},
|
||||
/* BEEKEEPING */ {ALLOW, 0},
|
||||
/* WAX_WORKING */ {ALLOW, 0},
|
||||
/* HANDLE_VEHICLES */ {HAULERS, 0},
|
||||
/* HAUL_TRADE */ {HAULERS, 0},
|
||||
/* PULL_LEVER */ {HAULERS, 0},
|
||||
/* REMOVE_CONSTRUCTION */ {HAULERS, 0},
|
||||
/* HAUL_WATER */ {HAULERS, 0},
|
||||
/* GELD */ {ALLOW, 0},
|
||||
/* BUILD_ROAD */ {HAULERS, 0},
|
||||
/* BUILD_CONSTRUCTION */ {HAULERS, 0},
|
||||
/* PAPERMAKING */ {ALLOW, 0},
|
||||
/* BOOKBINDING */ {ALLOW, 0}
|
||||
};
|
||||
|
||||
struct dwarf_info_t
|
||||
{
|
||||
dwarf_state state;
|
||||
|
||||
bool haul_exempt;
|
||||
};
|
||||
|
||||
static void cleanup_state()
|
||||
{
|
||||
enable_autohauler = false;
|
||||
labor_infos.clear();
|
||||
}
|
||||
|
||||
static void reset_labor(df::unit_labor labor)
|
||||
{
|
||||
labor_infos[labor].set_mode(default_labor_infos[labor].mode);
|
||||
}
|
||||
|
||||
static void enable_alchemist(color_ostream &out)
|
||||
{
|
||||
if (!Units::setLaborValidity(unit_labor::ALCHEMIST, true))
|
||||
{
|
||||
// informational only; this is a non-fatal error
|
||||
out.printerr("%s: Could not flag Alchemist as a valid skill; Alchemist will not"
|
||||
" be settable from DF or DFHack labor management screens.\n", plugin_name);
|
||||
}
|
||||
}
|
||||
|
||||
static void init_state(color_ostream &out)
|
||||
{
|
||||
config = World::GetPersistentData("autohauler/config");
|
||||
|
||||
if (config.isValid() && config.ival(0) == -1)
|
||||
config.ival(0) = 0;
|
||||
|
||||
enable_autohauler = isOptionEnabled(CF_ENABLED);
|
||||
|
||||
if (!enable_autohauler)
|
||||
return;
|
||||
|
||||
auto cfg_frameskip = World::GetPersistentData("autohauler/frameskip");
|
||||
if (cfg_frameskip.isValid())
|
||||
{
|
||||
frame_skip = cfg_frameskip.ival(0);
|
||||
}
|
||||
else
|
||||
{
|
||||
cfg_frameskip = World::AddPersistentData("autohauler/frameskip");
|
||||
cfg_frameskip.ival(0) = DEFAULT_FRAME_SKIP;
|
||||
frame_skip = cfg_frameskip.ival(0);
|
||||
}
|
||||
labor_infos.resize(ARRAY_COUNT(default_labor_infos));
|
||||
|
||||
std::vector<PersistentDataItem> items;
|
||||
World::GetPersistentData(&items, "autohauler/labors/", true);
|
||||
|
||||
|
||||
for (auto& p : items)
|
||||
{
|
||||
std::string key = p.key();
|
||||
df::unit_labor labor = (df::unit_labor) atoi(key.substr(strlen("autohauler/labors/")).c_str());
|
||||
if (labor >= 0 && size_t(labor) < labor_infos.size())
|
||||
{
|
||||
labor_infos[labor].set_config(p);
|
||||
labor_infos[labor].active_dwarfs = 0;
|
||||
}
|
||||
}
|
||||
|
||||
// Add default labors for those not in save
|
||||
for (size_t i = 0; i < ARRAY_COUNT(default_labor_infos); i++) {
|
||||
if (labor_infos[i].config.isValid())
|
||||
continue;
|
||||
|
||||
std::stringstream name;
|
||||
name << "autohauler/labors/" << i;
|
||||
|
||||
labor_infos[i].set_config(World::AddPersistentData(name.str()));
|
||||
|
||||
labor_infos[i].active_dwarfs = 0;
|
||||
reset_labor((df::unit_labor) i);
|
||||
}
|
||||
|
||||
enable_alchemist(out);
|
||||
}
|
||||
|
||||
static void enable_plugin(color_ostream &out)
|
||||
{
|
||||
if (!config.isValid())
|
||||
{
|
||||
config = World::AddPersistentData("autohauler/config");
|
||||
config.ival(0) = 0;
|
||||
}
|
||||
|
||||
setOptionEnabled(CF_ENABLED, true);
|
||||
enable_autohauler = true;
|
||||
out << "Enabling the plugin." << std::endl;
|
||||
|
||||
cleanup_state();
|
||||
init_state(out);
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
|
||||
{
|
||||
if(ARRAY_COUNT(default_labor_infos) != ENUM_LAST_ITEM(unit_labor) + 1)
|
||||
{
|
||||
out.printerr("autohauler: labor size mismatch\n");
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
commands.push_back(PluginCommand(
|
||||
"autohauler",
|
||||
"Automatically manage hauling labors.",
|
||||
autohauler));
|
||||
|
||||
init_state(out);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_shutdown ( color_ostream &out )
|
||||
{
|
||||
cleanup_state();
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event)
|
||||
{
|
||||
switch (event) {
|
||||
case SC_MAP_LOADED:
|
||||
cleanup_state();
|
||||
init_state(out);
|
||||
break;
|
||||
case SC_MAP_UNLOADED:
|
||||
cleanup_state();
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_onupdate ( color_ostream &out )
|
||||
{
|
||||
static int step_count = 0;
|
||||
if(!world || !world->map.block_index || !enable_autohauler)
|
||||
{
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
if (++step_count < frame_skip)
|
||||
return CR_OK;
|
||||
step_count = 0;
|
||||
|
||||
std::vector<df::unit *> dwarfs;
|
||||
|
||||
for (auto& cre : world->units.active)
|
||||
{
|
||||
if (Units::isCitizen(cre))
|
||||
{
|
||||
dwarfs.push_back(cre);
|
||||
}
|
||||
}
|
||||
|
||||
int n_dwarfs = dwarfs.size();
|
||||
|
||||
if (n_dwarfs == 0)
|
||||
return CR_OK;
|
||||
|
||||
std::vector<dwarf_info_t> dwarf_info(n_dwarfs);
|
||||
|
||||
state_count.clear();
|
||||
state_count.resize(NUM_STATE);
|
||||
|
||||
for (int dwarf = 0; dwarf < n_dwarfs; dwarf++)
|
||||
{
|
||||
/* Before determining how to handle employment status, handle
|
||||
* hauling exemptions first */
|
||||
|
||||
// Default deny condition of on break for later else-if series
|
||||
bool is_migrant = false;
|
||||
|
||||
// Scan every labor. If a labor that disallows hauling is present
|
||||
// for the dwarf, the dwarf is hauling exempt
|
||||
FOR_ENUM_ITEMS(unit_labor, labor)
|
||||
{
|
||||
if (!(labor == unit_labor::NONE))
|
||||
{
|
||||
bool test1 = labor_infos[labor].mode() == FORBID;
|
||||
bool test2 = dwarfs[dwarf]->status.labors[labor];
|
||||
|
||||
if(test1 && test2) dwarf_info[dwarf].haul_exempt = true;
|
||||
}
|
||||
}
|
||||
|
||||
// Scan a dwarf's miscellaneous traits for on break or migrant status.
|
||||
// If either of these are present, disable hauling because we want them
|
||||
// to try to find real jobs first
|
||||
auto v = dwarfs[dwarf]->status.misc_traits;
|
||||
auto test_migrant = [](df::unit_misc_trait* t) { return t->id == misc_trait_type::Migrant; };
|
||||
is_migrant = std::find_if(v.begin(), v.end(), test_migrant ) != v.end();
|
||||
|
||||
/* Now determine a dwarf's employment status and decide whether
|
||||
* to assign hauling */
|
||||
|
||||
// I don't think you can set the labors for babies and children, but let's
|
||||
// ignore them anyway
|
||||
if (Units::isBaby(dwarfs[dwarf]) || Units::isChild(dwarfs[dwarf]))
|
||||
{
|
||||
dwarf_info[dwarf].state = CHILD;
|
||||
}
|
||||
// Account for any hauling exemptions here
|
||||
else if (dwarf_info[dwarf].haul_exempt)
|
||||
{
|
||||
dwarf_info[dwarf].state = BUSY;
|
||||
}
|
||||
// Account for the military
|
||||
else if (ENUM_ATTR(profession, military, dwarfs[dwarf]->profession))
|
||||
dwarf_info[dwarf].state = MILITARY;
|
||||
// Account for incoming migrants
|
||||
else if (is_migrant)
|
||||
{
|
||||
dwarf_info[dwarf].state = OTHER;
|
||||
}
|
||||
else if (dwarfs[dwarf]->job.current_job == NULL)
|
||||
{
|
||||
dwarf_info[dwarf].state = IDLE;
|
||||
}
|
||||
else
|
||||
{
|
||||
int job = dwarfs[dwarf]->job.current_job->job_type;
|
||||
if (job >= 0 && size_t(job) < ARRAY_COUNT(dwarf_states))
|
||||
dwarf_info[dwarf].state = dwarf_states[job];
|
||||
else
|
||||
{
|
||||
WARN(cycle, out).print("Dwarf %i \"%s\" has unknown job %i\n", dwarf, dwarfs[dwarf]->name.first_name.c_str(), job);
|
||||
dwarf_info[dwarf].state = OTHER;
|
||||
}
|
||||
}
|
||||
|
||||
state_count[dwarf_info[dwarf].state]++;
|
||||
|
||||
TRACE(cycle, out).print("Dwarf %i \"%s\": state %s\n",
|
||||
dwarf, dwarfs[dwarf]->name.first_name.c_str(), state_names[dwarf_info[dwarf].state]);
|
||||
}
|
||||
|
||||
// This is a vector of all the labors
|
||||
std::vector<df::unit_labor> labors;
|
||||
|
||||
// For every labor...
|
||||
FOR_ENUM_ITEMS(unit_labor, labor)
|
||||
{
|
||||
// Ignore all nonexistent labors
|
||||
if (labor == unit_labor::NONE)
|
||||
continue;
|
||||
|
||||
// Set number of active dwarves for this job to zero
|
||||
labor_infos[labor].active_dwarfs = 0;
|
||||
|
||||
// And add the labor to the aforementioned vector of labors
|
||||
labors.push_back(labor);
|
||||
}
|
||||
|
||||
// This is a different algorithm than Autolabor. Instead, the intent is to
|
||||
// have "real" jobs filled first, then if nothing is available the dwarf
|
||||
// instead resorts to hauling.
|
||||
|
||||
// IDLE - Enable hauling
|
||||
// BUSY - Disable hauling
|
||||
// OTHER - Enable hauling
|
||||
// MILITARY - Enable hauling
|
||||
|
||||
// There was no reason to put potential haulers in an array. All of them are
|
||||
// covered in the following for loop.
|
||||
|
||||
FOR_ENUM_ITEMS(unit_labor, labor)
|
||||
{
|
||||
if (labor == unit_labor::NONE)
|
||||
continue;
|
||||
if (labor_infos[labor].mode() != HAULERS)
|
||||
continue;
|
||||
|
||||
for(size_t dwarf = 0; dwarf < dwarfs.size(); dwarf++)
|
||||
{
|
||||
if (!Units::isValidLabor(dwarfs[dwarf], labor))
|
||||
continue;
|
||||
|
||||
// Set hauling labors based on employment states
|
||||
if(dwarf_info[dwarf].state == IDLE) {
|
||||
dwarfs[dwarf]->status.labors[labor] = true;
|
||||
}
|
||||
else if(dwarf_info[dwarf].state == MILITARY) {
|
||||
dwarfs[dwarf]->status.labors[labor] = true;
|
||||
}
|
||||
else if(dwarf_info[dwarf].state == OTHER) {
|
||||
dwarfs[dwarf]->status.labors[labor] = true;
|
||||
}
|
||||
else if(dwarf_info[dwarf].state == BUSY) {
|
||||
dwarfs[dwarf]->status.labors[labor] = false;
|
||||
}
|
||||
// If at the end of this the dwarf has the hauling labor, increment the
|
||||
// counter
|
||||
if(dwarfs[dwarf]->status.labors[labor])
|
||||
{
|
||||
labor_infos[labor].active_dwarfs++;
|
||||
}
|
||||
// CHILD ignored
|
||||
}
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
void print_labor (df::unit_labor labor, color_ostream &out)
|
||||
{
|
||||
std::string labor_name = ENUM_KEY_STR(unit_labor, labor);
|
||||
out << labor_name << ": ";
|
||||
for (int i = 0; i < 20 - (int)labor_name.length(); i++)
|
||||
out << ' ';
|
||||
if (labor_infos[labor].mode() == ALLOW) out << "allow" << std::endl;
|
||||
else if(labor_infos[labor].mode() == FORBID) out << "forbid" << std::endl;
|
||||
else if(labor_infos[labor].mode() == HAULERS)
|
||||
{
|
||||
out << "haulers, currently " << labor_infos[labor].active_dwarfs << " dwarfs" << std::endl;
|
||||
}
|
||||
else
|
||||
{
|
||||
out << "Warning: Invalid labor mode!" << std::endl;
|
||||
}
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_enable ( color_ostream &out, bool enable )
|
||||
{
|
||||
if (!Core::getInstance().isWorldLoaded()) {
|
||||
out.printerr("World is not loaded: please load a game first.\n");
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
if (enable && !enable_autohauler)
|
||||
{
|
||||
enable_plugin(out);
|
||||
}
|
||||
else if(!enable && enable_autohauler)
|
||||
{
|
||||
enable_autohauler = false;
|
||||
setOptionEnabled(CF_ENABLED, false);
|
||||
|
||||
out << "Autohauler is disabled." << std::endl;
|
||||
}
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
command_result autohauler (color_ostream &out, std::vector <std::string> & parameters)
|
||||
{
|
||||
CoreSuspender suspend;
|
||||
|
||||
if (!Core::getInstance().isWorldLoaded()) {
|
||||
out.printerr("World is not loaded: please load a game first.\n");
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
if (parameters.size() == 1 &&
|
||||
(parameters[0] == "0" || parameters[0] == "enable" ||
|
||||
parameters[0] == "1" || parameters[0] == "disable"))
|
||||
{
|
||||
bool enable = (parameters[0] == "1" || parameters[0] == "enable");
|
||||
|
||||
return plugin_enable(out, enable);
|
||||
}
|
||||
else if (parameters.size() == 2 && parameters[0] == "frameskip")
|
||||
{
|
||||
auto cfg_frameskip = World::GetPersistentData("autohauler/frameskip");
|
||||
if(cfg_frameskip.isValid())
|
||||
{
|
||||
int newValue = atoi(parameters[1].c_str());
|
||||
cfg_frameskip.ival(0) = newValue;
|
||||
out << "Setting frame skip to " << newValue << std::endl;
|
||||
frame_skip = cfg_frameskip.ival(0);
|
||||
return CR_OK;
|
||||
}
|
||||
else
|
||||
{
|
||||
out << "Warning! No persistent data for frame skip!" << std::endl;
|
||||
return CR_OK;
|
||||
}
|
||||
}
|
||||
else if (parameters.size() >= 2 && parameters.size() <= 4)
|
||||
{
|
||||
if (!enable_autohauler)
|
||||
{
|
||||
out << "Error: The plugin is not enabled." << std::endl;
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
df::unit_labor labor = unit_labor::NONE;
|
||||
|
||||
FOR_ENUM_ITEMS(unit_labor, test_labor)
|
||||
{
|
||||
if (parameters[0] == ENUM_KEY_STR(unit_labor, test_labor))
|
||||
labor = test_labor;
|
||||
}
|
||||
|
||||
if (labor == unit_labor::NONE)
|
||||
{
|
||||
out.printerr("Could not find labor %s.\n", parameters[0].c_str());
|
||||
return CR_WRONG_USAGE;
|
||||
}
|
||||
|
||||
if (parameters[1] == "haulers")
|
||||
{
|
||||
labor_infos[labor].set_mode(HAULERS);
|
||||
print_labor(labor, out);
|
||||
return CR_OK;
|
||||
}
|
||||
if (parameters[1] == "allow")
|
||||
{
|
||||
labor_infos[labor].set_mode(ALLOW);
|
||||
print_labor(labor, out);
|
||||
return CR_OK;
|
||||
}
|
||||
if (parameters[1] == "forbid")
|
||||
{
|
||||
labor_infos[labor].set_mode(FORBID);
|
||||
print_labor(labor, out);
|
||||
return CR_OK;
|
||||
}
|
||||
if (parameters[1] == "reset")
|
||||
{
|
||||
reset_labor(labor);
|
||||
print_labor(labor, out);
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
print_labor(labor, out);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
else if (parameters.size() == 1 && parameters[0] == "reset-all")
|
||||
{
|
||||
if (!enable_autohauler)
|
||||
{
|
||||
out << "Error: The plugin is not enabled." << std::endl;
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
for (size_t i = 0; i < labor_infos.size(); i++)
|
||||
{
|
||||
reset_labor((df::unit_labor) i);
|
||||
}
|
||||
out << "All labors reset." << std::endl;
|
||||
return CR_OK;
|
||||
}
|
||||
else if (parameters.size() == 1 && (parameters[0] == "list" || parameters[0] == "status"))
|
||||
{
|
||||
if (!enable_autohauler)
|
||||
{
|
||||
out << "Error: The plugin is not enabled." << std::endl;
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
bool need_comma = false;
|
||||
for (int i = 0; i < NUM_STATE; i++)
|
||||
{
|
||||
if (state_count[i] == 0)
|
||||
continue;
|
||||
if (need_comma)
|
||||
out << ", ";
|
||||
out << state_count[i] << ' ' << state_names[i];
|
||||
need_comma = true;
|
||||
}
|
||||
out << std::endl;
|
||||
|
||||
out << "Autohauler is running every " << frame_skip << " frames." << std::endl;
|
||||
|
||||
if (parameters[0] == "list")
|
||||
{
|
||||
FOR_ENUM_ITEMS(unit_labor, labor)
|
||||
{
|
||||
if (labor == unit_labor::NONE)
|
||||
continue;
|
||||
|
||||
print_labor(labor, out);
|
||||
}
|
||||
}
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
else
|
||||
{
|
||||
out.print("Automatically assigns hauling labors to dwarves.\n"
|
||||
"Activate with 'enable autohauler', deactivate with 'disable autohauler'.\n"
|
||||
"Current state: %d.\n", enable_autohauler);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,243 @@
|
||||
/* Simple plugin to check for ghosts and automatically queue jobs to engrave slabs for them.
|
||||
*
|
||||
* Enhancement idea: Queue up a ConstructSlab job, then link the engrave slab job to it. Avoids need to have slabs in stockpiles
|
||||
* Would require argument parsing, specifying materials
|
||||
* Enhancement idea: Automatically place the slab. This seems like a tricky problem but maybe solveable with named zones?
|
||||
* Might be made obsolete by people just using buildingplan to pre-place plans for slab?
|
||||
* Enhancement idea: Optionally enable autoengraving for pets.
|
||||
* Enhancement idea: Try to get ahead of ghosts by autoengraving for dead dwarves with no remains, or dwarves
|
||||
* whose remains are unreachable.
|
||||
*/
|
||||
|
||||
#include "Core.h"
|
||||
#include "Debug.h"
|
||||
#include "PluginManager.h"
|
||||
|
||||
#include "modules/Persistence.h"
|
||||
#include "modules/Translation.h"
|
||||
#include "modules/World.h"
|
||||
|
||||
#include "df/historical_figure.h"
|
||||
#include "df/item.h"
|
||||
#include "df/manager_order.h"
|
||||
#include "df/plotinfost.h"
|
||||
#include "df/unit.h"
|
||||
#include "df/world.h"
|
||||
|
||||
using namespace DFHack;
|
||||
|
||||
DFHACK_PLUGIN("autoslab");
|
||||
DFHACK_PLUGIN_IS_ENABLED(is_enabled);
|
||||
|
||||
REQUIRE_GLOBAL(world);
|
||||
|
||||
// logging levels can be dynamically controlled with the `debugfilter` command.
|
||||
namespace DFHack
|
||||
{
|
||||
// for configuration-related logging
|
||||
DBG_DECLARE(autoslab, status, DebugCategory::LINFO);
|
||||
// for logging during the periodic scan
|
||||
DBG_DECLARE(autoslab, cycle, DebugCategory::LINFO);
|
||||
}
|
||||
|
||||
static const auto CONFIG_KEY = std::string(plugin_name) + "/config";
|
||||
static PersistentDataItem config;
|
||||
enum ConfigValues
|
||||
{
|
||||
CONFIG_IS_ENABLED = 0,
|
||||
};
|
||||
static int get_config_val(int index)
|
||||
{
|
||||
if (!config.isValid())
|
||||
return -1;
|
||||
return config.ival(index);
|
||||
}
|
||||
static bool get_config_bool(int index)
|
||||
{
|
||||
return get_config_val(index) == 1;
|
||||
}
|
||||
static void set_config_val(int index, int value)
|
||||
{
|
||||
if (config.isValid())
|
||||
config.ival(index) = value;
|
||||
}
|
||||
static void set_config_bool(int index, bool value)
|
||||
{
|
||||
set_config_val(index, value ? 1 : 0);
|
||||
}
|
||||
|
||||
static int32_t cycle_timestamp = 0; // world->frame_counter at last cycle
|
||||
|
||||
static void do_cycle(color_ostream &out);
|
||||
|
||||
DFhackCExport command_result plugin_init(color_ostream &out, std::vector<PluginCommand> &commands)
|
||||
{
|
||||
DEBUG(status, out).print("initializing %s\n", plugin_name);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_enable(color_ostream &out, bool enable)
|
||||
{
|
||||
if (!Core::getInstance().isWorldLoaded())
|
||||
{
|
||||
out.printerr("Cannot enable %s without a loaded world.\n", plugin_name);
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
if (enable != is_enabled)
|
||||
{
|
||||
is_enabled = enable;
|
||||
DEBUG(status, out).print("%s from the API; persisting\n", is_enabled ? "enabled" : "disabled");
|
||||
set_config_bool(CONFIG_IS_ENABLED, is_enabled);
|
||||
}
|
||||
else
|
||||
{
|
||||
DEBUG(status, out).print("%s from the API, but already %s; no action\n", is_enabled ? "enabled" : "disabled", is_enabled ? "enabled" : "disabled");
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_shutdown(color_ostream &out)
|
||||
{
|
||||
DEBUG(status, out).print("shutting down %s\n", plugin_name);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_load_data(color_ostream &out)
|
||||
{
|
||||
config = World::GetPersistentData(CONFIG_KEY);
|
||||
|
||||
if (!config.isValid())
|
||||
{
|
||||
DEBUG(status, out).print("no config found in this save; initializing\n");
|
||||
config = World::AddPersistentData(CONFIG_KEY);
|
||||
set_config_bool(CONFIG_IS_ENABLED, is_enabled);
|
||||
}
|
||||
|
||||
// we have to copy our enabled flag into the global plugin variable, but
|
||||
// all the other state we can directly read/modify from the persistent
|
||||
// data structure.
|
||||
is_enabled = get_config_bool(CONFIG_IS_ENABLED);
|
||||
DEBUG(status, out).print("loading persisted enabled state: %s\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(status, out).print("world unloaded; disabling %s\n", plugin_name);
|
||||
is_enabled = false;
|
||||
}
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
static const int32_t CYCLE_TICKS = 1200;
|
||||
|
||||
DFhackCExport command_result plugin_onupdate(color_ostream &out)
|
||||
{
|
||||
CoreSuspender suspend;
|
||||
if (is_enabled && world->frame_counter - cycle_timestamp >= CYCLE_TICKS)
|
||||
do_cycle(out);
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
// Name functions taken from manipulator.cpp
|
||||
static std::string get_first_name(df::unit *unit)
|
||||
{
|
||||
return Translation::capitalize(unit->name.first_name);
|
||||
}
|
||||
|
||||
static std::string get_last_name(df::unit *unit)
|
||||
{
|
||||
df::language_name name = unit->name;
|
||||
std::string ret = "";
|
||||
for (int i = 0; i < 2; i++)
|
||||
{
|
||||
if (name.words[i] >= 0)
|
||||
ret += *world->raws.language.translations[name.language]->words[name.words[i]];
|
||||
}
|
||||
return Translation::capitalize(ret);
|
||||
}
|
||||
|
||||
// Couldn't figure out any other way to do this besides look for the dwarf name in
|
||||
// the slab item description.
|
||||
// Ideally, we could get the historical figure id from the slab but I didn't
|
||||
// see anything like that in the item struct. This seems to work based on testing.
|
||||
// Confirmed nicknames don't show up in engraved slab names, so this should probably work okay
|
||||
bool engravedSlabItemExists(df::unit *unit, std::vector<df::item *> slabs)
|
||||
{
|
||||
for (auto slab : slabs)
|
||||
{
|
||||
std::string desc = "";
|
||||
slab->getItemDescription(&desc, 0);
|
||||
auto fullName = get_first_name(unit) + " " + get_last_name(unit);
|
||||
if (desc.find(fullName) != std::string::npos)
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
// Queue up a single order to engrave the slab for the given unit
|
||||
static void createSlabJob(df::unit *unit)
|
||||
{
|
||||
auto next_id = world->manager_order_next_id++;
|
||||
auto order = new df::manager_order();
|
||||
|
||||
order->id = next_id;
|
||||
order->job_type = df::job_type::EngraveSlab;
|
||||
order->hist_figure_id = unit->hist_figure_id;
|
||||
order->amount_left = 1;
|
||||
order->amount_total = 1;
|
||||
world->manager_orders.push_back(order);
|
||||
}
|
||||
|
||||
static void checkslabs(color_ostream &out)
|
||||
{
|
||||
// Get existing orders for slab engraving as map hist_figure_id -> order ID
|
||||
std::map<int32_t, int32_t> histToJob;
|
||||
for (auto order : world->manager_orders)
|
||||
{
|
||||
if (order->job_type == df::job_type::EngraveSlab)
|
||||
histToJob[order->hist_figure_id] = order->id;
|
||||
}
|
||||
|
||||
// Get list of engraved slab items on map
|
||||
std::vector<df::item *> engravedSlabs;
|
||||
std::copy_if(world->items.all.begin(), world->items.all.end(),
|
||||
std::back_inserter(engravedSlabs),
|
||||
[](df::item *item)
|
||||
{ return item->getType() == df::item_type::SLAB && item->getSlabEngravingType() == df::slab_engraving_type::Memorial; });
|
||||
|
||||
// Build list of ghosts
|
||||
std::vector<df::unit *> ghosts;
|
||||
std::copy_if(world->units.all.begin(), world->units.all.end(),
|
||||
std::back_inserter(ghosts),
|
||||
[](const df::unit *unit)
|
||||
{ return unit->flags3.bits.ghostly; });
|
||||
|
||||
for (auto ghost : ghosts)
|
||||
{
|
||||
// Only create a job is the map has no existing jobs for that historical figure or no existing engraved slabs
|
||||
if (histToJob.count(ghost->hist_figure_id) == 0 && !engravedSlabItemExists(ghost, engravedSlabs))
|
||||
{
|
||||
createSlabJob(ghost);
|
||||
auto fullName = get_first_name(ghost) + " " + get_last_name(ghost);
|
||||
out.print("Added slab order for ghost %s\n", fullName.c_str());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void do_cycle(color_ostream &out)
|
||||
{
|
||||
// mark that we have recently run
|
||||
cycle_timestamp = world->frame_counter;
|
||||
|
||||
checkslabs(out);
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
local _ENV = mkmodule('plugins.seedwatch')
|
||||
|
||||
local argparse = require('argparse')
|
||||
|
||||
local function process_args(opts, args)
|
||||
if args[1] == 'help' then
|
||||
opts.help = true
|
||||
return
|
||||
end
|
||||
|
||||
return argparse.processArgsGetopt(args, {
|
||||
{'h', 'help', handler=function() opts.help = true end},
|
||||
})
|
||||
end
|
||||
|
||||
local function print_status()
|
||||
print(('seedwatch is %s'):format(isEnabled() and "enabled" or "disabled"))
|
||||
print()
|
||||
print('usable seed counts and current targets:')
|
||||
local watch_map, seed_counts = seedwatch_getData()
|
||||
local sum = 0
|
||||
local plants = df.global.world.raws.plants.all
|
||||
for k,v in pairs(seed_counts) do
|
||||
print((' %4d/%d %s'):format(v, watch_map[k] or 0, plants[k].id))
|
||||
sum = sum + v
|
||||
end
|
||||
print()
|
||||
print(('total usable seeds: %d'):format(sum))
|
||||
end
|
||||
|
||||
local function set_target(name, num)
|
||||
if not name or #name == 0 then
|
||||
qerror('must specify "all" or plant name')
|
||||
end
|
||||
|
||||
num = tonumber(num)
|
||||
num = num and math.floor(num) or nil
|
||||
if not num or num < 0 then
|
||||
qerror('target must be a non-negative integer')
|
||||
end
|
||||
|
||||
seedwatch_setTarget(name, num)
|
||||
end
|
||||
|
||||
function parse_commandline(...)
|
||||
local args, opts = {...}, {}
|
||||
local positionals = process_args(opts, args)
|
||||
|
||||
if opts.help then
|
||||
return false
|
||||
end
|
||||
|
||||
local command = positionals[1]
|
||||
if not command or command == 'status' then
|
||||
print_status()
|
||||
elseif command == 'clear' then
|
||||
set_target('all', 0)
|
||||
elseif positionals[2] and positionals[3] then
|
||||
set_target(positionals[2], positionals[3])
|
||||
else
|
||||
return false
|
||||
end
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
return _ENV
|
||||
@ -1,120 +1,145 @@
|
||||
#include "Core.h"
|
||||
#include "Console.h"
|
||||
#include "Export.h"
|
||||
#include "Debug.h"
|
||||
#include "PluginManager.h"
|
||||
|
||||
#include "DataDefs.h"
|
||||
#include "modules/Persistence.h"
|
||||
#include "modules/World.h"
|
||||
|
||||
#include "df/world.h"
|
||||
#include "df/plotinfost.h"
|
||||
#include "df/building_nest_boxst.h"
|
||||
#include "df/building_type.h"
|
||||
#include "df/buildings_other_id.h"
|
||||
#include "df/global_objects.h"
|
||||
#include "df/item.h"
|
||||
#include "df/unit.h"
|
||||
#include "df/building.h"
|
||||
#include "df/items_other_id.h"
|
||||
#include "df/creature_raw.h"
|
||||
#include "modules/MapCache.h"
|
||||
#include "modules/Items.h"
|
||||
|
||||
|
||||
using std::vector;
|
||||
using std::string;
|
||||
using std::endl;
|
||||
using namespace DFHack;
|
||||
using namespace df::enums;
|
||||
|
||||
using df::global::world;
|
||||
using df::global::plotinfo;
|
||||
DFHACK_PLUGIN("nestboxes");
|
||||
DFHACK_PLUGIN_IS_ENABLED(is_enabled);
|
||||
|
||||
static command_result nestboxes(color_ostream &out, vector <string> & parameters);
|
||||
REQUIRE_GLOBAL(world);
|
||||
|
||||
DFHACK_PLUGIN("nestboxes");
|
||||
namespace DFHack {
|
||||
// for configuration-related logging
|
||||
DBG_DECLARE(nestboxes, config, DebugCategory::LINFO);
|
||||
// for logging during the periodic scan
|
||||
DBG_DECLARE(nestboxes, cycle, DebugCategory::LINFO);
|
||||
}
|
||||
|
||||
DFHACK_PLUGIN_IS_ENABLED(enabled);
|
||||
static const string CONFIG_KEY = string(plugin_name) + "/config";
|
||||
static PersistentDataItem config;
|
||||
|
||||
static void eggscan(color_ostream &out)
|
||||
{
|
||||
CoreSuspender suspend;
|
||||
enum ConfigValues {
|
||||
CONFIG_IS_ENABLED = 0,
|
||||
};
|
||||
|
||||
for (df::building *build : world->buildings.other[df::buildings_other_id::NEST_BOX])
|
||||
{
|
||||
auto type = build->getType();
|
||||
if (df::enums::building_type::NestBox == type)
|
||||
{
|
||||
bool fertile = false;
|
||||
df::building_nest_boxst *nb = virtual_cast<df::building_nest_boxst>(build);
|
||||
if (nb->claimed_by != -1)
|
||||
{
|
||||
df::unit* u = df::unit::find(nb->claimed_by);
|
||||
if (u && u->pregnancy_timer > 0)
|
||||
fertile = true;
|
||||
}
|
||||
for (size_t j = 1; j < nb->contained_items.size(); j++)
|
||||
{
|
||||
df::item* item = nb->contained_items[j]->item;
|
||||
if (item->flags.bits.forbid != fertile)
|
||||
{
|
||||
item->flags.bits.forbid = fertile;
|
||||
out << item->getStackSize() << " eggs " << (fertile ? "forbidden" : "unforbidden.") << endl;
|
||||
static int get_config_val(PersistentDataItem &c, int index) {
|
||||
if (!c.isValid())
|
||||
return -1;
|
||||
return c.ival(index);
|
||||
}
|
||||
static bool get_config_bool(PersistentDataItem &c, int index) {
|
||||
return get_config_val(c, index) == 1;
|
||||
}
|
||||
static void set_config_val(PersistentDataItem &c, int index, int value) {
|
||||
if (c.isValid())
|
||||
c.ival(index) = value;
|
||||
}
|
||||
static void set_config_bool(PersistentDataItem &c, int index, bool value) {
|
||||
set_config_val(c, index, value ? 1 : 0);
|
||||
}
|
||||
|
||||
static const int32_t CYCLE_TICKS = 100; // need to react quickly if eggs are unforbidden
|
||||
static int32_t cycle_timestamp = 0; // world->frame_counter at last cycle
|
||||
|
||||
static void do_cycle(color_ostream &out);
|
||||
|
||||
DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands) {
|
||||
DEBUG(config,out).print("initializing %s\n", plugin_name);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_enable(color_ostream &out, bool enable) {
|
||||
if (!Core::getInstance().isWorldLoaded()) {
|
||||
out.printerr("Cannot enable %s without a loaded world.\n", plugin_name);
|
||||
return CR_FAILURE;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_init (color_ostream &out, std::vector <PluginCommand> &commands)
|
||||
{
|
||||
if (world && plotinfo) {
|
||||
commands.push_back(
|
||||
PluginCommand(
|
||||
"nestboxes",
|
||||
"Protect fertile eggs incubating in a nestbox.",
|
||||
nestboxes));
|
||||
if (enable != is_enabled) {
|
||||
is_enabled = enable;
|
||||
DEBUG(config,out).print("%s from the API; persisting\n",
|
||||
is_enabled ? "enabled" : "disabled");
|
||||
set_config_bool(config, CONFIG_IS_ENABLED, is_enabled);
|
||||
} else {
|
||||
DEBUG(config,out).print("%s from the API, but already %s; no action\n",
|
||||
is_enabled ? "enabled" : "disabled",
|
||||
is_enabled ? "enabled" : "disabled");
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_shutdown ( color_ostream &out )
|
||||
{
|
||||
DFhackCExport command_result plugin_shutdown (color_ostream &out) {
|
||||
DEBUG(config,out).print("shutting down %s\n", plugin_name);
|
||||
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_onupdate(color_ostream &out)
|
||||
{
|
||||
if (!enabled)
|
||||
return CR_OK;
|
||||
DFhackCExport command_result plugin_load_data (color_ostream &out) {
|
||||
config = World::GetPersistentData(CONFIG_KEY);
|
||||
|
||||
static unsigned cnt = 0;
|
||||
if ((++cnt % 5) != 0)
|
||||
return CR_OK;
|
||||
if (!config.isValid()) {
|
||||
DEBUG(config,out).print("no config found in this save; initializing\n");
|
||||
config = World::AddPersistentData(CONFIG_KEY);
|
||||
set_config_bool(config, CONFIG_IS_ENABLED, is_enabled);
|
||||
}
|
||||
|
||||
is_enabled = get_config_bool(config, CONFIG_IS_ENABLED);
|
||||
DEBUG(config,out).print("loading persisted enabled state: %s\n",
|
||||
is_enabled ? "true" : "false");
|
||||
|
||||
eggscan(out);
|
||||
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(config,out).print("world unloaded; disabling %s\n",
|
||||
plugin_name);
|
||||
is_enabled = false;
|
||||
}
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
DFhackCExport command_result plugin_enable(color_ostream &out, bool enable)
|
||||
{
|
||||
enabled = enable;
|
||||
DFhackCExport command_result plugin_onupdate(color_ostream &out) {
|
||||
if (is_enabled && world->frame_counter - cycle_timestamp >= CYCLE_TICKS)
|
||||
do_cycle(out);
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
static command_result nestboxes(color_ostream &out, vector <string> & parameters)
|
||||
{
|
||||
CoreSuspender suspend;
|
||||
/////////////////////////////////////////////////////
|
||||
// cycle logic
|
||||
//
|
||||
|
||||
if (parameters.size() == 1) {
|
||||
if (parameters[0] == "enable")
|
||||
enabled = true;
|
||||
else if (parameters[0] == "disable")
|
||||
enabled = false;
|
||||
else
|
||||
return CR_WRONG_USAGE;
|
||||
} else {
|
||||
out << "Plugin " << (enabled ? "enabled" : "disabled") << "." << endl;
|
||||
static void do_cycle(color_ostream &out) {
|
||||
DEBUG(cycle,out).print("running %s cycle\n", plugin_name);
|
||||
|
||||
// mark that we have recently run
|
||||
cycle_timestamp = world->frame_counter;
|
||||
|
||||
for (df::building_nest_boxst *nb : world->buildings.other.NEST_BOX) {
|
||||
bool fertile = false;
|
||||
if (nb->claimed_by != -1) {
|
||||
df::unit *u = df::unit::find(nb->claimed_by);
|
||||
if (u && u->pregnancy_timer > 0)
|
||||
fertile = true;
|
||||
}
|
||||
for (auto &contained_item : nb->contained_items) {
|
||||
df::item *item = contained_item->item;
|
||||
if (item->flags.bits.forbid != fertile) {
|
||||
item->flags.bits.forbid = fertile;
|
||||
out.print("%d eggs %s.\n", item->getStackSize(), fertile ? "forbidden" : "unforbidden");
|
||||
}
|
||||
}
|
||||
}
|
||||
return CR_OK;
|
||||
}
|
||||
|
||||
@ -1 +1 @@
|
||||
Subproject commit bf914ddd8c58011368f72172f9d158d0043c61fc
|
||||
Subproject commit 8c7b3ed7a9ebcd1988fd6381bc943cd86bd2a3f8
|
||||
Loading…
Reference in New Issue