From b3526a776a01594794cf121fc8009446bafd0462 Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sun, 31 Dec 2023 11:28:49 -0800 Subject: [PATCH] add cautionary note about exposed secrets in the caverns --- docs/plugins/reveal.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/plugins/reveal.rst b/docs/plugins/reveal.rst index df46b6ff5..524b57d99 100644 --- a/docs/plugins/reveal.rst +++ b/docs/plugins/reveal.rst @@ -54,3 +54,14 @@ Usage forced by `reveal` ``hell``. This is nice for digging under rivers. Use ``nopause 1`` to prevent pausing and ``nopause 0`` to allow pausing like normal. + +Note +---- + +Sometimes, the map generates secret hollows adjacent to caverns in such a way +that the ceiling of the hollow collapses on the first tick of the embark, +leaving the hollow exposed to the caverns. In this case, the secret event will +be triggered as soon as the cavern is discovered and that tile is unhidden. +This would happen anyway even if you don't use `reveal`, but be aware that it +is possible to trigger *some* events when you run `reveal`, even without the +``hell`` option.