revflood docs: clarify that constructed walls are ignored

Closes #1719
develop
lethosor 2020-12-05 19:41:32 -05:00
parent 855ce84eca
commit a3d8c5a2ec
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 5 additions and 3 deletions

@ -187,8 +187,9 @@ Usage and related commands:
:reveal demon: Reveals everything and allows unpausing - good luck! :reveal demon: Reveals everything and allows unpausing - good luck!
:unreveal: Reverts the effects of ``reveal`` :unreveal: Reverts the effects of ``reveal``
:revtoggle: Switches between ``reveal`` and ``unreveal`` :revtoggle: Switches between ``reveal`` and ``unreveal``
:revflood: Hide everything, then reveal tiles with a path to the cursor :revflood: Hide everything, then reveal tiles with a path to the cursor.
(useful to make walled-off rooms vanish) Note that tiles behind constructed walls are also revealed as a
workaround for :bug:`1871`.
:revforget: Discard info about what was visible before revealing the map. :revforget: Discard info about what was visible before revealing the map.
Only useful where (e.g.) you abandoned with the fort revealed Only useful where (e.g.) you abandoned with the fort revealed
and no longer want the data. and no longer want the data.

@ -91,7 +91,8 @@ DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCom
"Toggles between reveal and unreveal.\n")); "Toggles between reveal and unreveal.\n"));
commands.push_back(PluginCommand("revflood","Hide all, and reveal tiles reachable from the cursor.",revflood,false, commands.push_back(PluginCommand("revflood","Hide all, and reveal tiles reachable from the cursor.",revflood,false,
"This command hides the whole map. Then, starting from the cursor,\n" "This command hides the whole map. Then, starting from the cursor,\n"
"reveals all accessible tiles. Allows repairing parma-revealed maps.\n")); "reveals all accessible tiles. Allows repairing perma-revealed maps.\n"
"Note that constructed walls are considered passable to work around DF bug 1871.\n"));
commands.push_back(PluginCommand("revforget", "Forget the current reveal data.",revforget,false, commands.push_back(PluginCommand("revforget", "Forget the current reveal data.",revforget,false,
"Forget the current reveal data, allowing to use reveal again.\n")); "Forget the current reveal data, allowing to use reveal again.\n"));
commands.push_back(PluginCommand("nopause","Disable manual and automatic pausing.",nopause,false, commands.push_back(PluginCommand("nopause","Disable manual and automatic pausing.",nopause,false,