Updated getplants documentation

develop
PatrikLundell 2020-01-22 19:41:06 +01:00
parent 9d4d0b195a
commit 04550499b6
1 changed files with 18 additions and 9 deletions

@ -2298,16 +2298,19 @@ by spaces.
Options: Options:
:``-t``: Select trees only (exclude shrubs) :``-t``: Tree: Select trees only (exclude shrubs)
:``-s``: Select shrubs only (exclude trees) :``-s``: Shrub: Select shrubs only (exclude trees)
:``-c``: Clear designations instead of setting them :``-f``: Farming: Designate only shrubs that yield seeds for farming. Implies -s
:``-x``: Apply selected action to all plants except those specified (invert :``-c``: Clear: Clear designations instead of setting them
:``-x``: eXcept: Apply selected action to all plants except those specified (invert
selection) selection)
:``-a``: Select every type of plant (obeys ``-t``/``-s``) :``-a``: All: Select every type of plant (obeys ``-t``/``-s``/``-f``)
:``-v``: Lists the number of (un)designations per plant :``-v``: Verbose: Lists the number of (un)designations per plant
:``-n *``: Number: Designate up to * (an integer number) plants of each species
Specifying both ``-t`` and ``-s`` will have no effect. If no plant IDs are specified, Specifying both ``-t`` and ``-s`` or ``-f`` will have no effect. If no plant IDs are
all valid plant IDs will be listed. specified, all valid plant IDs will be listed, with ``-t``, ``-s``, and ``-f``
restricting the list to trees, shrubs, and farmable shrubs, respectively.
.. note:: .. note::
@ -2317,7 +2320,13 @@ all valid plant IDs will be listed.
This leads to some shrubs being designated when they shouldn't be, causing a This leads to some shrubs being designated when they shouldn't be, causing a
plant gatherer to walk there and do nothing (except clearing the plant gatherer to walk there and do nothing (except clearing the
designation). See :issue:`1479` for details. designation). See :issue:`1479` for details.
The implementation another known deficiency: it's incapable of detecting that
RAW definitions that specify a seed extraction reaction for the structural part
but has no other use for it cannot actually yield any seeds, as the part is
never used (parts of bug tracker report 6940, e.g. Red Spinach), even though DF
collects it, unless there's a workshop reaction to do it (which there isn't
in vanilla).
.. _infiniteSky: .. _infiniteSky: