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

update docs for cleanconst

develop
myk002 2022-07-20 13:26:30 -07:00
parent d3dd12c38f
commit 1f3c4cdd18
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/plugins/cleanconst.rst
Unescape Escape View File

@ -1,7 +1,14 @@
cleanconst cleanconst
========== ==========
Cleans up construction materials.
This utility alters all constructions on the map so that they spawn their Tags:
building component when they are disassembled, allowing their actual :dfhack-keybind:
build items to be safely deleted. This can improve FPS in extreme situations.
Cleans up construction materials. This tool alters all constructions on the map
so that they spawn their building component when they are disassembled, allowing
their actual build items to be safely deleted. This can improve FPS when you
have many constructions on the map.
Usage::
cleanconst

9
plugins/cleanconst.cpp
Unescape Escape View File

@ -71,12 +71,9 @@ command_result df_cleanconst(color_ostream &out, vector <string> & parameters)
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( commands.push_back(PluginCommand(
"cleanconst", "Cleans up construction materials.", "cleanconst",
df_cleanconst, false, "Cleans up construction materials.",
" This utility alters all constructions on the map so that they spawn their\n" df_cleanconst));
" building component when they are disassembled, allowing their actual\n"
" build items to be safely deleted.\n"
));
return CR_OK; return CR_OK;
} }