Editing Burrow

{{Quality|Exceptional|21:43, 20 September 2016 (UTC)}}
{{av}}{{buggy}}

'''Burrows''' are user-defined areas in your fort for restricting jobs or/and dwarves. They are a way to limit the jobs your dwarf takes, what items they use or where they go, thus being an important tool for [[Defense_guide|Fortress Defense]]. A burrow can be used for one, multiple, or all of the above at once.

== Defining a new burrow ==

To enter the "define burrow" mode, press {{k|w}}.

You'll be presented with a list of all of your existing burrows. Change which burrow is selected with your secondary selection keys ({{k|+}},{{k|-}},{{k|*}}, & {{k|/}}).

To add a new burrow to the list, press {{k|a}}. The new burrow created this way starts with no tiles and a default name.

To configure an existing burrow, select it, then press {{k|enter}} to set the burrow's {{k|n}}ame, {{k|c}}hange the symbol used, and define what tiles it encompasses by setting/e{{k|r}}asing tiles. Defining the burrow's tiles can be done using keyboard to make rectangles or drawing with the mouse much like [[designation|designating]] tiles. A burrow does not need to be contigious and can extend into unrevealed space and other burrows - in the latter case, it can help use different colors and symbols to help tell them apart.

== Deleting Burrows ==

Deleting a burrow is easy, just enter "define burrow" mode by pressing {{k|w}}, select the burrow to delete, then press {{k|d}}, and confirm with {{k|y}}. Uniquely to burrows, erasing all tiles in a burrow will not delete it.

== Uses for Burrows ==

=== Limiting civilian citizen jobs ===

Activation: Select the burrow with secondary selection keys, then press {{k|c}} to view citizens & resident list⁎, scrolling through it with those same keys and using {{k|Enter}} to add or remove one or more to/from the burrow.

A citizen limited thus will only accept jobs and items inside the burrow. When a citizen is in multiple burrows, they can accept jobs and items from all of them. Note that "job" here covers nearly anything a dwarf may do outside of walking, fighting and socializing, including tasks such as idle individual combat drills†, picking up babies or equipment, or even sleeping. Nor will they try to eat or drink anything outside the burrow until starving or dehydrating.

[[Image:Burrow.png|right|thumb|240px|An illustration demonstrating that a burrow does *not* restrict a dwarf's movement--the metalcrafter marched right out of his burrow to pull the right lever.]]

'''Burrow assignments do not restrict citizen movements'''; An idle dwarf can take a stroll outside the burrow they're assigned to and they'll stand wherever they happen to be until assigned a task inside the burrow which they can path to. Additionally, citizens may walk from one point of the burrow to another point even if the path they walk on is not part of the burrow. If you define a burrow which is split into two areas, the citizens may walk between those two areas, outside of the burrow you defined.

Furthermore, this setting doesn't restrict jobs itself either. Should a job request an item not in the burrow, the dwarf will cancel the job. Then they'll look for a job again - often the one they just cancelled, thus entering a loop. 

As such, a dwarf's burrow should include: 

* All places they work at, sleep, eat, drink. 
* All tools, raw materials, fuel and items they need for above.
* All places the stockpiles they store items in draw from. 
* All stockpiles they take items from.
* For wheelbarrowed haulers, all the tiles they push the wheelbarrow on. 

Take care to avoid dwarves having labors that result in them taking jobs that demand items outside the burrow:

* Food hauling and food stockpile that takes from anywhere. 
* Feed Patients/Prisoners and a patient with buckets/water sources out of range.
* Seek Infant and a baby dropped outside the burrow.

Should one still need to use hauling labors, they should limit their stockpiles to links only and use [[Minecart]] hauling systems to move the requisite goods from outside the burrow to in. Otherwise, dwarves not assigned to the burrow can still do jobs in its area, including moving food inside.

⁎ The order of the citizens in the list is based on an internal ID number, which only loosely correlates with arrival time.

† However, active military dwarves are unaffected and can even perform those same drills.

=== Limit workshops to burrow ===

Activation: Select the burrow with secondary selection keys, then press {{k|w}} to toggle the limit. 

This setting behaves as if workshop or furnace is [[Stockpile#Give_to_a_stockpile.2Fworkshop|linked to take from stockpile]]. A building is considered affected by this setting when their center tile is in the burrow. A building limited by multiple burrows will be able to use materials from all of them. 

* Like with stockpile links, take care to include ''all'' items a job needs in the burrow area.

There are some notable differences from using links, however: 

* Burrows will not generate jobs, nor will they keep any items inside them from being hauled away to a stockpile elsewhere.
* Burrows are not considered buildings, and as such have greater freedom of placement; allowing one to limit their looms to all webs in safe areas, masons to nearby freshly dug stone, or smelter to take both nearby ore and bars in another smelter.
* Items dropped in center tile of workshop must necessarily be available to it, which can result in unwanted behaviour such as decorations on old clothes.
* It is easier to verify whether a given workshop is limited by burrows, as you only need to scroll through your burrow list while looking at it.

Keep in mind that this affects only workshops and furnaces, and not any other buildings that accept items for their jobs such as traps, stockpiles, farms, etc...

: Unfortunately, this feature can be enabled accidentally - (pressing {{k|w}} twice enters the burrow menu and toggles workshop restrictions for the first burrow). Due that it can be desirable to reassign one of these keys.

=== Civilian Alerts ===

Activation: In main menu, hit {{k|m}} to bring up the military menus, and {{k|a}} for alerts. 

(Optionally, using {{k|Up}} and {{k|Down}} arrow keys, select an alert you want civilians to currently use with {{k|Enter}} (default first entry, marked with {{k|[CIV]}}) in leftmost column - optionally creating a new one with {{k|c}} or using {{k|N}} to rename one.)

Then, navigate to the right {{k|Right}} and use {{k|Up}} and {{k|Down}} arrow keys to select the burrow(s) you want civilians to be restricted to with {{k|Enter}}.

To unactivate, unassign the burrow(s) or choose another alert to restrict civilians to.

: Unlike individual citizen burrow assignments, a [[civilian alert]] will apply to all fort civilians and animals. It will order them to go and stay inside the burrows defined in the alert for as long as the alert is active and includes any. Additionally, for that time individual assignments are ignored.

Most jobs and activities will be cancelled when cut off by civilian alert. However, one should take a look around for any heavy items carrying stragglers that are trying to slowly move their items to inside the burrow, and stop their job so they can drop the item nd flee faster.

=== Defending an Area ===
''Full article: [[Scheduling]]

Burrows are one of the ways you can give passive orders to [[squads]] and civilians during [[Scheduling#Alert levels|alerts]]. Under the squad schedule menu (Press {{k|m}} {{k|s}}) you can add an order to any particular month for the chosen alert with {{k|o}} or edit their existing orders with {{k|e}}. On the Give Orders menu, use {{k|o}} to cycle through the orders given to squads. The order "Defend Burrows" '''cannot''' be given without first creating burrows to assign defenders to. Under a "Defend Burrows" order, dwarves in the squad will go to exactly in the specified tile(s) and will defend it proactively - however, schedules don't switch until next day arrives.

=== Broker to the Depot, STAT ===

You can define your trade depot as a burrow, then when the traders appear, add your broker to that burrow. He will then only accept jobs at the trade depot, though he may be delayed if he is asleep or fulfilling an urgent [[need]]. This is particularly useful if your broker insists on performing other jobs instead of manning the depot.

===Alternative to Hot Keys===
You can define small burrows to areas you would like to zoom to.  Then by pressing "w", select the burrow, "z" to 'center on burrow' your view will be moved to earliest map block where burrow still has placed tiles.  This is useful when you run out of hotkey slots.

===Causing Insanity===
If a dwarf is assigned to a burrow with no beds, then that dwarf can't sleep. If he stays Very Drowsy long enough, then he'll go insane. Whether this is a goal or danger to be avoided depends on your play style. It's easy to accidentally do this to [[children]], since they'll keep on playing without giving much of a sign that they're about to have a mental breakdown.

== Bugs ==

Burrows can be powerful tools, but that also means they have the potential to cause many problems.

* Dwarves try to store equipment they're no longer using outside their burrows, spamming cancellations when unable. {{bug|340}}

* Haulers in burrows stand around contemplating hauling jobs they can't perform.{{bug|600}}

* [[Dwarf cancels Store Item: Item inaccessible]]" message spam results from idle dwarves being in a burrow that contains a stockpile but not the item the stockpile wants to have.{{bug|5062}} If you want to move items from outside the burrow to the inside without generating cancellations, you can put a stockpile on the boundary (to be accessed by non-burrowed dwarves) and use a minecart with a track stop set to dump onto a link-only stockpile inside the burrow. This way, the stockpile outside the burrow will not generate (impossible) jobs for the burrowed dwarves and the items will be moved to the inside by the non-burrowed dwarves, then happily to be picked up by the burrowed ones.

* Civilians assigned to a burrow while hauling constantly spam "drop-off inaccessible".{{bug|597}}

* Dwarves cancel repeating workshop jobs which they personally cannot complete due to their burrow lacking materials.{{bug|2262}}

* Burrow-assigned dwarves abandon [[wheelbarrow]]s when passing through non-burrow tiles.{{bug|6484}}

* Mothers spam cancellations when attempting to recover a baby outside of their burrow.{{bug|765}}

* Dwarves get stuck trying to perform jobs at edge of burrow.{{bug|2416}}

* Dwarves may remain restricted to a deleted burrow.{{bug|1735}}

* Spouse room assignments behave oddly when spouses are in different burrows.{{bug|2442}}
{{Category|Fortress mode}}
[[ru:Burrow]]
@@ Line 1: / Line 1: @@
-{{Quality|Unrated}}
+{{Quality|Exceptional|21:43, 20 September 2016 (UTC)}}
 {{av}}{{buggy}}
 '''Burrows''' are user-defined areas in your fort for restricting jobs or/and dwarves. They are a way to limit the jobs your dwarf takes, what items they use or where they go, thus being an important tool for [[Defense_guide|Fortress Defense]]. A burrow can be used for one, multiple, or all of the above at once.
-== Burrows Menu ==
+== Defining a new burrow ==
-Open the burrows menu with {{Menu icon|U}}.
+To enter the "define burrow" mode, press {{k|w}}.
-This will open the burrows menu:
-[[File:Burrows Menu.png]]
+You'll be presented with a list of all of your existing burrows. Change which burrow is selected with your secondary selection keys ({{k|+}},{{k|-}},{{k|*}}, & {{k|/}}).
-Clicking the "Add new burrow" button prompts you to paint what the burrow encompasses,
+To add a new burrow to the list, press {{k|a}}. The new burrow created this way starts with no tiles and a default name.
-then provides a menu for specifying the burrow's symbol and colors.
-In the burrows menu each burrow provides the following information on 2 rows
+To configure an existing burrow, select it, then press {{k|enter}} to set the burrow's {{k|n}}ame, {{k|c}}hange the symbol used, and define what tiles it encompasses by setting/e{{k|r}}asing tiles. Defining the burrow's tiles can be done using keyboard to make rectangles or drawing with the mouse much like [[designation|designating]] tiles. A burrow does not need to be contigious and can extend into unrevealed space and other burrows - in the latter case, it can help use different colors and symbols to help tell them apart.
-* First Row
-** Icon of Burrow (click on the icon to change)
-** Name of Burrow
-** [[File:recenter_button.png]]: recenter the map on the burrow
-** [[File:UI_Paint_Button.png]]: repaint the burrow
-** [[File:UI_Delete_Area.png]]: delete the burrow
-* Second Row
-** Number of assigned citizens
-** [[File:UI_add_worker.png]]: manage who is assigned to this burrow
-** [[File:Burrow_workshop_accept_outside_resources.png]]/[[File:Burrow_workshop_refuse_outside_resources.png]]: whether workshops in the burrow will/won't source materials from outside the burrow
-** [[File:Burrow_active.png]]/[[File:Burrow_suspended.png]]: whether the burrow is active/suspended
-A burrow does not need to be contiguous and can extend into unrevealed space and other burrows - in the latter case, it can help use different colors and symbols for the burrow's icon to help tell them apart.
+== Deleting Burrows ==
-===Assigning Citizens===
+Deleting a burrow is easy, just enter "define burrow" mode by pressing {{k|w}}, select the burrow to delete, then press {{k|d}}, and confirm with {{k|y}}. Uniquely to burrows, erasing all tiles in a burrow will not delete it.
-Citizens can be assigned to 0, 1, or multiple burrows.
-The burrow assignment menu appears as follows:
-[[File:Burrow_assignment_menu.png]]
+== Uses for Burrows ==
-On the top you can quickly assign all civilians (those not in a military squad) to the burrow, remove all civilians from the burrow (by selecting none), and similarly for soldiers.
-Citizens assigned to 1 or more active (i.e. non-suspended) burrows will only accept jobs from within their assigned burrows.
-Furthermore, they will _not_ venture outside of their assigned burrows to collect resources for a job, no matter what the setting is for workshops sourcing materials outside the burrow.
-Note that active military orders (kill/train/etc) override burrow assignments (for example, soldiers will perform training in their barracks if ordered/scheduled to do so, regardless of whether they are assigned to burrows that encompass the barracks).
-See [[#Limiting civilian citizen jobs]] for caveats and problems that this can cause.
-This can lead to some non-intuitive behavior, and a lot of job cancellation spam. An example of such odd behavior is that when a citizen is assigned to 2 burrows (with material sourcing from anywhere), they will bring materials from 1 burrow to the other burrow to perform a job, but will not haul items from one burrow to stockpiles in the other.
-Citizens not assigned to any active burrows will completely ignore burrow designations.
-i.e. They may perform jobs within a burrow, haul items into/out of a burrow, etc.
-===Suspending Burrows===
-"Assigned citizens will not respect burrow restrictions". i.e. when suspended the game behaves as if you have deleted the burrow.
-It can be useful to define a "safe" burrow with food and drinks, locked away from the outside world. Assign all of your civilians, and only activate it when a goblin siege or other threatening force shows up.
-===Workshops Material Sourcing===
-When a burrow does not allow sourcing materials from outside the burrow ([[File:Burrow_workshop_refuse_outside_resources.png]]), jobs for workshops inside the burrow will not allow for the material to be brought in from outside of the burrow.
-Otherwise, materials _can_ be retrieved from outside the burrow.
-This can be used as an alternative to (or in combination with) linked stockpiles. See [[#Limit workshops to burrow]].
-== Uses for Burrows ==
-{{migrated section}}
 === Limiting civilian citizen jobs ===
@@ Line 76: / Line 36: @@
 * All places they work at, sleep, eat, drink.
 * All tools, raw materials, fuel and items they need for above.
-* All stockpiles they store items in.
+* All places the stockpiles they store items in draw from.
 * All stockpiles they take items from.
 * For wheelbarrowed haulers, all the tiles they push the wheelbarrow on.
@@ Line 93: / Line 53: @@
 === Limit workshops to burrow ===
 Activation: Select the burrow with secondary selection keys, then press {{k|w}} to toggle the limit.
-This setting behaves as if workshop or furnace or trap is [[Stockpile#Give_to_a_stockpile.2Fworkshop|linked to take from stockpile]]. A building is considered affected by this setting when their center tile is in the burrow. A building limited by multiple burrows will be able to use materials from all of them.
+This setting behaves as if workshop or furnace is [[Stockpile#Give_to_a_stockpile.2Fworkshop|linked to take from stockpile]]. A building is considered affected by this setting when their center tile is in the burrow. A building limited by multiple burrows will be able to use materials from all of them.
 * Like with stockpile links, take care to include ''all'' items a job needs in the burrow area.
@@ Line 111: / Line 72: @@
 === Civilian Alerts ===
-In previous versions, civilian alerts could be used to force all civilians and animals to remain inside a burrow, ignoring their individual assignments for the time being.
-In the current version {{version|50.07}}, this feature is [[Missing features|missing]] due to {{F|169696/8442542|UI and time constraints}}. The ability to assign all civilians to a burrow replicates some of its functionality.
+Activation: In main menu, hit {{k|m}} to bring up the military menus, and {{k|a}} for alerts.
+(Optionally, using {{k|Up}} and {{k|Down}} arrow keys, select an alert you want civilians to currently use with {{k|Enter}} (default first entry, marked with {{k|[CIV]}}) in leftmost column - optionally creating a new one with {{k|c}} or using {{k|N}} to rename one.)
+Then, navigate to the right {{k|Right}} and use {{k|Up}} and {{k|Down}} arrow keys to select the burrow(s) you want civilians to be restricted to with {{k|Enter}}.
+To unactivate, unassign the burrow(s) or choose another alert to restrict civilians to.
+: Unlike individual citizen burrow assignments, a [[civilian alert]] will apply to all fort civilians and animals. It will order them to go and stay inside the burrows defined in the alert for as long as the alert is active and includes any. Additionally, for that time individual assignments are ignored.
+Most jobs and activities will be cancelled when cut off by civilian alert. However, one should take a look around for any heavy items carrying stragglers that are trying to slowly move their items to inside the burrow, and stop their job so they can drop the item nd flee faster.
 === Defending an Area ===
@@ Line 124: / Line 95: @@
 ===Alternative to Hot Keys===
-You can define small burrows to areas you would like to zoom to. Then by pressing "w", select the burrow, "z" to 'center on burrow' your view will be moved to earliest map block where burrow still has placed tiles. This is useful when you run out of hotkey slots.
+You can define small burrows to areas you would like to zoom to.  Then by pressing "w", select the burrow, "z" to 'center on burrow' your view will be moved to earliest map block where burrow still has placed tiles.  This is useful when you run out of hotkey slots.
-===Causing and Managing Insanity===
+===Causing Insanity===
 If a dwarf is assigned to a burrow with no beds, then that dwarf can't sleep. If he stays Very Drowsy long enough, then he'll go insane. Whether this is a goal or danger to be avoided depends on your play style. It's easy to accidentally do this to [[children]], since they'll keep on playing without giving much of a sign that they're about to have a mental breakdown.
-Ironically, some dwarves going insane can be easily managed with a burrow. Despite their wild and irreversible mental state, dwarves can comply with the limited area of the burrow. This can be extremely useful for keeping insane and potentially harmful dwarves away from the general population, as well as keeping others from seeing the corpse of the insane person when they inevitably die.
+== Bugs ==
-== Bugs ==
-{{migrated section}}
 Burrows can be powerful tools, but that also means they have the potential to cause many problems.
 * Dwarves try to store equipment they're no longer using outside their burrows, spamming cancellations when unable. {{bug|340}}
 * Haulers in burrows stand around contemplating hauling jobs they can't perform.{{bug|600}}
 * [[Dwarf cancels Store Item: Item inaccessible]]" message spam results from idle dwarves being in a burrow that contains a stockpile but not the item the stockpile wants to have.{{bug|5062}} If you want to move items from outside the burrow to the inside without generating cancellations, you can put a stockpile on the boundary (to be accessed by non-burrowed dwarves) and use a minecart with a track stop set to dump onto a link-only stockpile inside the burrow. This way, the stockpile outside the burrow will not generate (impossible) jobs for the burrowed dwarves and the items will be moved to the inside by the non-burrowed dwarves, then happily to be picked up by the burrowed ones.
 * Civilians assigned to a burrow while hauling constantly spam "drop-off inaccessible".{{bug|597}}
 * Dwarves cancel repeating workshop jobs which they personally cannot complete due to their burrow lacking materials.{{bug|2262}}
 * Burrow-assigned dwarves abandon [[wheelbarrow]]s when passing through non-burrow tiles.{{bug|6484}}
 * Mothers spam cancellations when attempting to recover a baby outside of their burrow.{{bug|765}}
 * Dwarves get stuck trying to perform jobs at edge of burrow.{{bug|2416}}
 * Dwarves may remain restricted to a deleted burrow.{{bug|1735}}
 * Spouse room assignments behave oddly when spouses are in different burrows.{{bug|2442}}
 {{Category|Fortress mode}}
 [[ru:Burrow]]