From 52a0b0f2ca8758dc792e5402f0393f75d8e4b9c7 Mon Sep 17 00:00:00 2001 From: myk002 Date: Wed, 27 Jul 2022 17:14:30 -0700 Subject: [PATCH] update docs for lair --- docs/plugins/lair.rst | 19 ++++++++++++------- plugins/lair.cpp | 6 ++++-- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/plugins/lair.rst b/docs/plugins/lair.rst index b80e71e3a..b4a7ed524 100644 --- a/docs/plugins/lair.rst +++ b/docs/plugins/lair.rst @@ -1,12 +1,17 @@ lair ==== -This command allows you to mark the map as a monster lair, preventing item -scatter on abandon. When invoked as ``lair reset``, it does the opposite. +Tags: +:dfhack-keybind:`lair` -Unlike `reveal`, this command doesn't save the information about tiles - you -won't be able to restore state of real monster lairs using ``lair reset``. +Mark the map as a monster lair. This avoids item scatter when the fortress is +abandoned. -Options: +Usage: -:lair: Mark the map as monster lair -:lair reset: Mark the map as ordinary (not lair) +``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``. diff --git a/plugins/lair.cpp b/plugins/lair.cpp index 6fb167988..7c3b1953f 100644 --- a/plugins/lair.cpp +++ b/plugins/lair.cpp @@ -61,7 +61,9 @@ command_result lair(color_ostream &out, std::vector & params) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { - commands.push_back(PluginCommand("lair","Mark the map as a monster lair (avoids item scatter)",lair, false, - "Usage: 'lair' to mark entire map as monster lair, 'lair reset' to undo the operation.\n")); + commands.push_back(PluginCommand( + "lair", + "Mark the map as a monster lair to avoid item scatter.", + lair)); return CR_OK; }