MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documenting the new Stockflow option.

develop
Eric Wald 2014-08-03 16:40:03 -06:00
parent 1aba6a6739
commit 19133ff327
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Readme.rst
Unescape Escape View File

@ -1486,12 +1486,15 @@ Usage:
Enable the plugin. Enable the plugin.
``stockflow disable`` ``stockflow disable``
Disable the plugin. Disable the plugin.
``stockflow fast``
Enable the plugin in fast mode.
``stockflow list`` ``stockflow list``
List any work order settings for your stockpiles. List any work order settings for your stockpiles.
``stockflow status`` ``stockflow status``
Display whether the plugin is enabled. Display whether the plugin is enabled.
While enabled, the 'q' menu of each stockpile will have two new options: 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: 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. * J: Cycle between several options for how many such jobs to order.
@ -1499,6 +1502,9 @@ Whenever the bookkeeper updates stockpile records, new work orders will
be placed on the manager's queue for each such selection, reduced by the be placed on the manager's queue for each such selection, reduced by the
number of identical orders already in the queue. number of identical orders already in the queue.
In fast mode, new work orders will be enqueued once per day, instead of
waiting for the bookkeeper.
workflow workflow
-------- --------
Manage control of repeat jobs. Manage control of repeat jobs.

7
plugins/stockflow.cpp
Unescape Escape View File

@ -38,6 +38,8 @@ const char *usage = (
" Enable the plugin.\n" " Enable the plugin.\n"
" stockflow disable\n" " stockflow disable\n"
" Disable the plugin.\n" " Disable the plugin.\n"
" stockflow fast\n"
" Enable the plugin in fast mode.\n"
" stockflow list\n" " stockflow list\n"
" List any work order settings for your stockpiles.\n" " List any work order settings for your stockpiles.\n"
" stockflow status\n" " stockflow status\n"
@ -50,6 +52,9 @@ const char *usage = (
"Whenever the bookkeeper updates stockpile records, new work orders will\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" "be placed on the manager's queue for each such selection, reduced by the\n"
"number of identical orders already in the queue.\n" "number of identical orders already in the queue.\n"
"\n"
"In fast mode, new work orders will be enqueued once per day, instead of\n"
"waiting for the bookkeeper.\n"
); );
/* /*
@ -352,7 +357,7 @@ static command_result stockflow_cmd(color_ostream &out, vector <string> & parame
} }
} }
out.print("Stockflow is %s %s.\n", (desired == enabled)? "currently": "now", desired? "enabled": "disabled"); out.print("Stockflow is %s %s%s.\n", (desired == enabled)? "currently": "now", desired? "enabled": "disabled", fast? ", in fast mode": "");
enabled = desired; enabled = desired;
return CR_OK; return CR_OK;
} }