-
-
- job -
- job-material -
- job-duplicate -
- workflow
-
-
- Function -
- Constraint format -
- Constraint examples +
- Job management -
- Fortress activity management
-
-
- seedwatch -
- zone
-
-
- Usage with single units -
- Usage with filters -
- Mass-renaming -
- Cage zones -
- Examples +
- Fortress activity management -
- Other -
- Scripts
-
-
- fix/* -
- gui/* -
- binpatch -
- quicksave -
- setfps -
- siren -
- growcrops -
- removebadthoughts -
- exterminate -
- source -
- masspit -
- digfort -
- invasion-now -
- digmat -
- superdwarf -
- drainaquifer -
- deathcause -
- lua -
- embark -
- lever -
- stripcaged -
- undump-buildings -
- create-items -
- locate-ore -
- soundsense-season -
- multicmd +
- Scripts -
- In-game interface tools
-
-
- Dwarf Manipulator -
- Search -
- AutoMaterial -
- gui/liquids -
- gui/mechanisms -
- gui/rename -
- gui/room-list -
- gui/choose-weapons -
- gui/clone-uniform -
- gui/guide-path -
- gui/workshop-job -
- gui/workflow -
- gui/assign-rack -
- gui/advfort -
- gui/companion-order -
- gui/gm-editor -
- gui/mod-manager +
- In-game interface tools -
- Behavior Mods
-
-
- Siege Engine
-
-
- Rationale -
- Configuration UI +
- Behavior Mods
@@ -2354,11 +2358,28 @@ with visualizers.
dwarfexport
Export dwarves to RuneSmith-compatible XML.
++exportlegends
+Exports data from legends mode; allowing a set-and-forget export of large worlds.
+Options:
++
++
++ + + maps: Exports all fifteen detailed maps +all: first exports the world/gen info, then the XML, then all detailed maps +-Job management
+Job management
-job
+job
Command for general job query and manipulation.
- Options: @@ -2377,7 +2398,7 @@ in a workshop, or the unit/jobs screen.
-job-material
+job-material
Alter the material of the selected job.
Invoked as:
@@ -2395,7 +2416,7 @@ over the first available choice with the matching material.
-+job-duplicate
+job-duplicate
- Duplicate the selected job in a workshop:
-
@@ -2405,8 +2426,36 @@ instantly duplicates the job.
+stockflow
+Allows the fortress bookkeeper to queue jobs through the manager.
+Usage:
++
+-
+
- stockflow enable +
- Enable the plugin. +
- stockflow disable +
- Disable the plugin. +
- stockflow list +
- List any work order settings for your stockpiles. +
- stockflow status +
- Display whether the plugin is enabled. +
-
+
- While enabled, the 'q' menu of each stockpile will have two new options: +
-
+
- j: Select a job to order, from an interface like the manager's screen. +
- J: Cycle between several options for how many such jobs to order. +
+
Whenever the bookkeeper updates stockpile records, new work orders will +be placed on the manager's queue for each such selection, reduced by the +number of identical orders already in the queue.
+-workflow
+workflow
Manage control of repeat jobs.
Usage:
@@ -2438,7 +2487,7 @@ this list can be copied to a file, and then reloaded using the
-Function
+Function
When the plugin is enabled, it protects all repeat jobs from removal. If they do disappear due to any cause, they are immediately re-added to their workshop and suspended.
@@ -2451,7 +2500,7 @@ the frequency of jobs being toggled. in the game UI.-Constraint format
+Constraint format
The contstraint spec consists of 4 parts, separated with '/' characters:
ITEM[:SUBTYPE]/[GENERIC_MAT,...]/[SPECIFIC_MAT:...]/[LOCAL,<quality>] @@ -2480,7 +2529,7 @@ be used to ignore imported items or items below a certain quality.
-Constraint examples
+Constraint examples
Keep metal bolts within 900-1000, and wood/bone within 150-200.
workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 @@ -2529,15 +2578,15 @@ workflow count CRAFTS///LOCAL,EXCEPTIONAL 100 90
-Fortress activity management
+Fortress activity management
-seedwatch
+seedwatch
Tool for turning cooking of seeds and plants on/off depending on how much you have of them.
See 'seedwatch help' for detailed description.
-zone
+zone
Helps a bit with managing activity zones (pens, pastures and pits) and cages.
Options:
@@ -2636,7 +2685,7 @@ for war/hunt). Negatable.
-Usage with single units
+Usage with single units
One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2645,7 +2694,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.
-Usage with filters
+Usage with filters
All filters can be used together with the 'assign' command.
Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2663,14 +2712,14 @@ are not properly added to your own stocks; slaughtering them should work).
Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).
-Mass-renaming
+Mass-renaming
Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.
-Cage zones
+Cage zones
Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2681,7 +2730,7 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.
-autonestbox
+autonestbox
Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2736,7 +2785,7 @@ frames between runs.
-autobutcher
+autobutcher
Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.
Named units will be completely ignored (to protect specific animals from @@ -2844,7 +2893,7 @@ autobutcher.bat
-Other
+Other
-catsplosion
+catsplosion
Makes cats just multiply. It is not a good idea to run this more than once or twice.
-dfusion
+dfusion
- This is the DFusion lua plugin system by Warmist, running as a DFHack plugin. There are two parts to this plugin: an interactive script that shows a text based menu and lua modules. Some of the functionality of is intentionaly left out of the menu:
@@ -2909,7 +2958,7 @@ twice.
-misery
+misery
When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).
Usage:
@@ -2931,7 +2980,7 @@ twice.
-+strangemood
+strangemood
Creates a strange mood job the same way the game itself normally does it.
Options:
@@ -2954,10 +3003,14 @@ Valid values are "miner", "carpenter", "engraver",
Known limitations: if the selected unit is currently performing a job, the mood will not be started.
+log-region
+When enabled in dfhack.init, each time a fort is loaded identifying information will be written to the gamelog. Assists in parsing the file if you switch between forts, and adds information for story-building.
+-Scripts
+Scripts
Lua or ruby scripts placed in the hack/scripts/ directory are considered for execution as if they were native DFHack commands. They are listed at the end of the 'ls' command output.
@@ -2966,7 +3019,7 @@ only be listed by ls if called as 'ls -a'. This is intended as a way to hide scripts that are obscure, developer-oriented, or should be used as keybindings.Some notable scripts:
-fix/*
+fix/*
Scripts in this subdirectory fix various bugs and issues, some of them obscure.
fix/dead-units
@@ -3003,12 +3056,12 @@ hopefully avoid jamming it again, and unsuspends them.
-gui/*
+gui/*
Scripts that implement dialogs inserted into the main game window are put in this directory.
-binpatch
+binpatch
Checks, applies or removes binary patches directly in memory at runtime:
binpatch check/apply/remove <patchname> @@ -3018,17 +3071,17 @@ script uses hack/patches/<df-v the version appropriate for the currently loaded executable.-quicksave
+quicksave
If called in dwarf mode, makes DF immediately auto-save the game by setting a flag normally used in seasonal auto-save.
-setfps
+setfps
Run setfps <number> to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :)
-siren
+siren
Wakes up sleeping units, cancels breaks and stops parties either everywhere, or in the burrows given as arguments. In return, adds bad thoughts about noise, tiredness and lack of protection. Also, the units with interrupted @@ -3036,7 +3089,7 @@ breaks will go on break again a lot sooner. The script is intended for emergencies, e.g. when a siege appears, and all your military is partying.
-growcrops
+growcrops
Instantly grow seeds inside farming plots.
With no argument, this command list the various seed types currently in use in your farming plots. @@ -3048,7 +3101,7 @@ growcrops plump 40
-removebadthoughts
+removebadthoughts
This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.
The script can target a single creature, when used with the him argument, @@ -3062,7 +3115,7 @@ but in the short term your dwarves will get much more joyful.
quickly after you unpause.-exterminate
+exterminate
Kills any unit of a given race.
With no argument, lists the available races and count eligible targets.
With the special argument him, targets only the selected creature.
@@ -3094,7 +3147,7 @@ exterminate elve magma-source
+source
Create an infinite magma or water source or drain on a tile.
This script registers a map tile as a liquid source, and every 12 game ticks that tile receives or remove 1 new unit of flow based on the configuration.
@@ -3116,14 +3169,14 @@ source add water 0 - water drain-masspit
+masspit
Designate all creatures in cages on top of a pit/pond activity zone for pitting. Works best with an animal stockpile on top of the zone.
Works with a zone number as argument (eg Activity Zone #6 -> masspit 6) or with the game cursor on top of the area.
-digfort
+digfort
A script to designate an area for digging according to a plan in csv format.
This script, inspired from quickfort, can designate an area for digging. Your plan should be stored in a .csv file like this:
@@ -3145,7 +3198,7 @@ as an offset for the pattern: instead of starting at the cursor, it will start Dwarf Fortress.exe is found).-invasion-now
+invasion-now
Triggers an invasion, or several in the near future.
invasion-now civName trigger an invasion from the civilization with the id civName, starting in about ten ticks
invasion-now civName start trigger an invasion from civName in a number of ticks between 10*start and 11*start-1 (inclusive)
@@ -3153,7 +3206,7 @@ Dwarf Fortress.exe is found).Probably fails if the start time of a triggered invasion is later than the start of the next year.
-digmat
+digmat
Designates a tile for digging. Monitors the tile, and when it is dug out, add surrounding discovered tiles of the same material for digging. Similar to 'digv', but less cheaty. Works for stone layers, soil layers, veins, etc.
@@ -3162,7 +3215,7 @@ same designation for future digging (eg dig up/downstairs). When digging stairs, also designate tiles on z-1 and z+1 when they are discovered.-superdwarf
+superdwarf
Similar to fastdwarf, per-creature.
To make any creature superfast, target it ingame using 'v' and:
@@ -3172,17 +3225,17 @@ superdwarf add
This plugin also shortens the 'sleeping' and 'on break' periods of targets.
-deathcause
+deathcause
Focus a body part ingame, and this script will display the cause of death of the creature. Also works when selecting units from the 'u'nitlist viewscreen.
-lua
+lua
There are the following ways to invoke this command:
lua (without any parameters)
@@ -3201,11 +3254,11 @@ directory. If the filename is not supplied, it loads "dfhack.lua".
-lever
+lever
Allow manipulation of in-game levers from the dfhack console.
Can list levers, including state and links, with:
@@ -3219,7 +3272,7 @@ lever pull 42 --now
-stripcaged
+stripcaged
For dumping items inside cages. Will mark selected items for dumping, then a dwarf may come and actually dump it. See also autodump.
With the items argument, only dumps items laying in the cage, excluding @@ -3237,11 +3290,11 @@ stripcaged weapons 25321 34228
-create-items
+create-items
Spawn arbitrary items under the cursor.
The first argument gives the item category, the second gives the material, and the optionnal third gives the number of items to create (defaults to 20).
@@ -3263,7 +3316,7 @@ create-items bar adamantine-locate-ore
+locate-ore
Scan the map for metal ores.
Finds and designate for digging one tile of a specific metal ore. Only works for native metal ores, does not handle reaction stuff (eg STEEL).
@@ -3276,7 +3329,7 @@ locate-ore iron-soundsense-season
+soundsense-season
It is a well known issue that Soundsense cannot detect the correct current season when a savegame is loaded and has to play random season music until a season switch occurs.
@@ -3285,7 +3338,7 @@ to gamelog.txt on every map load to fix this. For best results call the script from dfhack.init.-+multicmd
+multicmd
Run multiple dfhack commands. The argument is split around the character ; and all parts are run sequencially as independent dfhack commands. Useful for hotkeys.
@@ -3294,9 +3347,13 @@ dfhack commands. Useful for hotkeys.- multicmd locate-ore iron ; digv
+dfstatus
+Show a quick overview of critical stock quantities, including food, dirnks, wood, and various bars.
+-In-game interface tools
+In-game interface tools
These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.
@@ -3311,7 +3368,7 @@ guideline because it arguably just fixes small usability bugs in the game UI.-Dwarf Manipulator
+Dwarf Manipulator
Implemented by the 'manipulator' plugin.
To activate, open the unit screen and press 'l'.
@@ -3350,7 +3407,7 @@ cursor onto that cell instead of toggling it.
directly to the main dwarf mode screen.
-Search
+Search
Implemented by the 'search' plugin.
The search plugin adds search to the Stocks, Animals, Trading, Stockpile, Noble (assignment candidates), Military (position candidates), Burrows @@ -3381,7 +3438,7 @@ only fat or tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats again while the list is filtered.
-AutoMaterial
+AutoMaterial
Implemented by the 'automaterial' plugin.
This makes building constructions (walls, floors, fortifications, etc) a little bit easier by saving you from having to trawl through long lists of materials each time @@ -3409,7 +3466,7 @@ materials, it returns you back to this screen. If you use this along with severa enabled materials, you should be able to place complex constructions more conveniently.
-gui/liquids
+gui/liquids
To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.
This script is a gui front-end to the liquids plugin and works similar to it, @@ -3429,7 +3486,7 @@ rivers power water wheels even when full and technically not flowing.
After setting up the desired operations using the described keys, use Enter to apply them.
-gui/mechanisms
+gui/mechanisms
To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.
Lists mechanisms connected to the building, and their links. Navigating the list centers @@ -3439,7 +3496,7 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.
-gui/rename
+gui/rename
Backed by the rename plugin, this script allows entering the desired name via a simple dialog in the game ui.
-
@@ -3462,7 +3519,7 @@ their species string.
unit profession change to Ctrl-Shift-T.
-gui/room-list
+gui/room-list
To use, bind to a key (the example config uses Alt-R) and activate in the 'q' mode, either immediately or after opening the assign owner page.
@@ -3470,7 +3527,7 @@ either immediately or after opening the assign owner page.
list, and allows unassigning them.
-gui/choose-weapons
+gui/choose-weapons
Bind to a key (the example config uses Ctrl-W), and activate in the Equip->View/Customize page of the military screen.
Depending on the cursor location, it rewrites all 'individual choice weapon' entries @@ -3481,14 +3538,14 @@ only that entry, and does it even if it is not 'individual choice'.
and may lead to inappropriate weapons being selected.-gui/clone-uniform
+gui/clone-uniform
Bind to a key (the example config uses Ctrl-C), and activate in the Uniforms page of the military screen with the cursor in the leftmost list.
When invoked, the script duplicates the currently selected uniform template, and selects the newly created copy.
-gui/guide-path
+gui/guide-path
Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with the cursor over a Guide order.
@@ -3496,7 +3553,7 @@ the cursor over a Guide order.
computes it when the order is executed for the first time.
-gui/workshop-job
+gui/workshop-job
Bind to a key (the example config uses Alt-A), and activate with a job selected in a workshop in the 'q' mode.
@@ -3532,7 +3589,7 @@ and then try to change the input item type, now it won't let you select plan
you have to unset the material first.
-gui/workflow
+gui/workflow
Bind to a key (the example config uses Alt-W), and activate with a job selected in a workshop in the 'q' mode.
@@ -3579,7 +3636,7 @@ the current stock value. The bright green dashed line is the target
limit (maximum) and the dark green line is that minus the gap (minimum).
-gui/assign-rack
+gui/assign-rack
Bind to a key (the example config uses P), and activate when viewing a weapon rack in the 'q' mode.
@@ -3603,7 +3660,7 @@ the intended user. In order to aid in the choice, it shows the number
of currently assigned racks for every valid squad.
-gui/advfort
+gui/advfort
This script allows to perform jobs in adventure mode. For more complete help press '?' while script is running. It's most confortable to use this as a keybinding. (e.g. keybinding set Ctrl-T gui/advfort). Possible arguments:
@@ -3622,7 +3679,7 @@ implies -a-gui/companion-order
+gui/companion-order
A script to issue orders for companions. Select companions with lower case chars, issue orders with upper case. Must be in look or talk mode to issue command on tile.
@@ -3638,7 +3695,7 @@ case. Must be in look or talk mode to issue command on tile.
-gui/gm-editor
+gui/gm-editor
There are three ways to open this editor:
- using gui/gm-editor command/keybinding - opens editor on what is selected @@ -3653,14 +3710,14 @@ the same as version above. in-game help.
-gui/mod-manager
-A way to simply install and remove small mods. It looks for specially formated mods in +
gui/mod-manager
+A way to simply install and remove small mods. It looks for specially formatted mods in df subfolder 'mods'. Mods are not included, for example mods see: github mini mod repository
-Behavior Mods
+Behavior Mods
These plugins, when activated via configuration UI or by detecting certain structures in RAWs, modify the game engine behavior concerning the target objects to add features not otherwise present.
@@ -3671,20 +3728,20 @@ technical challenge, and do not represent any long-term plans to produce more similar modifications of the game.-Siege Engine
+Siege Engine
The siege-engine plugin enables siege engines to be linked to stockpiles, and aimed at an arbitrary rectangular area across Z levels, instead of the original four directions. Also, catapults can be ordered to load arbitrary objects, not just stones.
-Rationale
+Rationale
Siege engines are a very interesting feature, but sadly almost useless in the current state because they haven't been updated since 2D and can only aim in four directions. This is an attempt to bring them more up to date until Toady has time to work on it. Actual improvements, e.g. like making siegers bring their own, are something only Toady can do.
-Configuration UI
+Configuration UI
The configuration front-end to the plugin is implemented by the gui/siege-engine script. Bind it to a key (the example config uses Alt-A) and activate after selecting a siege engine in 'q' mode.
@@ -3707,7 +3764,7 @@ menu.-Power Meter
+Power Meter
The power-meter plugin implements a modified pressure plate that detects power being supplied to gear boxes built in the four adjacent N/S/W/E tiles.
The configuration front-end is implemented by the gui/power-meter script. Bind it to a @@ -3718,11 +3775,11 @@ in the build menu.
configuration page, but configures parameters relevant to the modded power meter building.-Steam Engine
+Steam Engine
The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.
-Rationale
+Rationale
The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -3733,7 +3790,7 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.
-Construction
+Construction
The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.
@@ -3757,7 +3814,7 @@ short axles that can be built later than both of the engines.-Operation
+Operation
In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -3788,7 +3845,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.
-Explosions
+Explosions
The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.
During operation weak parts get gradually worn out, and @@ -3797,7 +3854,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.
-Save files
+Save files
It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -3808,7 +3865,7 @@ being generated.
-Add Spatter
+Add Spatter
This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements. The produced contaminants are immune to being washed away by water or destroyed by diff --git a/Readme.rst b/Readme.rst index e8a04de78..a2bc3afb2 100644 --- a/Readme.rst +++ b/Readme.rst @@ -1577,6 +1577,29 @@ Duplicate the selected job in a workshop: * In 'q' mode, when a job is highlighted within a workshop or furnace building, instantly duplicates the job. +stockflow +--------- +Allows the fortress bookkeeper to queue jobs through the manager. + +Usage: + + ``stockflow enable`` + Enable the plugin. + ``stockflow disable`` + Disable the plugin. + ``stockflow list`` + List any work order settings for your stockpiles. + ``stockflow status`` + Display whether the plugin is enabled. + +While enabled, the 'q' menu of each stockpile will have two new options: + * j: Select a job to order, from an interface like the manager's screen. + * J: Cycle between several options for how many such jobs to order. + +Whenever the bookkeeper updates stockpile records, new work orders will +be placed on the manager's queue for each such selection, reduced by the +number of identical orders already in the queue. + workflow -------- Manage control of repeat jobs. @@ -2962,7 +2985,7 @@ in-game help. gui/mod-manager =============== -A way to simply install and remove small mods. It looks for specially formated mods in +A way to simply install and remove small mods. It looks for specially formatted mods in df subfolder 'mods'. Mods are not included, for example mods see: `github mini mod repository
& parame { if (parameters.size() == 1 && toLower(parameters[0])[0] == 'v') { - out << "Building Plan" << endl << "Version: " << PLUGIN_VERSION << endl; + out << "Autotrade" << endl << "Version: " << PLUGIN_VERSION << endl; } } diff --git a/plugins/command-prompt.cpp b/plugins/command-prompt.cpp index d7a8e230c..3cdd83ab3 100644 --- a/plugins/command-prompt.cpp +++ b/plugins/command-prompt.cpp @@ -7,6 +7,7 @@ #include #include +#include #include #include -
@@ -55,9 +56,14 @@ public:
df::global::gps->display_frames=show_fps;
}
- void add_response(color_value v,std::string s)
+ void add_response(color_value v, std::string s)
{
- responses.push_back(std::make_pair(v,s));
+ std::stringstream ss(s);
+ std::string part;
+ while (std::getline(ss, part))
+ {
+ responses.push_back(std::make_pair(v, part + '\n'));
+ }
}
protected:
std::list
& parameters) { string item_str, material_str; - df::item_type item_type = df::item_type::NONE; + df::item_type item_type = item_type::NONE; int16_t item_subtype = -1; int16_t mat_type = -1; int32_t mat_index = -1; @@ -156,23 +158,23 @@ command_result df_createitem (color_ostream &out, vector & parameters) } switch (item->getType()) { - case df::item_type::FLASK: - case df::item_type::BARREL: - case df::item_type::BUCKET: - case df::item_type::ANIMALTRAP: - case df::item_type::BOX: - case df::item_type::BIN: - case df::item_type::BACKPACK: - case df::item_type::QUIVER: + case item_type::FLASK: + case item_type::BARREL: + case item_type::BUCKET: + case item_type::ANIMALTRAP: + case item_type::BOX: + case item_type::BIN: + case item_type::BACKPACK: + case item_type::QUIVER: break; - case df::item_type::TOOL: - if (item->hasToolUse(df::tool_uses::LIQUID_CONTAINER)) + case item_type::TOOL: + if (item->hasToolUse(tool_uses::LIQUID_CONTAINER)) break; - if (item->hasToolUse(df::tool_uses::FOOD_STORAGE)) + if (item->hasToolUse(tool_uses::FOOD_STORAGE)) break; - if (item->hasToolUse(df::tool_uses::SMALL_OBJECT_STORAGE)) + if (item->hasToolUse(tool_uses::SMALL_OBJECT_STORAGE)) break; - if (item->hasToolUse(df::tool_uses::TRACK_CART)) + if (item->hasToolUse(tool_uses::TRACK_CART)) break; default: out.printerr("The selected item cannot be used for item storage!\n"); @@ -195,22 +197,22 @@ command_result df_createitem (color_ostream &out, vector & parameters) } switch (building->getType()) { - case df::building_type::Coffin: - case df::building_type::Furnace: - case df::building_type::TradeDepot: - case df::building_type::Shop: - case df::building_type::Box: - case df::building_type::Weaponrack: - case df::building_type::Armorstand: - case df::building_type::Workshop: - case df::building_type::Cabinet: - case df::building_type::SiegeEngine: - case df::building_type::Trap: - case df::building_type::AnimalTrap: - case df::building_type::Cage: - case df::building_type::Wagon: - case df::building_type::NestBox: - case df::building_type::Hive: + case building_type::Coffin: + case building_type::Furnace: + case building_type::TradeDepot: + case building_type::Shop: + case building_type::Box: + case building_type::Weaponrack: + case building_type::Armorstand: + case building_type::Workshop: + case building_type::Cabinet: + case building_type::SiegeEngine: + case building_type::Trap: + case building_type::AnimalTrap: + case building_type::Cage: + case building_type::Wagon: + case building_type::NestBox: + case building_type::Hive: break; default: out.printerr("The selected building cannot be used for item storage!\n"); @@ -252,28 +254,31 @@ command_result df_createitem (color_ostream &out, vector & parameters) MaterialInfo material; vector tokens; - if (!item.find(item_str)) + if (item.find(item_str)) { - out.printerr("Unrecognized item type!\n"); + item_type = item.type; + item_subtype = item.subtype; + } + if (item_type == item_type::NONE) + { + out.printerr("You must specify a valid item type to create!\n"); return CR_FAILURE; } - item_type = item.type; - item_subtype = item.subtype; switch (item.type) { - case df::item_type::INSTRUMENT: - case df::item_type::TOY: - case df::item_type::WEAPON: - case df::item_type::ARMOR: - case df::item_type::SHOES: - case df::item_type::SHIELD: - case df::item_type::HELM: - case df::item_type::GLOVES: - case df::item_type::AMMO: - case df::item_type::PANTS: - case df::item_type::SIEGEAMMO: - case df::item_type::TRAPCOMP: - case df::item_type::TOOL: + case item_type::INSTRUMENT: + case item_type::TOY: + case item_type::WEAPON: + case item_type::ARMOR: + case item_type::SHOES: + case item_type::SHIELD: + case item_type::HELM: + case item_type::GLOVES: + case item_type::AMMO: + case item_type::PANTS: + case item_type::SIEGEAMMO: + case item_type::TRAPCOMP: + case item_type::TOOL: if (item_subtype == -1) { out.printerr("You must specify a subtype!\n"); @@ -289,12 +294,12 @@ command_result df_createitem (color_ostream &out, vector & parameters) mat_index = material.index; break; - case df::item_type::REMAINS: - case df::item_type::FISH: - case df::item_type::FISH_RAW: - case df::item_type::VERMIN: - case df::item_type::PET: - case df::item_type::EGG: + case item_type::REMAINS: + case item_type::FISH: + case item_type::FISH_RAW: + case item_type::VERMIN: + case item_type::PET: + case item_type::EGG: split_string(&tokens, material_str, ":"); if (tokens.size() != 2) { @@ -331,9 +336,9 @@ command_result df_createitem (color_ostream &out, vector & parameters) } break; - case df::item_type::CORPSE: - case df::item_type::CORPSEPIECE: - case df::item_type::FOOD: + case item_type::CORPSE: + case item_type::CORPSEPIECE: + case item_type::FOOD: out.printerr("Cannot create that type of item!\n"); return CR_FAILURE; break; @@ -376,16 +381,16 @@ command_result df_createitem (color_ostream &out, vector & parameters) prod->count = count; switch (item_type) { - case df::item_type::BAR: - case df::item_type::POWDER_MISC: - case df::item_type::LIQUID_MISC: - case df::item_type::DRINK: + case item_type::BAR: + case item_type::POWDER_MISC: + case item_type::LIQUID_MISC: + case item_type::DRINK: prod->product_dimension = 150; break; - case df::item_type::THREAD: + case item_type::THREAD: prod->product_dimension = 15000; break; - case df::item_type::CLOTH: + case item_type::CLOTH: prod->product_dimension = 10000; break; default: diff --git a/plugins/lua/stockflow.lua b/plugins/lua/stockflow.lua new file mode 100644 index 000000000..489a72705 --- /dev/null +++ b/plugins/lua/stockflow.lua @@ -0,0 +1,1129 @@ +local _ENV = mkmodule('plugins.stockflow') + +local gui = require "gui" +local utils = require "utils" + +reaction_list = reaction_list or {} +saved_orders = saved_orders or {} +jobs_to_create = jobs_to_create or {} + +triggers = { + {filled = false, divisor = 1, name = "Per empty space"}, + {filled = true, divisor = 1, name = "Per stored item"}, + {filled = false, divisor = 2, name = "Per two empty spaces"}, + {filled = true, divisor = 2, name = "Per two stored items"}, + {filled = false, divisor = 3, name = "Per three empty spaces"}, + {filled = true, divisor = 3, name = "Per three stored items"}, + {filled = false, divisor = 4, name = "Per four empty spaces"}, + {filled = true, divisor = 4, name = "Per four stored items"}, + {name = "Never"}, +} + +local job_types = df.job_type + +entry_ints = { + stockpile_id = 1, + order_number = 2, + trigger_number = 3, +} + +PageSize = 16 +FirstRow = 4 +CenterCol = 38 + +-- Populate the reaction and stockpile order lists. +-- To be called whenever a world is loaded. +function initialize_world() + reaction_list = collect_reactions() + saved_orders = collect_orders() + jobs_to_create = {} +end + +-- Clear all caches. +-- Called when a world is loaded, or when the plugin is disabled. +function clear_caches() + -- Free the C++ objects in the reaction list. + for _, value in ipairs(reaction_list) do + value.order:delete() + end + reaction_list = {} + saved_orders = {} + jobs_to_create = {} +end + +function trigger_name(cache) + local trigger = triggers[cache.entry.ints[entry_ints.trigger_number]] + return trigger and trigger.name or "Never" +end + +function list_orders() + local listed = false + for _, spec in pairs(saved_orders) do + local num = spec.stockpile.stockpile_number + local name = spec.entry.value + local trigger = trigger_name(spec) + print("Stockpile #"..num, name, trigger) + listed = true + end + + if not listed then + print("No manager jobs have been set for your stockpiles.") + print("Use j in a stockpile menu to create one...") + end +end + +-- Save the stockpile jobs for later creation. +-- Called when the bookkeeper starts updating stockpile records. +function start_bookkeeping() + result = {} + for reaction_id, quantity in pairs(check_stockpiles()) do + local amount = order_quantity(reaction_list[reaction_id].order, quantity) + if amount > 0 then + result[reaction_id] = amount + end + end + + jobs_to_create = result +end + +-- Insert any saved jobs. +-- Called when the bookkeeper finishes updating stockpile records. +function finish_bookkeeping() + for reaction, amount in pairs(jobs_to_create) do + create_orders(reaction_list[reaction].order, amount) + end + + jobs_to_create = {} +end + +function stockpile_settings(sp) + local order = saved_orders[sp.id] + if not order then + return "No job selected", "" + end + + return order.entry.value, trigger_name(order) +end + +-- Toggle the trigger condition for a stockpile. +function toggle_trigger(sp) + local saved = saved_orders[sp.id] + if saved then + saved.entry.ints[entry_ints.trigger_number] = (saved.entry.ints[entry_ints.trigger_number] % #triggers) + 1 + saved.entry:save() + end +end + +function collect_orders() + local result = {} + local entries = dfhack.persistent.get_all("stockflow/entry", true) + if entries then + local stockpiles = df.global.world.buildings.other.STOCKPILE + for _, entry in ipairs(entries) do + local spid = entry.ints[entry_ints.stockpile_id] + local stockpile = utils.binsearch(stockpiles, spid, "id") + if stockpile then + -- Todo: What if entry.value ~= reaction_list[order_number].name? + result[spid] = { + stockpile = stockpile, + entry = entry, + } + end + end + end + + return result +end + +-- Choose an order that the stockpile should add to the manager queue. +function select_order(stockpile) + screen:reset(stockpile) + screen:show() +end + +function reaction_entry(job_type, values, name) + local order = df.manager_order:new() + -- These defaults differ from the newly created order's. + order:assign{ + job_type = job_type, + unk_2 = -1, + item_subtype = -1, + mat_type = -1, + mat_index = -1, + } + + if values then + -- Override default attributes. + order:assign(values) + end + + return { + name = name or df.job_type.attrs[job_type].caption, + order = order, + } +end + +function resource_reactions(reactions, job_type, mat_info, keys, items, options) + local values = {} + for key, value in pairs(mat_info.management) do + values[key] = value + end + + for _, itemid in ipairs(keys) do + local itemdef = items[itemid] + local start = options.verb or mat_info.verb or "Make" + if options.adjective then + start = start.." "..itemdef.adjective + end + + if (not options.permissible) or options.permissible(itemdef) then + local item_name = " "..itemdef[options.name_field or "name"] + if options.capitalize then + item_name = string.gsub(item_name, " .", string.upper) + end + + values.item_subtype = itemid + table.insert(reactions, reaction_entry(job_type, values, start.." "..mat_info.adjective..item_name)) + end + end +end + +function material_reactions(reactions, itemtypes, mat_info) + -- Expects a list of {job_type, verb, item_name} tuples. + for _, row in ipairs(itemtypes) do + local line = row[2].." "..mat_info.adjective + if row[3] then + line = line.." "..row[3] + end + + table.insert(reactions, reaction_entry(row[1], mat_info.management, line)) + end +end + +function clothing_reactions(reactions, mat_info, filter) + local resources = df.historical_entity.find(df.global.ui.civ_id).resources + local itemdefs = df.global.world.raws.itemdefs + resource_reactions(reactions, job_types.MakeArmor, mat_info, resources.armor_type, itemdefs.armor, {permissible = filter}) + resource_reactions(reactions, job_types.MakePants, mat_info, resources.pants_type, itemdefs.pants, {permissible = filter}) + resource_reactions(reactions, job_types.MakeGloves, mat_info, resources.gloves_type, itemdefs.gloves, {permissible = filter}) + resource_reactions(reactions, job_types.MakeHelm, mat_info, resources.helm_type, itemdefs.helms, {permissible = filter}) + resource_reactions(reactions, job_types.MakeShoes, mat_info, resources.shoes_type, itemdefs.shoes, {permissible = filter}) +end + +-- Find the reaction types that should be listed in the management interface. +function collect_reactions() + -- The sequence here tries to match the native manager screen. + -- It should also be possible to collect the sequence from somewhere native, + -- but I currently can only find it while the job selection screen is active. + -- Even that list doesn't seem to include their names. + local result = {} + + local materials = { + rock = { + adjective = "rock", + management = {mat_type = 0}, + }, + } + + for _, name in ipairs{"wood", "cloth", "leather", "silk", "yarn", "bone", "shell", "tooth", "horn", "pearl"} do + materials[name] = { + adjective = name, + management = {material_category = {[name] = true}}, + } + end + + materials.wood.adjective = "wooden" + materials.tooth.adjective = "ivory/tooth" + materials.leather.clothing_flag = "LEATHER" + + -- Collection and Entrapment + table.insert(result, reaction_entry(job_types.CollectWebs)) + table.insert(result, reaction_entry(job_types.CollectSand)) + table.insert(result, reaction_entry(job_types.CollectClay)) + table.insert(result, reaction_entry(job_types.CatchLiveLandAnimal)) + table.insert(result, reaction_entry(job_types.CatchLiveFish)) + + -- Cutting, encrusting, and metal extraction. + local rock_types = df.global.world.raws.inorganics + for rock_id = #rock_types-1, 0, -1 do + local material = rock_types[rock_id].material + local rock_name = material.state_adj.Solid + if material.flags.IS_STONE or material.flags.IS_GEM then + table.insert(result, reaction_entry(job_types.CutGems, { + mat_type = 0, + mat_index = rock_id, + }, "Cut "..rock_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGems, { + mat_type = 0, + mat_index = rock_id, + item_category = {finished_goods = true}, + }, "Encrust Finished Goods With "..rock_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGems, { + mat_type = 0, + mat_index = rock_id, + item_category = {furniture = true}, + }, "Encrust Furniture With "..rock_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGems, { + mat_type = 0, + mat_index = rock_id, + item_category = {ammo = true}, + }, "Encrust Ammo With "..rock_name)) + end + + if #rock_types[rock_id].metal_ore.mat_index > 0 then + table.insert(result, reaction_entry(job_types.SmeltOre, {mat_type = 0, mat_index = rock_id}, "Smelt "..rock_name.." Ore")) + end + + if #rock_types[rock_id].thread_metal.mat_index > 0 then + table.insert(result, reaction_entry(job_types.ExtractMetalStrands, {mat_type = 0, mat_index = rock_id})) + end + end + + -- Glass cutting and encrusting, with different job numbers. + -- We could search the entire table, but glass is less subject to raws. + local glass_types = df.global.world.raws.mat_table.builtin + local glasses = {} + for glass_id = 3, 5 do + local material = glass_types[glass_id] + local glass_name = material.state_adj.Solid + if material.flags.IS_GLASS then + -- For future use. + table.insert(glasses, { + adjective = glass_name, + management = {mat_type = glass_id}, + }) + + table.insert(result, reaction_entry(job_types.CutGlass, {mat_type = glass_id}, "Cut "..glass_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGlass, { + mat_type = glass_id, + item_category = {finished_goods = true}, + }, "Encrust Finished Goods With "..glass_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGlass, { + mat_type = glass_id, + item_category = {furniture = true}, + }, "Encrust Furniture With "..glass_name)) + + table.insert(result, reaction_entry(job_types.EncrustWithGlass, { + mat_type = glass_id, + item_category = {ammo = true}, + }, "Encrust Ammo With "..glass_name)) + end + end + + -- Dyeing + table.insert(result, reaction_entry(job_types.DyeThread)) + table.insert(result, reaction_entry(job_types.DyeCloth)) + + -- Sew Image + cloth_mats = {materials.cloth, materials.silk, materials.yarn, materials.leather} + for _, material in ipairs(cloth_mats) do + material_reactions(result, {{job_types.SewImage, "Sew", "Image"}}, material) + end + + for _, spec in ipairs{materials.bone, materials.shell, materials.tooth, materials.horn, materials.pearl} do + material_reactions(result, {{job_types.DecorateWith, "Decorate With"}}, spec) + end + + table.insert(result, reaction_entry(job_types.MakeTotem)) + table.insert(result, reaction_entry(job_types.ButcherAnimal)) + table.insert(result, reaction_entry(job_types.MillPlants)) + table.insert(result, reaction_entry(job_types.MakePotashFromLye)) + table.insert(result, reaction_entry(job_types.MakePotashFromAsh)) + + -- Kitchen + table.insert(result, reaction_entry(job_types.PrepareMeal, {mat_type = 2}, "Prepare Easy Meal")) + table.insert(result, reaction_entry(job_types.PrepareMeal, {mat_type = 3}, "Prepare Fine Meal")) + table.insert(result, reaction_entry(job_types.PrepareMeal, {mat_type = 4}, "Prepare Lavish Meal")) + + -- Brew Drink + table.insert(result, reaction_entry(job_types.BrewDrink)) + + -- Weaving + table.insert(result, reaction_entry(job_types.WeaveCloth, {material_category = {plant = true}}, "Weave Thread into Cloth")) + table.insert(result, reaction_entry(job_types.WeaveCloth, {material_category = {silk = true}}, "Weave Thread into Silk")) + table.insert(result, reaction_entry(job_types.WeaveCloth, {material_category = {yarn = true}}, "Weave Yarn into Cloth")) + + -- Extracts, farmer's workshop, and wood burning + table.insert(result, reaction_entry(job_types.ExtractFromPlants)) + table.insert(result, reaction_entry(job_types.ExtractFromRawFish)) + table.insert(result, reaction_entry(job_types.ExtractFromLandAnimal)) + table.insert(result, reaction_entry(job_types.PrepareRawFish)) + table.insert(result, reaction_entry(job_types.MakeCheese)) + table.insert(result, reaction_entry(job_types.MilkCreature)) + table.insert(result, reaction_entry(job_types.ShearCreature)) + table.insert(result, reaction_entry(job_types.SpinThread)) + table.insert(result, reaction_entry(job_types.MakeLye)) + table.insert(result, reaction_entry(job_types.ProcessPlants)) + table.insert(result, reaction_entry(job_types.ProcessPlantsBag)) + table.insert(result, reaction_entry(job_types.ProcessPlantsVial)) + table.insert(result, reaction_entry(job_types.ProcessPlantsBarrel)) + table.insert(result, reaction_entry(job_types.MakeCharcoal)) + table.insert(result, reaction_entry(job_types.MakeAsh)) + + -- Reactions defined in the raws. + -- Not all reactions are allowed to the civilization. + -- That includes "Make sharp rock" by default. + local entity = df.historical_entity.find(df.global.ui.civ_id) + for _, reaction_id in ipairs(entity.entity_raw.workshops.permitted_reaction_id) do + local reaction = df.global.world.raws.reactions[reaction_id] + local name = string.gsub(reaction.name, "^.", string.upper) + table.insert(result, reaction_entry(job_types.CustomReaction, {reaction_name = reaction.code}, name)) + end + + -- Metal forging + local itemdefs = df.global.world.raws.itemdefs + for rock_id = 0, #rock_types - 1 do + local material = rock_types[rock_id].material + local rock_name = material.state_adj.Solid + local mat_flags = { + adjective = rock_name, + management = {mat_type = 0, mat_index = rock_id}, + verb = "Forge", + } + + if material.flags.IS_METAL then + table.insert(result, reaction_entry(job_types.StudWith, mat_flags.management, "Stud With "..rock_name)) + + if material.flags.ITEMS_WEAPON then + -- Todo: Are these really the right flags to check? + resource_reactions(result, job_types.MakeWeapon, mat_flags, entity.resources.weapon_type, itemdefs.weapons, { + permissible = (function(itemdef) return itemdef.skill_ranged == -1 end), + }) + + -- Is this entirely disconnected from the entity? + material_reactions(result, {{MakeBallistaArrowHead, "Forge", "Ballista Arrow Head"}}, mat_flags) + + resource_reactions(result, job_types.MakeTrapComponent, mat_flags, entity.resources.trapcomp_type, itemdefs.trapcomps, { + adjective = true, + }) + + resource_reactions(result, job_types.AssembleSiegeAmmo, mat_flags, entity.resources.siegeammo_type, itemdefs.siege_ammo, { + verb = "Assemble", + }) + end + + if material.flags.ITEMS_WEAPON_RANGED then + resource_reactions(result, job_types.MakeWeapon, mat_flags, entity.resources.weapon_type, itemdefs.weapons, { + permissible = (function(itemdef) return itemdef.skill_ranged >= 0 end), + }) + end + + if material.flags.ITEMS_DIGGER then + -- Todo: Ranged or training digging weapons? + resource_reactions(result, job_types.MakeWeapon, mat_flags, entity.resources.digger_type, itemdefs.weapons, { + }) + end + + if material.flags.ITEMS_AMMO then + resource_reactions(result, job_types.MakeAmmo, mat_flags, entity.resources.ammo_type, itemdefs.ammo, { + name_field = "name_plural", + }) + end + + if material.flags.ITEMS_ANVIL then + material_reactions(result, {{job_types.ForgeAnvil, "Forge", "Anvil"}}, mat_flags) + end + + if material.flags.ITEMS_ARMOR then + local metalclothing = (function(itemdef) return itemdef.props.flags.METAL end) + clothing_reactions(result, mat_flags, metalclothing) + resource_reactions(result, job_types.MakeShield, mat_flags, entity.resources.shield_type, itemdefs.shields, { + }) + end + + if material.flags.ITEMS_SOFT then + local metalclothing = (function(itemdef) return itemdef.props.flags.SOFT and not itemdef.props.flags.METAL end) + clothing_reactions(result, mat_flags, metalclothing) + end + + if material.flags.ITEMS_HARD then + resource_reactions(result, job_types.MakeTool, mat_flags, entity.resources.tool_type, itemdefs.tools, { + permissible = (function(itemdef) return itemdef.flags.HARD_MAT end), + capitalize = true, + }) + end + + if material.flags.ITEMS_METAL then + resource_reactions(result, job_types.MakeTool, mat_flags, entity.resources.tool_type, itemdefs.tools, { + permissible = (function(itemdef) return itemdef.flags.METAL_MAT end), + capitalize = true, + }) + end + + if material.flags.ITEMS_HARD then + material_reactions(result, { + {job_types.ConstructDoor, "Construct", "Door"}, + {job_types.ConstructFloodgate, "Construct", "Floodgate"}, + {job_types.ConstructHatchCover, "Construct", "Hatch Cover"}, + {job_types.ConstructGrate, "Construct", "Grate"}, + {job_types.ConstructThrone, "Construct", "Throne"}, + {job_types.ConstructCoffin, "Construct", "Sarcophagus"}, + {job_types.ConstructTable, "Construct", "Table"}, + {job_types.ConstructSplint, "Construct", "Splint"}, + {job_types.ConstructCrutch, "Construct", "Crutch"}, + {job_types.ConstructArmorStand, "Construct", "Armor Stand"}, + {job_types.ConstructWeaponRack, "Construct", "Weapon Rack"}, + {job_types.ConstructCabinet, "Construct", "Cabinet"}, + {job_types.MakeGoblet, "Forge", "Goblet"}, + {job_types.MakeInstrument, "Forge", "Instrument"}, + {job_types.MakeToy, "Forge", "Toy"}, + {job_types.ConstructStatue, "Construct", "Statue"}, + {job_types.ConstructBlocks, "Construct", "Blocks"}, + {job_types.MakeAnimalTrap, "Forge", "Animal Trap"}, + {job_types.MakeBarrel, "Forge", "Barrel"}, + {job_types.MakeBucket, "Forge", "Bucket"}, + {job_types.ConstructBin, "Construct", "Bin"}, + {job_types.MakePipeSection, "Forge", "Pipe Section"}, + {job_types.MakeCage, "Forge", "Cage"}, + {job_types.MintCoins, "Mint", "Coins"}, + {job_types.ConstructChest, "Construct", "Chest"}, + {job_types.MakeFlask, "Forge", "Flask"}, + {job_types.MakeChain, "Forge", "Chain"}, + {job_types.MakeCrafts, "Make", "Crafts"}, + }, mat_flags) + end + + if material.flags.ITEMS_SOFT then + material_reactions(result, { + {job_types.MakeBackpack, "Make", "Backpack"}, + {job_types.MakeQuiver, "Make", "Quiver"}, + {job_types.ConstructCatapultParts, "Construct", "Catapult Parts"}, + {job_types.ConstructBallistaParts, "Construct", "Ballista Parts"}, + }, mat_flags) + end + end + end + + -- Traction Bench + table.insert(result, reaction_entry(job_types.ConstructTractionBench)) + + -- Non-metal weapons + resource_reactions(result, job_types.MakeWeapon, materials.wood, entity.resources.weapon_type, itemdefs.weapons, { + permissible = (function(itemdef) return itemdef.skill_ranged >= 0 end), + }) + + resource_reactions(result, job_types.MakeWeapon, materials.wood, entity.resources.training_weapon_type, itemdefs.weapons, { + }) + + resource_reactions(result, job_types.MakeWeapon, materials.bone, entity.resources.weapon_type, itemdefs.weapons, { + permissible = (function(itemdef) return itemdef.skill_ranged >= 0 end), + }) + + resource_reactions(result, job_types.MakeWeapon, materials.rock, entity.resources.weapon_type, itemdefs.weapons, { + permissible = (function(itemdef) return itemdef.flags.CAN_STONE end), + }) + + -- Wooden items + -- Closely related to the ITEMS_HARD list. + material_reactions(result, { + {job_types.ConstructDoor, "Construct", "Door"}, + {job_types.ConstructFloodgate, "Construct", "Floodgate"}, + {job_types.ConstructHatchCover, "Construct", "Hatch Cover"}, + {job_types.ConstructGrate, "Construct", "Grate"}, + {job_types.ConstructThrone, "Construct", "Chair"}, + {job_types.ConstructCoffin, "Construct", "Casket"}, + {job_types.ConstructTable, "Construct", "Table"}, + {job_types.ConstructArmorStand, "Construct", "Armor Stand"}, + {job_types.ConstructWeaponRack, "Construct", "Weapon Rack"}, + {job_types.ConstructCabinet, "Construct", "Cabinet"}, + {job_types.MakeGoblet, "Make", "Cup"}, + {job_types.MakeInstrument, "Make", "Instrument"}, + }, materials.wood) + + resource_reactions(result, job_types.MakeTool, materials.wood, entity.resources.tool_type, itemdefs.tools, { + -- permissible = (function(itemdef) return itemdef.flags.WOOD_MAT end), + capitalize = true, + }) + + material_reactions(result, { + {job_types.MakeToy, "Make", "Toy"}, + {job_types.ConstructBlocks, "Construct", "Blocks"}, + {job_types.ConstructSplint, "Construct", "Splint"}, + {job_types.ConstructCrutch, "Construct", "Crutch"}, + {job_types.MakeAnimalTrap, "Make", "Animal Trap"}, + {job_types.MakeBarrel, "Make", "Barrel"}, + {job_types.MakeBucket, "Make", "Bucket"}, + {job_types.ConstructBin, "Construct", "Bin"}, + {job_types.MakeCage, "Make", "Cage"}, + {job_types.MakePipeSection, "Make", "Pipe Section"}, + }, materials.wood) + + resource_reactions(result, job_types.MakeTrapComponent, materials.wood, entity.resources.trapcomp_type, itemdefs.trapcomps, { + permissible = (function(itemdef) return itemdef.flags.WOOD end), + adjective = true, + }) + + -- Rock items + material_reactions(result, { + {job_types.ConstructDoor, "Construct", "Door"}, + {job_types.ConstructFloodgate, "Construct", "Floodgate"}, + {job_types.ConstructHatchCover, "Construct", "Hatch Cover"}, + {job_types.ConstructGrate, "Construct", "Grate"}, + {job_types.ConstructThrone, "Construct", "Throne"}, + {job_types.ConstructCoffin, "Construct", "Coffin"}, + {job_types.ConstructTable, "Construct", "Table"}, + {job_types.ConstructArmorStand, "Construct", "Armor Stand"}, + {job_types.ConstructWeaponRack, "Construct", "Weapon Rack"}, + {job_types.ConstructCabinet, "Construct", "Cabinet"}, + {job_types.MakeGoblet, "Make", "Mug"}, + {job_types.MakeInstrument, "Make", "Instrument"}, + }, materials.rock) + + resource_reactions(result, job_types.MakeTool, materials.rock, entity.resources.tool_type, itemdefs.tools, { + permissible = (function(itemdef) return itemdef.flags.HARD_MAT end), + capitalize = true, + }) + + material_reactions(result, { + {job_types.MakeToy, "Make", "Toy"}, + {job_types.ConstructQuern, "Construct", "Quern"}, + {job_types.ConstructMillstone, "Construct", "Millstone"}, + {job_types.ConstructSlab, "Construct", "Slab"}, + {job_types.ConstructStatue, "Construct", "Statue"}, + {job_types.ConstructBlocks, "Construct", "Blocks"}, + }, materials.rock) + + -- Glass items + for _, mat_info in ipairs(glasses) do + material_reactions(result, { + {job_types.ConstructDoor, "Construct", "Portal"}, + {job_types.ConstructFloodgate, "Construct", "Floodgate"}, + {job_types.ConstructHatchCover, "Construct", "Hatch Cover"}, + {job_types.ConstructGrate, "Construct", "Grate"}, + {job_types.ConstructThrone, "Construct", "Throne"}, + {job_types.ConstructCoffin, "Construct", "Coffin"}, + {job_types.ConstructTable, "Construct", "Table"}, + {job_types.ConstructArmorStand, "Construct", "Armor Stand"}, + {job_types.ConstructWeaponRack, "Construct", "Weapon Rack"}, + {job_types.ConstructCabinet, "Construct", "Cabinet"}, + {job_types.MakeGoblet, "Make", "Goblet"}, + {job_types.MakeInstrument, "Make", "Instrument"}, + }, mat_info) + + resource_reactions(result, job_types.MakeTool, mat_info, entity.resources.tool_type, itemdefs.tools, { + permissible = (function(itemdef) return itemdef.flags.HARD_MAT end), + capitalize = true, + }) + + material_reactions(result, { + {job_types.MakeToy, "Make", "Toy"}, + {job_types.ConstructStatue, "Construct", "Statue"}, + {job_types.ConstructBlocks, "Construct", "Blocks"}, + {job_types.MakeCage, "Make", "Terrarium"}, + {job_types.MakePipeSection, "Make", "Tube"}, + }, mat_info) + + resource_reactions(result, job_types.MakeTrapComponent, mat_info, entity.resources.trapcomp_type, itemdefs.trapcomps, { + adjective = true, + }) + end + + -- Bed, specified as wooden. + table.insert(result, reaction_entry(job_types.ConstructBed, materials.wood.management)) + + -- Windows + for _, mat_info in ipairs(glasses) do + material_reactions(result, { + {job_types.MakeWindow, "Make", "Window"}, + }, mat_info) + end + + -- Rock Mechanisms + table.insert(result, reaction_entry(job_types.ConstructMechanisms, materials.rock.management)) + + resource_reactions(result, job_types.AssembleSiegeAmmo, materials.wood, entity.resources.siegeammo_type, itemdefs.siege_ammo, { + verb = "Assemble", + }) + + for _, mat_info in ipairs(glasses) do + material_reactions(result, { + {job_types.MakeRawGlass, "Make Raw", nil}, + }, mat_info) + end + + material_reactions(result, { + {job_types.MakeBackpack, "Make", "Backpack"}, + {job_types.MakeQuiver, "Make", "Quiver"}, + }, materials.leather) + + for _, material in ipairs(cloth_mats) do + clothing_reactions(result, material, (function(itemdef) return itemdef.props.flags[material.clothing_flag or "SOFT"] end)) + end + + -- Boxes, Bags, and Ropes + boxmats = { + {mats = {materials.wood}, box = "Chest"}, + {mats = {materials.rock}, box = "Coffer"}, + {mats = glasses, box = "Box", flask = "Vial"}, + {mats = {materials.cloth}, box = "Bag", chain = "Rope"}, + {mats = {materials.leather}, box = "Bag", flask = "Waterskin"}, + {mats = {materials.silk, materials.yarn}, box = "Bag", chain = "Rope"}, + } + for _, boxmat in ipairs(boxmats) do + for _, mat in ipairs(boxmat.mats) do + material_reactions(result, {{job_types.ConstructChest, "Construct", boxmat.box}}, mat) + if boxmat.chain then + material_reactions(result, {{job_types.MakeChain, "Make", boxmat.chain}}, mat) + end + if boxmat.flask then + material_reactions(result, {{job_types.MakeFlask, "Make", boxmat.flask}}, mat) + end + end + end + + for _, mat in ipairs{ + materials.wood, + materials.rock, + materials.cloth, + materials.leather, + materials.shell, + materials.bone, + materials.silk, + materials.tooth, + materials.horn, + materials.pearl, + materials.yarn, + } do + material_reactions(result, {{job_types.MakeCrafts, "Make", "Crafts"}}, mat) + end + + -- Siege engine parts + table.insert(result, reaction_entry(job_types.ConstructCatapultParts, materials.wood.management)) + table.insert(result, reaction_entry(job_types.ConstructBallistaParts, materials.wood.management)) + + for _, mat in ipairs{materials.wood, materials.bone} do + resource_reactions(result, job_types.MakeAmmo, mat, entity.resources.ammo_type, itemdefs.ammo, { + name_field = "name_plural", + }) + end + + -- BARRED and SCALED as flag names don't quite seem to fit, here. + clothing_reactions(result, materials.bone, (function(itemdef) return itemdef.props.flags.BARRED end)) + clothing_reactions(result, materials.shell, (function(itemdef) return itemdef.props.flags.SCALED end)) + + for _, mat in ipairs{materials.wood, materials.leather} do + resource_reactions(result, job_types.MakeShield, mat, entity.resources.shield_type, itemdefs.shields, {}) + end + + -- Melt a Metal Object + table.insert(result, reaction_entry(job_types.MeltMetalObject)) + + return result +end + +screen = gui.FramedScreen { + frame_title = "Select Stockpile Order", +} + +function screen:onRenderBody(dc) + -- Emulates the built-in manager screen. + dc:seek(1, 1):string("Type in parts of the name to narrow your search. ", COLOR_WHITE) + dc:string(gui.getKeyDisplay("LEAVESCREEN"), COLOR_LIGHTGREEN) + dc:string(" to abort.", COLOR_WHITE) + dc:seek(1, PageSize + 5):string(self.search_string, COLOR_LIGHTCYAN) + for _, item in ipairs(self.displayed) do + dc:seek(item.x, item.y):string(item.name, item.color) + end +end + +function screen:onInput(keys) + if keys.LEAVESCREEN then + self:dismiss() + elseif keys.SELECT then + self:dismiss() + local selected = self.reactions[self.position] + if selected then + store_order(self.stockpile, selected.index) + end + elseif keys.STANDARDSCROLL_UP then + self.position = self.position - 1 + elseif keys.STANDARDSCROLL_DOWN then + self.position = self.position + 1 + elseif keys.STANDARDSCROLL_LEFT then + self.position = self.position - PageSize + elseif keys.STANDARDSCROLL_RIGHT then + self.position = self.position + PageSize + elseif keys.STANDARDSCROLL_PAGEUP then + -- Moves to the first item displayed on the new page, for some reason. + self.position = self.position - PageSize*2 - ((self.position-1) % (PageSize*2)) + elseif keys.STANDARDSCROLL_PAGEDOWN then + -- Moves to the first item displayed on the new page, for some reason. + self.position = self.position + PageSize*2 - ((self.position-1) % (PageSize*2)) + elseif keys.STRING_A000 then + -- This seems like an odd way to check for Backspace. + self.search_string = string.sub(self.search_string, 1, -2) + elseif keys._STRING and keys._STRING >= 32 then + -- This interface only accepts letters and spaces. + local char = string.char(keys._STRING) + if char == " " or string.find(char, "^%a") then + self.search_string = self.search_string .. string.upper(char) + end + end + + self:refilter() +end + +function screen:reset(stockpile) + self.stockpile = stockpile + self.search_string = "" + self.position = 1 + self:refilter() +end + +function matchall(haystack, needles) + for _, needle in ipairs(needles) do + if not string.find(haystack, needle) then + return false + end + end + + return true +end + +function splitstring(full, pattern) + local last = string.len(full) + local result = {} + local n = 1 + while n <= last do + local start, stop = string.find(full, pattern, n) + if not start then + result[#result+1] = string.sub(full, n) + break + elseif start > n then + result[#result+1] = string.sub(full, n, start - 1) + end + + if stop < n then + -- The pattern matches an empty string. + -- Avoid an infinite loop. + break + end + + n = stop + 1 + end + + return result +end + +function screen:refilter() + local filtered = {} + local needles = splitstring(self.search_string, " ") + for key, value in ipairs(reaction_list) do + if matchall(string.upper(value.name), needles) then + filtered[#filtered+1] = { + index = key, + name = value.name + } + end + end + + if self.position < 1 then + self.position = #filtered + elseif self.position > #filtered then + self.position = 1 + end + + local start = 1 + while self.position >= start + PageSize*2 do + start = start + PageSize*2 + end + + local displayed = {} + for n = 0, PageSize*2 - 1 do + local item = filtered[start + n] + if not item then + break + end + local name = item.name + + local x = 1 + local y = FirstRow + n + if n >= PageSize then + x = CenterCol + y = y - PageSize + name = " "..name + end + + local color = COLOR_CYAN + if start + n == self.position then + color = COLOR_LIGHTCYAN + end + + displayed[n + 1] = { + x = x, + y = y, + name = name, + color = color, + } + end + + self.reactions = filtered + self.displayed = displayed +end + +function store_order(stockpile, order_number) + local name = reaction_list[order_number].name + -- print("Setting stockpile #"..stockpile.stockpile_number.." to "..name.." (#"..order_number..")") + local saved = saved_orders[stockpile.id] + if saved then + saved.entry.value = name + saved.entry.ints[entry_ints.order_number] = order_number + saved.entry:save() + else + saved_orders[stockpile.id] = { + stockpile = stockpile, + entry = dfhack.persistent.save{ + key = "stockflow/entry/"..stockpile.id, + value = name, + ints = { + stockpile.id, + order_number, + 1, + }, + }, + } + end +end + +-- Compare the job specification of two orders. +function orders_match(a, b) + local fields = { + "job_type", + "item_subtype", + "reaction_name", + "mat_type", + "mat_index", + } + + for _, fieldname in ipairs(fields) do + if a[fieldname] ~= b[fieldname] then + return false + end + end + + local subtables = { + "item_category", + "material_category", + } + + for _, fieldname in ipairs(subtables) do + local aa = a[fieldname] + local bb = b[fieldname] + for key, value in ipairs(aa) do + if bb[key] ~= value then + return false + end + end + end + + return true +end + +-- Reduce the quantity by the number of matching orders in the queue. +function order_quantity(order, quantity) + local amount = quantity + for _, managed in ipairs(df.global.world.manager_orders) do + if orders_match(order, managed) then + amount = amount - managed.amount_left + if amount < 0 then + return 0 + end + end + end + + if amount > 30 then + -- Respect the quantity limit. + -- With this many in the queue, we can wait for the next cycle. + return 30 + end + + return amount +end + +-- Place a new copy of the order onto the manager's queue. +function create_orders(order, amount) + local new_order = order:new() + new_order.amount_left = amount + new_order.amount_total = amount + -- Todo: Create in a validated state if the fortress is small enough? + new_order.is_validated = 0 + df.global.world.manager_orders:insert('#', new_order) +end + +function findItemsAtTile(x, y, z) + -- There should be a faster and easier way to do this... + local found = {} + for _, item in ipairs(df.global.world.items.all) do + -- local ix, iy, iz = dfhack.items.getPosition(item) + if item.pos.x == x and item.pos.y == y and + item.pos.z == z and item.flags.on_ground then + found[#found+1] = item + end + end + + return found +end + +function countContents(container, settings) + local total = 0 + local blocking = false + for _, item in ipairs(dfhack.items.getContainedItems(container)) do + if item.flags.container then + -- Recursively count the total of items contained. + -- Not likely to go more than two levels deep. + local subtotal, subblocked = countContents(item, settings) + if subtotal > 0 then + -- Ignore the inner container itself; + -- generally, only the contained items matter. + total = total + subtotal + elseif subblocked then + blocking = true + elseif matches_stockpile(item, settings) then + -- The container may or may not be empty, + -- but is stockpiled as a container itself. + total = total + 1 + else + blocking = true + end + elseif matches_stockpile(item, settings) then + total = total + 1 + else + blocking = true + end + end + + return total, blocking +end + +function check_stockpiles(verbose) + local result = {} + for _, spec in pairs(saved_orders) do + local trigger = triggers[spec.entry.ints[entry_ints.trigger_number]] + if trigger and trigger.divisor then + local reaction = spec.entry.ints[entry_ints.order_number] + local filled, empty = check_pile(spec.stockpile, verbose) + local amount = trigger.filled and filled or empty + amount = (amount - (amount % trigger.divisor)) / trigger.divisor + result[reaction] = (result[reaction] or 0) + amount + end + end + + return result +end + +function check_pile(sp, verbose) + local numspaces = 0 + local filled = 0 + local empty = 0 + for y = sp.y1, sp.y2 do + for x = sp.x1, sp.x2 do + -- Sadly, the obvious check currently fails when y == sp.y2 + if dfhack.buildings.containsTile(sp, x, y) or + (y == sp.y2 and dfhack.buildings.findAtTile(x, y, sp.z) == sp) then + numspaces = numspaces + 1 + local designation, occupancy = dfhack.maps.getTileFlags(x, y, sp.z) + if not designation.liquid_type then + if not occupancy.item then + empty = empty + 1 + else + local item_count, blocked = count_pile_items(sp, x, y) + if item_count > 0 then + filled = filled + item_count + elseif not blocked then + empty = empty + 1 + end + end + end + end + end + end + + if verbose then + print("Stockpile #"..sp.stockpile_number, + string.format("%3d spaces", numspaces), + string.format("%4d items", filled), + string.format("%4d empty spaces", empty)) + end + + return filled, empty +end + +function count_pile_items(sp, x, y) + local item_count = 0 + local blocked = false + for _, item in ipairs(findItemsAtTile(x, y, sp.z)) do + if item:isAssignedToThisStockpile(sp.id) then + -- This is a bin or barrel associated with the stockpile. + -- If it's empty, it doesn't count as blocking the stockpile space. + -- Oddly, when empty, item.flags.container might be false. + local subtotal, subblocked = countContents(item, sp.settings) + item_count = item_count + subtotal + if subblocked then + blocked = true + end + elseif matches_stockpile(item, sp.settings) then + item_count = item_count + 1 + else + blocked = true + end + end + + return item_count, blocked +end + +function matches_stockpile(item, settings) + -- Check whether the item matches the stockpile. + -- FIXME: This is starting to look like a whole lot of work. + if df.item_barst:is_instance(item) then + return settings.flags.bars_blocks + elseif df.item_blocksst:is_instance(item) then + return settings.flags.bars_blocks + elseif df.item_smallgemst:is_instance(item) then + return settings.flags.gems + elseif df.item_boulderst:is_instance(item) then + return settings.flags.stone + elseif df.item_woodst:is_instance(item) then + return settings.flags.wood + elseif df.item_seedsst:is_instance(item) then + return settings.flags.food + elseif df.item_meatst:is_instance(item) then + return settings.flags.food + elseif df.item_plantst:is_instance(item) then + return settings.flags.food + elseif df.item_leavesst:is_instance(item) then + return settings.flags.food + elseif df.item_cheesest:is_instance(item) then + return settings.flags.food + elseif df.item_globst:is_instance(item) then + return settings.flags.food + elseif df.item_fishst:is_instance(item) then + return settings.flags.food + elseif df.item_fish_rawst:is_instance(item) then + return settings.flags.food + elseif df.item_foodst:is_instance(item) then + return settings.flags.food + elseif df.item_drinkst:is_instance(item) then + return settings.flags.food + elseif df.item_eggst:is_instance(item) then + return settings.flags.food + elseif df.item_skin_tannedst:is_instance(item) then + return settings.flags.leather + elseif df.item_remainsst:is_instance(item) then + return settings.flags.refuse + elseif df.item_verminst:is_instance(item) then + return settings.flags.animals + elseif df.item_petst:is_instance(item) then + return settings.flags.animals + elseif df.item_threadst:is_instance(item) then + return settings.flags.cloth + end + + return true +end + +return _ENV diff --git a/plugins/mousequery.cpp b/plugins/mousequery.cpp index 9cc6bb783..0fe337017 100644 --- a/plugins/mousequery.cpp +++ b/plugins/mousequery.cpp @@ -28,7 +28,7 @@ using namespace df::enums::ui_sidebar_mode; DFHACK_PLUGIN("mousequery"); -#define PLUGIN_VERSION 0.17 +#define PLUGIN_VERSION 0.18 static int32_t last_clicked_x, last_clicked_y, last_clicked_z; static int32_t last_pos_x, last_pos_y, last_pos_z; @@ -539,6 +539,13 @@ struct mousequery_hook : public df::viewscreen_dwarfmodest if (mx < 1 || mx > right_margin - 2 || my < 1 || my > gps->dimy - 2) mpos_valid = false; + // Check if in lever binding mode + if (Gui::getFocusString(Core::getTopViewscreen()) == + "dwarfmode/QueryBuilding/Some/Lever/AddJob") + { + return; + } + if (mpos_valid) { if (mpos.x != last_move_pos.x || mpos.y != last_move_pos.y || mpos.z != last_move_pos.z) diff --git a/plugins/reveal.cpp b/plugins/reveal.cpp index 91ab75686..9bd63e47e 100644 --- a/plugins/reveal.cpp +++ b/plugins/reveal.cpp @@ -449,22 +449,22 @@ command_result revflood(color_ostream &out, vector & params) } if(sides) { - flood.push(foo(DFCoord(current.x + 1, current.y ,current.z),0)); - flood.push(foo(DFCoord(current.x + 1, current.y + 1 ,current.z),0)); - flood.push(foo(DFCoord(current.x, current.y + 1 ,current.z),0)); - flood.push(foo(DFCoord(current.x - 1, current.y + 1 ,current.z),0)); - flood.push(foo(DFCoord(current.x - 1, current.y ,current.z),0)); - flood.push(foo(DFCoord(current.x - 1, current.y - 1 ,current.z),0)); - flood.push(foo(DFCoord(current.x, current.y - 1 ,current.z),0)); - flood.push(foo(DFCoord(current.x + 1, current.y - 1 ,current.z),0)); + flood.push(foo(DFCoord(current.x + 1, current.y ,current.z),false)); + flood.push(foo(DFCoord(current.x + 1, current.y + 1 ,current.z),false)); + flood.push(foo(DFCoord(current.x, current.y + 1 ,current.z),false)); + flood.push(foo(DFCoord(current.x - 1, current.y + 1 ,current.z),false)); + flood.push(foo(DFCoord(current.x - 1, current.y ,current.z),false)); + flood.push(foo(DFCoord(current.x - 1, current.y - 1 ,current.z),false)); + flood.push(foo(DFCoord(current.x, current.y - 1 ,current.z),false)); + flood.push(foo(DFCoord(current.x + 1, current.y - 1 ,current.z),false)); } if(above) { - flood.push(foo(DFCoord(current.x, current.y ,current.z + 1),1)); + flood.push(foo(DFCoord(current.x, current.y ,current.z + 1),true)); } if(below) { - flood.push(foo(DFCoord(current.x, current.y ,current.z - 1),0)); + flood.push(foo(DFCoord(current.x, current.y ,current.z - 1),false)); } } MCache->WriteAll(); diff --git a/plugins/ruby/ruby.rb b/plugins/ruby/ruby.rb index 47924dcdf..edce8ac84 100644 --- a/plugins/ruby/ruby.rb +++ b/plugins/ruby/ruby.rb @@ -210,9 +210,17 @@ module DFHack out.last << wl.words[name.words[1]].forms[name.parts_of_speech[1]] if name.words[1] >= 0 end if name.words[5] >= 0 - out << 'the ' + out << 'the' out.last.capitalize! if out.length == 1 - (2..5).each { |i| out.last << wl.words[name.words[i]].forms[name.parts_of_speech[i]] if name.words[i] >= 0 } + out << wl.words[name.words[2]].forms[name.parts_of_speech[2]] if name.words[2] >= 0 + out << wl.words[name.words[3]].forms[name.parts_of_speech[3]] if name.words[3] >= 0 + if name.words[4] >= 0 + out << wl.words[name.words[4]].forms[name.parts_of_speech[4]] + out.last << '-' + else + out << '' + end + out.last << wl.words[name.words[5]].forms[name.parts_of_speech[5]] end if name.words[6] >= 0 out << 'of' diff --git a/plugins/search.cpp b/plugins/search.cpp index e0213bf06..72001275c 100644 --- a/plugins/search.cpp +++ b/plugins/search.cpp @@ -180,6 +180,10 @@ public: { // Query typing mode + if (input->empty()) + { + return false; + } df::interface_key last_token = *input->rbegin(); if (last_token >= interface_key::STRING_A032 && last_token <= interface_key::STRING_A126) { diff --git a/plugins/stockflow.cpp b/plugins/stockflow.cpp new file mode 100644 index 000000000..adff25a04 --- /dev/null +++ b/plugins/stockflow.cpp @@ -0,0 +1,393 @@ +/* + * Stockflow plugin. + * For best effect, place "stockflow enable" in your dfhack.init configuration, + * or set AUTOENABLE to true. + */ + +#include "uicommon.h" +#include "LuaTools.h" + +#include "df/building_stockpilest.h" +#include "df/job.h" +#include "df/viewscreen_dwarfmodest.h" + +#include "modules/Gui.h" +#include "modules/Maps.h" +#include "modules/World.h" + +using namespace DFHack; +using namespace std; + +using df::global::world; +using df::global::ui; +using df::building_stockpilest; + +DFHACK_PLUGIN("stockflow"); + +#define AUTOENABLE false +#ifdef DFHACK_PLUGIN_IS_ENABLED +DFHACK_PLUGIN_IS_ENABLED(enabled); +#else +bool enabled = false; +#endif + +const char *tagline = "Allows the fortress bookkeeper to queue jobs through the manager."; +const char *usage = ( + " stockflow enable\n" + " Enable the plugin.\n" + " stockflow disable\n" + " Disable the plugin.\n" + " stockflow list\n" + " List any work order settings for your stockpiles.\n" + " stockflow status\n" + " Display whether the plugin is enabled.\n" + "\n" + "While enabled, the 'q' menu of each stockpile will have two new options:\n" + " j: Select a job to order, from an interface like the manager's screen.\n" + " J: Cycle between several options for how many such jobs to order.\n" + "\n" + "Whenever the bookkeeper updates stockpile records, new work orders will\n" + "be placed on the manager's queue for each such selection, reduced by the\n" + "number of identical orders already in the queue.\n" +); + +/* + * Lua interface. + * Currently calls out to Lua functions, but never back in. + */ +class LuaHelper { +public: + void cycle(color_ostream &out) { + bool found = false; + for (df::job_list_link* link = &df::global::world->job_list; link != NULL; link = link->next) { + if (link->item == NULL) continue; + if (link->item->job_type == job_type::UpdateStockpileRecords) { + found = true; + break; + } + } + + if (found && !bookkeeping) { + command_method("start_bookkeeping", out); + bookkeeping = true; + } else if (bookkeeping && !found) { + command_method("finish_bookkeeping", out); + bookkeeping = false; + } + } + + void init() { + stockpile_id = -1; + initialized = false; + bookkeeping = false; + } + + bool reset(color_ostream &out, bool load) { + stockpile_id = -1; + bookkeeping = false; + if (load) { + return initialized = command_method("initialize_world", out); + } else if (initialized) { + initialized = false; + return command_method("clear_caches", out); + } + + return true; + } + + bool command_method(const char *method, color_ostream &out) { + // Calls a lua function with no parameters. + + // Suspension is required for "stockflow enable" from the command line, + // but may be overkill for other situations. + CoreSuspender suspend; + + auto L = Lua::Core::State; + Lua::StackUnwinder top(L); + + if (!lua_checkstack(L, 1)) + return false; + + if (!Lua::PushModulePublic(out, L, "plugins.stockflow", method)) + return false; + + if (!Lua::SafeCall(out, L, 0, 0)) + return false; + + return true; + } + + bool stockpile_method(const char *method, building_stockpilest *sp) { + // Combines the select_order and toggle_trigger method calls, + // because they share the same signature. + CoreSuspendClaimer suspend; + + auto L = Lua::Core::State; + color_ostream_proxy out(Core::getInstance().getConsole()); + + Lua::StackUnwinder top(L); + + if (!lua_checkstack(L, 2)) + return false; + + if (!Lua::PushModulePublic(out, L, "plugins.stockflow", method)) + return false; + + Lua::Push(L, sp); + + if (!Lua::SafeCall(out, L, 1, 0)) + return false; + + // Invalidate the string cache. + stockpile_id = -1; + + return true; + } + + bool collect_settings(building_stockpilest *sp) { + // Find strings representing the job to order, and the trigger condition. + // There might be a memory leak here; C++ is odd like that. + auto L = Lua::Core::State; + color_ostream_proxy out(Core::getInstance().getConsole()); + + CoreSuspendClaimer suspend; + Lua::StackUnwinder top(L); + + if (!lua_checkstack(L, 2)) + return false; + + if (!Lua::PushModulePublic(out, L, "plugins.stockflow", "stockpile_settings")) + return false; + + Lua::Push(L, sp); + + if (!Lua::SafeCall(out, L, 1, 2)) + return false; + + if (!lua_isstring(L, -1)) + return false; + + current_trigger = lua_tostring(L, -1); + lua_pop(L, 1); + + if (!lua_isstring(L, -1)) + return false; + + current_job = lua_tostring(L, -1); + lua_pop(L, 1); + + stockpile_id = sp->id; + + return true; + } + + void draw(building_stockpilest *sp) { + if (sp->id != stockpile_id) { + if (!collect_settings(sp)) { + Core::printerr("Stockflow job collection failed!\n"); + return; + } + } + + auto dims = Gui::getDwarfmodeViewDims(); + int left_margin = dims.menu_x1 + 1; + int x = left_margin; + int y = 14; + + OutputHotkeyString(x, y, current_job, "j", true, left_margin, COLOR_WHITE, COLOR_LIGHTRED); + if (*current_trigger) + OutputHotkeyString(x, y, current_trigger, " J", true, left_margin, COLOR_WHITE, COLOR_LIGHTRED); + } + + +private: + long stockpile_id; + bool initialized; + bool bookkeeping; + const char *current_job; + const char *current_trigger; +}; + +static LuaHelper helper; + +#define DELTA_TICKS 600 + +DFhackCExport command_result plugin_onupdate(color_ostream &out) { + if (!enabled) + return CR_OK; + + 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; + + helper.cycle(out); + + return CR_OK; +} + + +/* + * Interface hooks + */ +struct stockflow_hook : public df::viewscreen_dwarfmodest { + typedef df::viewscreen_dwarfmodest interpose_base; + + bool handleInput(set & parameters) { + bool desired = enabled; + if (parameters.size() == 1) { + if (parameters[0] == "enable" || parameters[0] == "on" || parameters[0] == "1") { + desired = true; + } else if (parameters[0] == "disable" || parameters[0] == "off" || parameters[0] == "0") { + desired = false; + } else if (parameters[0] == "usage" || parameters[0] == "help" || parameters[0] == "?") { + out.print("%s: %s\nUsage:\n%s", name, tagline, usage); + return CR_OK; + } else if (parameters[0] == "list") { + if (!enabled) { + out.printerr("Stockflow is not currently enabled.\n"); + return CR_FAILURE; + } + + if (!Maps::IsValid()) { + out.printerr("You haven't loaded a map yet.\n"); + return CR_FAILURE; + } + + // Tell Lua to list any saved stockpile orders. + return helper.command_method("list_orders", out)? CR_OK: CR_FAILURE; + } else if (parameters[0] != "status") { + return CR_WRONG_USAGE; + } + } else if (parameters.size() > 1) { + return CR_WRONG_USAGE; + } + + if (desired != enabled) { + if (!apply_hooks(out, desired)) { + return CR_FAILURE; + } + } + + out.print("Stockflow is %s %s.\n", (desired == enabled)? "currently": "now", desired? "enabled": "disabled"); + enabled = desired; + return CR_OK; +} + + +DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) { + if (event == DFHack::SC_MAP_LOADED) { + if (!helper.reset(out, enabled)) { + out.printerr("Could not load stockflow world data!\n"); + return CR_FAILURE; + } + } else if (event == DFHack::SC_MAP_UNLOADED) { + if (!helper.reset(out, false)) { + out.printerr("Could not unload stockflow world data!\n"); + return CR_FAILURE; + } + } + + return CR_OK; +} + +DFhackCExport command_result plugin_enable(color_ostream& out, bool enable) { + /* Accept the "enable stockflow"/"disable stockflow" syntax, where available. */ + /* Same as "stockflow enable"/"stockflow disable" except without the status line. */ + if (enable != enabled) { + if (!apply_hooks(out, enable)) { + return CR_FAILURE; + } + + enabled = enable; + } + + return CR_OK; +} + +DFhackCExport command_result plugin_init(color_ostream &out, std::vector &commands) { + helper.init(); + if (AUTOENABLE) { + if (!apply_hooks(out, true)) { + return CR_FAILURE; + } + + enabled = true; + } + + commands.push_back(PluginCommand(name, tagline, stockflow_cmd, false, usage)); + return CR_OK; +} + +DFhackCExport command_result plugin_shutdown(color_ostream &out) { + return plugin_enable(out, false); +} diff --git a/plugins/strangemood.cpp b/plugins/strangemood.cpp index 35d1e15b8..81840b67b 100644 --- a/plugins/strangemood.cpp +++ b/plugins/strangemood.cpp @@ -126,7 +126,7 @@ int getCreatedMetalBars (int32_t idx) return 0; } -void selectWord (const df::world_raws::T_language::T_word_table &table, int32_t &word, df::enum_field
- Siege Engine