Merge pull request #833 from azrazalea/warn_stranded

Use pathability groups (thanks @myk002) to detect stranded citizens

changelog.txt

@@ -37,6 +37,9 @@ Template for new versions:
 - `drain-aquifer`: new option to drain all layers except for the first N aquifer layers, in case you want some aquifer layers but not too many
 - `gui/control-panel`: ``drain-aquifer --top 2`` added as an autostart option
 
+## New Scripts
+- `warn-stranded`: new repeatable maintenance script to check for stranded units, similar to `warn-starving`
+
 ## Fixes
 - `suspendmanager`: fix errors when constructing near the map edge
 - `gui/sandbox`: fix scrollbar moving double distance on click

docs/warn-stranded.rst

@@ -0,0 +1,53 @@
+warn-stranded
+=============
+
+.. dfhack-tool::
+    :summary: Reports citizens that are stranded and can't reach any other citizens.
+    :tags: fort units
+
+If any (live) groups of fort citizens are stranded from the main (largest) group,
+the game will pause and you'll get a warning dialog telling you which citizens are isolated.
+This gives you a chance to rescue them before they get overly stressed or start starving.
+
+Each citizen will be put into a group with the other citizens stranded together.
+
+There is a command line interface that can print status of citizens without pausing or bringing up a window.
+
+The GUI and command-line both also have the ability to ignore citizens so they don't trigger a pause and window.
+
+You can enable ``warn-stranded`` notifications in `gui/control-panel` on the "Maintenance" tab.
+
+Usage
+-----
+
+::
+
+    warn-stranded
+    warn-stranded status
+    warn-stranded clear
+    warn-stranded (ignore|ignoregroup|unignore|unignoregroup) <id>
+
+Examples
+--------
+
+``warn-stranded``
+    Standard command that checks citizens and pops up a warning if any are stranded.
+    Does nothing when there are no unignored stranded citizens.
+
+``warn-stranded status``
+    List all stranded citizens and all ignored citizens. Includes citizen unit ids.
+
+``warn-stranded clear``
+    Clear (unignore) all ignored citizens.
+
+``warn-stranded ignore 1``
+    Ignore citizen with unit id 1.
+
+``warn-stranded ignoregroup 2``
+    Ignore stranded citizen group 2.
+
+``warn-stranded unignore  1``
+    Unignore citizen with unit id 1.
+
+``warn-stranded unignoregroup 3``
+    Unignore stranded citizen group 3.

gui/control-panel.lua

@@ -137,6 +137,9 @@ local REPEATS = {
     ['warn-starving']={
         desc='Show a warning dialog when units are starving or dehydrated.',
         command={'--time', '10', '--timeUnits', 'days', '--command', '[', 'warn-starving', ']'}},
+    ['warn-stranded']={
+        desc='Show a warning dialog when units are stranded from all others.',
+        command={'--time', '0.25', '--timeUnits', 'days', '--command', '[', 'warn-stranded', ']'}},
     ['empty-wheelbarrows']={
         desc='Empties wheelbarrows which have rocks stuck in them.',
         command={'--time', '1', '--timeUnits', 'days', '--command', '[', 'fix/empty-wheelbarrows', '-q', ']'}},