Add a suffocation gui overlay as a module - ticks left until death

changelog.txt

@@ -40,6 +40,7 @@ Template for new versions:
 ## New Features
 - `buildingplan`: dimension tooltip is now displayed for constructions and buildings that are designated over an area, like bridges and farm plots
 - `gui/notify`: new notification type: injured citizens; click to zoom to injured units; also displays a warning if your hospital is not functional (or if you have no hospital)
+- `gui/notify`: new notification type: drowning and suffocation progress bars for adventure mode
 - `prioritize`: new info panel on under-construction buildings showing if the construction job has been taken and by whom. click to zoom to builder; toggle high priority status for job if it's not yet taken and you need it to be built ASAP
 - `gui/pathable`: new "Depot" mode that shows whether wagons can path to your trade depot
 

gui/notify.lua

@@ -16,6 +16,7 @@ NotifyOverlay = defclass(NotifyOverlay, overlay.OverlayWidget)
 NotifyOverlay.ATTRS{
     default_enabled=true,
     frame={w=30, h=LIST_MAX_HEIGHT+2},
+    overlay_onupdate_max_freq_seconds=5,
 }
 
 function NotifyOverlay:init()
@@ -64,6 +65,11 @@ end
 function NotifyOverlay:overlay_onupdate()
     local choices = {}
     local is_adv = dfhack.world.isAdventureMode()
+    if is_adv then
+        self.overlay_onupdate_max_freq_seconds=0
+    else
+        self.overlay_onupdate_max_freq_seconds=5
+    end
     for _, notification in ipairs(notifications.NOTIFICATIONS_BY_IDX) do
         if not notifications.config.data[notification.name].enabled then goto continue end
         local fn = get_fn(notification, is_adv)

internal/notify/notifications.lua

@@ -267,6 +267,79 @@ local function get_stranded_message()
     end
 end
 
+local function get_blood()
+    return dfhack.world.getAdventurer().body.blood_count
+end
+
+local function get_max_blood()
+    return dfhack.world.getAdventurer().body.blood_max
+end
+
+local function get_max_breath()
+    local adventurer = dfhack.world.getAdventurer()
+    local toughness = dfhack.units.getPhysicalAttrValue(adventurer, df.physical_attribute_type.TOUGHNESS)
+    local endurance = dfhack.units.getPhysicalAttrValue(adventurer, df.physical_attribute_type.ENDURANCE)
+    local base_ticks = 200
+
+    return math.floor((endurance + toughness) / 4) + base_ticks
+end
+
+local function get_breath()
+    return get_max_breath() - dfhack.world.getAdventurer().counters.suffocation
+end
+
+local function get_suffocation_message()
+    if get_breath() < get_max_breath() then
+        local label_text = {}
+        local suffocation_pen = COLOR_LIGHTCYAN
+        -- if self.blink then
+        --     suffocation_pen = COLOR_CYAN
+        -- end
+        table.insert(label_text, {text = "Suffocating!", pen = suffocation_pen, width = 14})
+
+        local bar_width = 16
+        local percentage = get_breath() / get_max_breath()
+        local barstop = math.floor((bar_width * percentage) + 0.5)
+        for idx = 0, bar_width-1 do
+            local color = COLOR_LIGHTCYAN
+            local char = 219
+            if idx >= barstop then
+                -- offset it to the hollow graphic
+                color = COLOR_DARKGRAY
+                char = 177
+            end
+            table.insert(label_text, { width = 1, tile={ch=char, fg=color}})
+        end
+        return label_text
+    end
+end
+
+local function get_bleeding_message()
+    if get_blood() < get_max_blood() then
+        local label_text = {}
+        local bloodloss_pen = COLOR_RED
+        -- if self.blink then
+        --     bloodloss_pen = COLOR_LIGHTRED
+        -- end
+        table.insert(label_text, {text = "Bloodloss!", pen = bloodloss_pen, width = 14})
+
+        local margin = 14
+        local percentage = get_blood() / get_max_blood()
+        local barstop = math.floor((margin * percentage) + 0.5)
+        for idx = 0, margin-1 do
+            local color = COLOR_RED
+            local char = 219
+            if idx >= barstop then
+                -- offset it to the hollow graphic
+                color = COLOR_DARKGRAY
+                char = 177
+            end
+            table.insert(label_text, { width = 1, tile={ch=char, fg=color}})
+        end
+        return label_text
+    end
+end
+
 -- the order of this list controls the order the notifications will appear in the overlay
 NOTIFICATIONS_BY_IDX = {
     {
@@ -442,6 +515,20 @@ NOTIFICATIONS_BY_IDX = {
         dwarf_fn=curry(injured_units, for_injured, 'injured citizen'),
         on_click=curry(zoom_to_next, for_injured),
     },
+    {
+        name='suffocation_adv',
+        desc='Shows a suffocation bar when you are drowning or breathless.',
+        default=true,
+        adv_fn=get_suffocation_message,
+        on_click=nil,
+    },
+    {
+        name='bleeding_adv',
+        desc='Shows a bleeding bar when you are losing blood.',
+        default=true,
+        adv_fn=get_bleeding_message,
+        on_click=nil,
+    },
 }
 
 NOTIFICATIONS_BY_NAME = {}