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

update docs for fastdwarf

develop
myk002 2022-07-25 10:22:23 -07:00
parent a6cb79c237
commit 989befa582
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 38 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/plugins/fastdwarf.rst
Unescape Escape View File

@ -1,14 +1,36 @@
fastdwarf fastdwarf
========= =========
Controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly Tags:
and perform tasks quickly. Teledwarf makes dwarves move instantaneously, :dfhack-keybind:`fastdwarf`
but do jobs at the same speed.
Dwarves teleport and/or finish jobs instantly.
:fastdwarf 0: disables both (also ``0 0``)
:fastdwarf 1: enables speedydwarf and disables teledwarf (also ``1 0``) Usage:
:fastdwarf 2: sets a native debug flag in the game memory that implements an
even more aggressive version of speedydwarf. ``enable fastdwarf``
:fastdwarf 0 1: disables speedydwarf and enables teledwarf Enable the plugin.
:fastdwarf 1 1: enables both ``fastdwarf <speed mode> [<tele mode>]``
See `superdwarf` for a per-creature version. Examples
--------
``fastdwarf 1``
Make all your dwarves move and work at maximum speed.
``fastdwarf 1 1``
In addition to working at maximum speed, dwarves also teleport to their
destinations.
Options
-------
Speed modes:
:0: Dwarves move and work at normal rates.
:1: Dwarves move and work at maximum speed.
:2: ALL units move (and work) at maximum speed, including creatures and
hostiles.
Tele modes:
:0: No teleportation.
:1: Dwarves teleport to their destinations.

18
plugins/fastdwarf.cpp
Unescape Escape View File

@ -224,20 +224,10 @@ DFhackCExport command_result plugin_enable ( color_ostream &out, bool enable )
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand("fastdwarf", commands.push_back(PluginCommand(
"let dwarves teleport and/or finish jobs instantly", "fastdwarf",
fastdwarf, false, "Dwarves teleport and/or finish jobs instantly.",
"fastdwarf: make dwarves faster.\n" fastdwarf));
"Usage:\n"
" fastdwarf <speed> (tele)\n"
"Valid values for speed:\n"
" * 0 - Make dwarves move and work at standard speed.\n"
" * 1 - Make dwarves move and work at maximum speed.\n"
" * 2 - Make ALL creatures move and work at maximum speed.\n"
"Valid values for (tele):\n"
" * 0 - Disable dwarf teleportation (default)\n"
" * 1 - Make dwarves teleport to their destinations instantly.\n"
));
return CR_OK; return CR_OK;
} }