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

update docs for reveal

develop
myk002 2022-07-29 17:12:15 -07:00
parent c6d5fcb378
commit 438293c0a0
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 59 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/plugins/reveal.rst
Unescape Escape View File

@ -2,29 +2,41 @@
reveal reveal
====== ======
This reveals the map. By default, HFS will remain hidden so that the demons Tags:
don't spawn. You can use ``reveal hell`` to reveal everything. With hell revealed, :dfhack-keybind:`reveal`
you won't be able to unpause until you hide the map again. If you really want :dfhack-keybind:`unreveal`
to unpause with hell revealed, use ``reveal demons``. :dfhack-keybind:`revforget`
:dfhack-keybind:`revtoggle`
:dfhack-keybind:`revflood`
:dfhack-keybind:`nopause`
Reveal also works in adventure mode, but any of its effects are negated once Reveals the map. This reveals all z-layers in fort mode. It also works in
you move. When you use it this way, you don't need to run ``unreveal``. adventure mode, but any of its effects are negated once you move. When you use
it this way, you don't need to run ``unreveal`` to hide the map again.
Usage and related commands: Usage:
:reveal: Reveal the whole map, except for HFS to avoid demons spawning ``reveal [hell|demon]``
:reveal hell: Also show hell, but requires ``unreveal`` before unpausing Reveal the whole map. If ``hell`` is specified, also reveal HFS areas, but
:reveal demon: Reveals everything and allows unpausing - good luck! you are required to run ``unreveal`` before unpausing is allowed in order
:unreveal: Reverts the effects of ``reveal`` to prevent the demons from spawning. If you really want to unpause with hell
:revtoggle: Switches between ``reveal`` and ``unreveal`` revealed, specify ``demon`` instead of ``hell``.
:revflood: Hide everything, then reveal tiles with a path to the cursor. ``unreveal``
Note that tiles behind constructed walls are also revealed as a Reverts the effects of ``reveal``.
workaround for :bug:`1871`. ``revtoggle``
:revforget: Discard info about what was visible before revealing the map. Switches between ``reveal`` and ``unreveal``. Convenient to bind to a
Only useful where (e.g.) you abandoned with the fort revealed hotkey.
and no longer want the data. ``revforget``
Discard info about what was visible before revealing the map. Only useful
nopause where (for example) you abandoned with the fort revealed and no longer need
======= the saved map data when you load a new fort.
Disables pausing (both manual and automatic) with the exception of pause forced ``revflood``
by `reveal` ``hell``. This is nice for digging under rivers. Hide everything, then reveal tiles with a path to the cursor. This allows
reparing maps that you accidentally saved while they were revealed. Note
that tiles behind constructed walls are also revealed as a workaround for
:bug:`1871`.
``nopause 1|0``
Disables pausing (both manual and automatic) with the exception of the pause
forced by `reveal` ``hell``. This is nice for digging under rivers. Use
``nopause 1`` to prevent pausing and ``nopause 0`` to allow pausing like
normal.

42
plugins/reveal.cpp
Unescape Escape View File

@ -82,24 +82,30 @@ command_result nopause(color_ostream &out, vector<string> & params);
DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand("reveal","Reveal the map.",reveal,false, commands.push_back(PluginCommand(
"Reveals the map, by default ignoring hell.\n" "reveal",
"Options:\n" "Reveal the map.",
"hell - also reveal hell, while forcing the game to pause.\n" reveal));
"demon - reveal hell, do not pause.\n")); commands.push_back(PluginCommand(
commands.push_back(PluginCommand("unreveal","Revert the map to its previous state.",unreveal,false, "unreveal",
"Reverts the previous reveal operation, hiding the map again.\n")); "Revert a revealed map to its unrevealed state.",
commands.push_back(PluginCommand("revtoggle","Reveal/unreveal depending on state.",revtoggle,false, unreveal));
"Toggles between reveal and unreveal.\n")); commands.push_back(PluginCommand(
commands.push_back(PluginCommand("revflood","Hide all, and reveal tiles reachable from the cursor.",revflood,false, "revtoggle",
"This command hides the whole map. Then, starting from the cursor,\n" "Switch betwen reveal and unreveal.",
"reveals all accessible tiles. Allows repairing perma-revealed maps.\n" revtoggle));
"Note that constructed walls are considered passable to work around DF bug 1871.\n")); commands.push_back(PluginCommand(
commands.push_back(PluginCommand("revforget", "Forget the current reveal data.",revforget,false, "revflood",
"Forget the current reveal data, allowing to use reveal again.\n")); "Hide all, then reveal tiles reachable from the cursor.",
commands.push_back(PluginCommand("nopause","Disable manual and automatic pausing.",nopause,false, revflood));
"Disable pausing (doesn't affect pause forced by reveal).\n" commands.push_back(PluginCommand(
"Activate with 'nopause 1', deactivate with 'nopause 0'.\n")); "revforget",
"Forget the current reveal data.",
revforget));
commands.push_back(PluginCommand(
"nopause",
"Disable manual and automatic pausing.",
nopause));
return CR_OK; return CR_OK;
} }