dfhack/docs/plugins/strangemood.rst

45 lines
1.4 KiB
ReStructuredText

strangemood
===========
2022-07-31 14:30:33 -06:00
.. dfhack-tool::
:summary: Trigger a strange mood.
2023-01-10 23:26:12 -07:00
:tags: untested fort armok units
2022-07-31 14:30:33 -06:00
2022-08-17 23:42:02 -06:00
Usage
-----
::
2022-07-31 14:30:33 -06:00
stangemood [<options>]
Examples
--------
``strangemood -force -unit -type secretive -skill armorsmith``
Trigger a strange mood for the selected unit that will cause them to become
a legendary armorsmith.
Options
-------
2023-02-13 02:18:45 -07:00
``--force``
2022-07-31 14:30:33 -06:00
Ignore normal strange mood preconditions (no recent mood, minimum moodable
population, artifact limit not reached, etc.).
2023-02-13 02:18:45 -07:00
``--unit``
2022-07-31 14:30:33 -06:00
Make the strange mood strike the selected unit instead of picking one
randomly. Unit eligibility is still enforced (unless ``-force`` is also
specified).
2023-02-13 02:18:45 -07:00
``--type <type>``
2022-07-31 14:30:33 -06:00
Force the mood to be of a particular type instead of choosing randomly based
on happiness. Valid values are "fey", "secretive", "possessed", "fell", and
"macabre".
2023-02-13 02:18:45 -07:00
``--skill <skill>``
2022-07-31 14:30:33 -06:00
Force the mood to use a specific skill instead of choosing the highest
moodable skill. Valid values are "miner", "carpenter", "engraver", "mason",
"tanner", "weaver", "clothier", "weaponsmith", "armorsmith", "metalsmith",
"gemcutter", "gemsetter", "woodcrafter", "stonecrafter", "metalcrafter",
"glassmaker", "leatherworker", "bonecarver", "bowyer", and "mechanic".
Known limitations: if the selected unit is currently performing a job, the mood
will not be triggered.