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

update docs for cleanowned

develop
myk002 2022-07-20 14:51:06 -07:00
parent e9e477c680
commit d9a1104473
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 33 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/plugins/cleanowned.rst
Unescape Escape View File

@ -1,19 +1,37 @@
cleanowned cleanowned
========== ==========
Confiscates items owned by dwarfs. By default, owned food on the floor
and rotten items are confistacted and dumped.
Options: Tags:
:dfhack-keybind:
:all: confiscate all owned items Confiscates and dumps garbage owned by dwarves. This tool gets dwarves to give
:scattered: confiscated and dump all items scattered on the floor up ownership of scattered items and items with heavy wear and then marks those
:x: confiscate/dump items with wear level 'x' and more items for dumping. Now you can finally get your dwarves to give up their rotten
:X: confiscate/dump items with wear level 'X' and more food and tattered loincloths and go get new ones!
:dryrun: a dry run. combine with other options to see what will happen
without it actually happening.
Example: Usage::
``cleanowned scattered X`` cleanowned [<types>] [dryrun]
This will confiscate rotten and dropped food, garbage on the floors and any
When run without parameters, ``cleanowned`` will confiscate and dump rotten
items and owned food that is left behind on the floor. Specify the ``dryrun``
parameter to just print out what would be done, but don't actually confiscate
anything.
You can confiscate additional types of items by adding them to the commandline:
- ``scattered``
Confiscate/dump all items scattered on the floor.
- ``x``
Confiscate/dump items with wear level 'x' (lightly worn) and more.
- ``X``
Confiscate/dump items with wear level 'X' (heavily worn) and more.
Or you can confiscate all owned items by specifying ``all``.
Example
-------
- ``cleanowned scattered X``
Confiscate and dump rotten and dropped food, garbage on the floors, and any
worn items with 'X' damage and above. worn items with 'X' damage and above.

19
plugins/cleanowned.cpp
Unescape Escape View File

@ -31,22 +31,9 @@ command_result df_cleanowned (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(PluginCommand(
"cleanowned", "Confiscates and dumps garbage owned by dwarfs.", "cleanowned",
df_cleanowned, false, "Confiscates and dumps garbage owned by dwarves.",
" This tool lets you confiscate and dump all the garbage\n" df_cleanowned));
" dwarves ultimately accumulate.\n"
" By default, only rotten and dropped food is confiscated.\n"
"Options:\n"
" dryrun - don't actually do anything, just print what would be done.\n"
" scattered - confiscate owned items on the ground\n"
" all - confiscate everything\n"
" x - confiscate & dump 'x' and worse damaged items\n"
" X - confiscate & dump 'X' and worse damaged items\n"
"Example:\n"
" cleanowned scattered X\n"
" This will confiscate rotten and dropped food, garbage on the floors\n"
" and any worn items with 'X' damage and above.\n"
));
return CR_OK; return CR_OK;
} }