MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack/docs/plugins/reveal.rst

57 lines
2.0 KiB
ReStructuredText
Raw Normal View History Unescape Escape

align remaining plugin docs to plugin names
2022-07-25 07:08:59 -06:00
.. _revflood:
split the plugin docs into individual files
2022-07-10 00:01:46 -06:00
reveal
======
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
.. dfhack-tool::
:summary: Reveals the map.
resort tags according to new spreadsheet order also fix tag syncing command so short descriptions with internal periods are parsed correctly
2022-08-16 10:36:17 -06:00
:tags: adventure fort armok inspection map
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
fix directive use for reveal.rst
2022-09-21 13:54:12 -06:00
.. dfhack-command:: unreveal
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
:summary: Hides previously hidden tiles again.
fix directive use for reveal.rst
2022-09-21 13:54:12 -06:00
.. dfhack-command:: revforget
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
:summary: Discard records about what was visible before revealing the map.
fix directive use for reveal.rst
2022-09-21 13:54:12 -06:00
.. dfhack-command:: revtoggle
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
:summary: Switch between reveal and unreveal.
fix directive use for reveal.rst
2022-09-21 13:54:12 -06:00
.. dfhack-command:: revflood
anchor revflood at a unit's position makes it more user friendly and reduces chance of mishap by placing the cursor in an unforgiving location (like in a closed cavity)
2023-03-17 18:43:58 -06:00
:summary: Hide everything, then reveal tiles with a path to a unit.
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
fix directive use for reveal.rst
2022-09-21 13:54:12 -06:00
.. dfhack-command:: nopause
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file.
2022-08-09 23:37:24 -06:00
:summary: Disable pausing.
This reveals all z-layers in fort mode. It also works in adventure mode, but any
of its effects are negated once you move. When you use it this way, you don't
need to run ``unreveal`` to hide the map again.
split the plugin docs into individual files
2022-07-10 00:01:46 -06:00
make Usage a proper header
2022-08-17 23:42:02 -06:00
Usage
-----
split the plugin docs into individual files
2022-07-10 00:01:46 -06:00
update docs for reveal
2022-07-29 18:12:15 -06:00
``reveal [hell|demon]``
Reveal the whole map. If ``hell`` is specified, also reveal HFS areas, but
you are required to run ``unreveal`` before unpausing is allowed in order
to prevent the demons from spawning. If you really want to unpause with hell
revealed, specify ``demon`` instead of ``hell``.
``unreveal``
Reverts the effects of ``reveal``.
``revtoggle``
Switches between ``reveal`` and ``unreveal``. Convenient to bind to a
hotkey.
``revforget``
Discard info about what was visible before revealing the map. Only useful
where (for example) you abandoned with the fort revealed and no longer need
the saved map data when you load a new fort.
``revflood``
anchor revflood at a unit's position makes it more user friendly and reduces chance of mishap by placing the cursor in an unforgiving location (like in a closed cavity)
2023-03-17 18:43:58 -06:00
Hide everything, then reveal tiles with a path to the keyboard cursor (if
enabled) or the selected unit (if a unit is selected) or else a random citizen.
This allows reparing maps that you accidentally saved while they were revealed.
Note that tiles behind constructed walls are also revealed as a workaround for
update docs for reveal
2022-07-29 18:12:15 -06:00
:bug:`1871`.
``nopause 1|0``
Disables pausing (both manual and automatic) with the exception of the pause
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.