update docs for lair

develop
myk002 2022-07-27 17:14:30 -07:00
parent e94f1891c2
commit 52a0b0f2ca
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 16 additions and 9 deletions

@ -1,12 +1,17 @@
lair lair
==== ====
This command allows you to mark the map as a monster lair, preventing item Tags:
scatter on abandon. When invoked as ``lair reset``, it does the opposite. :dfhack-keybind:`lair`
Unlike `reveal`, this command doesn't save the information about tiles - you Mark the map as a monster lair. This avoids item scatter when the fortress is
won't be able to restore state of real monster lairs using ``lair reset``. abandoned.
Options: Usage:
:lair: Mark the map as monster lair ``lair``
:lair reset: Mark the map as ordinary (not lair) Mark the map as monster lair.
``lair reset``
Mark the map as ordinary (not lair).
This command doesn't save the information about tiles - you won't be able to
restore the state of a real monster lairs using ``lair reset``.

@ -61,7 +61,9 @@ command_result lair(color_ostream &out, std::vector<std::string> & params)
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("lair","Mark the map as a monster lair (avoids item scatter)",lair, false, commands.push_back(PluginCommand(
"Usage: 'lair' to mark entire map as monster lair, 'lair reset' to undo the operation.\n")); "lair",
"Mark the map as a monster lair to avoid item scatter.",
lair));
return CR_OK; return CR_OK;
} }