document the overlay functionality

develop
Myk Taylor 2023-07-15 19:26:59 -07:00
parent b10ef79a29
commit 4331d7bcc7
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 29 additions and 1 deletions

@ -3,7 +3,7 @@ zone
.. dfhack-tool:: .. dfhack-tool::
:summary: Manage activity zones, cages, and the animals therein. :summary: Manage activity zones, cages, and the animals therein.
:tags: unavailable fort productivity animals buildings :tags: unavailable fort productivity animals buildings interface
Usage Usage
----- -----
@ -157,3 +157,31 @@ cages and then place one pen/pasture activity zone above them, covering all
cages you want to use. Then use ``zone set`` (like with ``assign``) and run cages you want to use. Then use ``zone set`` (like with ``assign``) and run
``zone tocages <filter>``. ``tocages`` can be used together with ``nick`` or ``zone tocages <filter>``. ``tocages`` can be used together with ``nick`` or
``remnick`` to adjust nicknames while assigning to cages. ``remnick`` to adjust nicknames while assigning to cages.
Overlay
-------
Advanced unit selection is available via an `overlay` widget that appears when
you select a pasture zone.
In the window that pops up when you click the hotkey hint or hit the hotkey on your keyboard, you can:
- search for units by name
- sort or filter by status (Pastured here, Pastured elsewhere, On restraint, On
display in cage, In movable cage, or Roaming)
- sort or filter by disposition (Pet, Domesticated, Partially trained, Wild
(trainable), Wild (untrainable), or Hostile)
- sort by gender
- sort by name
- filter by whether the unit lays eggs
- filter by whether the unit needs a grazing area
The window is fully navigatable via keyboard or mouse. Hit Enter or click on a
unit to assign/unassign it to the currently selected pasture. Shift click to
assign/unassign a range of units.
You can also keep the window open and click around on different pastures, so
you can manage multiple pastures without having to close and reopen the window.
As for all other overlays, you can disable this one in `gui/control-panel` on
the Overlays tab if you don't want the option of using it.