dfhack/docs/plugins/burrows.rst

burrows
=======

.. 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.

Usage
-----

``burrow enable auto-grow``
    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``
    Disables auto-grow processing.
``burrow clear-unit <burrow> [<burrow> ...]``
    Remove all units from the named burrows.
``burrow clear-tiles <burrow> [<burrow> ...]``
    Remove all tiles from the named burrows.
``burrow set-units target-burrow <burrow> [<burrow> ...]``
    Clear all units from the target burrow, then add units from the named source
    burrows.
``burrow add-units target-burrow <burrow> [<burrow> ...]``
    Add units from the source burrows to the target.
``burrow remove-units target-burrow <burrow> [<burrow> ...]``
    Remove units in source burrows from the target.
``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
    Clear target burrow tiles and adds tiles from the names source burrows.
``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
    Add tiles from the source burrows to the target.
``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
    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.
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`burrows`
			`=======`
update formatting for plugin docs 2022-07-20 00:11:02 -06:00
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: Auto-expand burrows as you dig.`
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: fort auto design productivity map units`
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			`:no-command:`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
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-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.`
update docs for burrows 2022-07-18 18:09:48 -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 all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow enable auto-grow``
update docs up to the end of the b's 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`
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			omitted in burrow name args of other ``burrow`` commands. Note that digging
some plugins can't be directly enabled by the user 2022-07-29 17:05:49 -06:00			`1-wide corridors with the miner inside the burrow is SLOW.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow disable auto-grow``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Disables auto-grow processing.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow clear-unit <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove all units from the named burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow clear-tiles <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove all tiles from the named burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow set-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Clear all units from the target burrow, then add units from the named source`
			`burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow add-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Add units from the source burrows to the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow remove-units target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Remove units in source burrows from the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow set-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Clear target burrow tiles and adds tiles from the names source burrows.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow add-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 2022-07-22 01:05:53 -06:00			`Add tiles from the source burrows to the target.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``burrow remove-tiles target-burrow <burrow> [<burrow> ...]``
update docs up to the end of the b's 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.`