autoclothing: add docs

Ref #1437
develop
lethosor 2019-11-02 22:00:43 -04:00
parent 487377d5b9
commit a885e3b9be
2 changed files with 18 additions and 2 deletions

@ -1845,6 +1845,22 @@ reeequip with replacement items.
Use the `enable` and `disable` commands to toggle this plugin's status, or run
``tailor status`` to check its current status.
.. _autoclothing:
autoclothing
============
Automatically manage clothing work orders, allowing the user to set how many of
each clothing type every citizen should have. Usage::
autoclothing <material> <item> [number]
Examples:
* ``autoclothing cloth "short skirt" 10``:
Sets the desired number of cloth short skirts available per citizen to 10.
* ``autoclothing cloth dress``:
Displays the currently set number of cloth dresses chosen per citizen.
================
Map modification

@ -187,7 +187,7 @@ DFhackCExport command_result plugin_init(color_ostream &out, std::vector <Plugin
"autoclothing", "Automatically manage clothing work orders",
autoclothing, false, /* true means that the command can't be used from non-interactive user interface */
// Extended help string. Used by CR_WRONG_USAGE and the help command:
" autoclothing material item <number>\n"
" autoclothing <material> <item> [number]\n"
"Example:\n"
" autoclothing cloth \"short skirt\" 10\n"
" Sets the desired number of cloth short skirts available per citizen to 10.\n"
@ -383,7 +383,7 @@ command_result autoclothing(color_ostream &out, std::vector <std::string> & para
// use CoreSuspender, it'll automatically resume DF when
// execution leaves the current scope.
CoreSuspender suspend;
// Create a new requirement from the available parameters.
ClothingRequirement newRequirement;