dfhack/docs/plugins/burrows.rst

55 lines
1.9 KiB
ReStructuredText

burrows
=======
2022-07-20 00:11:02 -06:00
.. dfhack-tool::
:summary: Auto-expand burrows as you dig.
:tags: fort auto design productivity map units
:no-command:
.. dfhack-command:: burrow
:summary: Quickly add units/tiles to burrows.
When a wall inside a burrow with a name ending in ``+`` is dug out, the burrow
will be extended to newly-revealed adjacent walls.
2022-07-18 18:09:48 -06:00
2022-08-17 23:42:02 -06:00
Usage
-----
``burrow enable auto-grow``
2022-07-22 01:05:53 -06:00
When a wall inside a burrow with a name ending in '+' is dug out, the burrow
will be extended to newly-revealed adjacent walls. This final '+' may be
omitted in burrow name args of other ``burrow`` commands. Note that digging
1-wide corridors with the miner inside the burrow is SLOW.
``burrow disable auto-grow``
2022-07-22 01:05:53 -06:00
Disables auto-grow processing.
``burrow clear-unit <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Remove all units from the named burrows.
``burrow clear-tiles <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Remove all tiles from the named burrows.
``burrow set-units target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Clear all units from the target burrow, then add units from the named source
burrows.
``burrow add-units target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Add units from the source burrows to the target.
``burrow remove-units target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Remove units in source burrows from the target.
``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Clear target burrow tiles and adds tiles from the names source burrows.
``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Add tiles from the source burrows to the target.
``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
2022-07-22 01:05:53 -06:00
Remove tiles in source burrows from the target.
In place of a source burrow, you can use one of the following keywords:
- ``ABOVE_GROUND``
- ``SUBTERRANEAN``
- ``INSIDE``
- ``OUTSIDE``
- ``LIGHT``
- ``DARK``
- ``HIDDEN``
- ``REVEALED``
to add tiles with the given properties.