update deramp docs

develop
myk002 2022-07-22 17:46:22 -07:00
parent 0f3811b933
commit 675f2edee2
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 16 additions and 11 deletions

@ -1,6 +1,13 @@
deramp deramp
====== ======
Removes all ramps designated for removal from the map. This is useful for
replicating the old channel digging designation. It also removes any and Tags:
all 'down ramps' that can remain after a cave-in (you don't have to designate :dfhack-keybind:`deramp`
anything for that to happen).
:index:`Removes all ramps designated for removal from the map.
<deramp; Removes all ramps designated for removal from the map.>` It also
removes any "floating" down ramps that can remain after a cave-in.
Usage::
deramp

@ -109,13 +109,11 @@ command_result df_deramp (color_ostream &out, vector <string> & parameters)
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( commands.push_back(
"deramp", "Replace all ramps marked for removal with floors.", PluginCommand(
df_deramp, false, "deramp",
" If there are any ramps designated for removal, they will be instantly\n" "Removes all ramps designated for removal from the map.",
" removed. Any ramps that don't have their counterpart will also be removed\n" df_deramp));
" (fixes bugs with caveins)\n"
));
return CR_OK; return CR_OK;
} }