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

update docs for workNow

develop
myk002 2022-07-31 13:32:06 -07:00
parent e4c5b14670
commit 6686f703ae
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/plugins/workNow.rst
Unescape Escape View File

@ -1,12 +1,19 @@
workNow
=======
Don't allow dwarves to idle if any jobs are available.
Tags:
:dfhack-keybind:`workNow`
When workNow is active, every time the game pauses, DF will make dwarves
perform any appropriate available jobs. This includes when you one step
through the game using the pause menu. Usage:
Reduce the time that dwarves idle after completing a job. After finishing a job,
dwarves will wander away for a while before picking up a new job. This plugin
will automatically poke the game to assign dwarves to new tasks.
:workNow: print workNow status
:workNow 0: deactivate workNow
:workNow 1: activate workNow (look for jobs on pause, and only then)
:workNow 2: make dwarves look for jobs whenever a job completes
Usage:
``workNow``
Print current plugin status.
``workNow 0``
Stop monitoring and poking.
``workNow 1``
Poke the game to assign dwarves to tasks whenever the game is paused.
``workNow 2``
Poke the game to assign dwarves to tasks whenever a dwarf finishes a job.

14
plugins/workNow.cpp
Unescape Escape View File

@ -29,16 +29,10 @@ DFhackCExport command_result plugin_init(color_ostream& out, std::vector<PluginC
if (!process_jobs || !process_dig)
return CR_FAILURE;
commands.push_back(PluginCommand("workNow", "Don't allow dwarves to idle if any jobs are available", workNow, false, "When workNow is active, every time the game pauses, DF will make dwarves perform any appropriate available jobs. This includes when you one step through the game using the pause menu. When workNow is in mode 2, it will make dwarves look for jobs every time a job completes.\n"
"workNow\n"
" print workNow status\n"
"workNow 0\n"
" deactivate workNow\n"
"workNow 1\n"
" activate workNow (look for jobs on pause, and only then)\n"
"workNow 2\n"
" make dwarves look for jobs whenever a job completes\n"
));
commands.push_back(PluginCommand(
"workNow",
"Reduce the time that dwarves idle after completing a job.",
workNow));
return CR_OK;
}