Merge remote-tracking branch 'upstream/master' into SquidHack

Author: realSquidCoder

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.33.0
+  rev: 0.33.2
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

ban-cooking.lua

@@ -81,7 +81,9 @@ end
 
 funcs.honey = function()
     local mat = dfhack.matinfo.find("CREATURE:HONEY_BEE:HONEY")
-    ban_cooking('honey bee honey', mat.type, mat.index, df.item_type.LIQUID_MISC, -1)
+    if mat then
+        ban_cooking('honey bee honey', mat.type, mat.index, df.item_type.LIQUID_MISC, -1)
+    end
 end
 
 funcs.tallow = function()

changelog.txt

@@ -29,15 +29,28 @@ Template for new versions:
 ## New Tools
 - `autotraining`: new tool to assign citizens to a military squad when they need Martial Training
 - `gui/autotraining`: configuration tool for autotraining
+- `entomb`: allow any unit that has a corpse or body parts to be assigned a tomb zone
+
+- `husbandry`: Automatically milk and shear animals at nearby farmer's workshops
 
 ## New Features
 - `deathcause`: added functionality to this script to fetch cause of death programatically
 
 ## Fixes
-
+- `ban-cooking`: will not fail trying to ban honey if the world has no honey
+- `confirm`: only show pause option for pausable confirmations
+- `confirm`: when editing a uniform, confirm discard of changes when exiting with Escape
+- `confirm`: when removing a manager order, show correct order description when using non-100% interface setting
+- `confirm`: when removing a manager order, show correct order description after prior order removal or window resize (when scrolled to bottom of order list)
+- `confirm`: when removing a manager order, show specific item/job type for ammo, shield, helm, gloves, shoes, trap component, and meal orders
+- `confirm`: the pause option now pauses individual confirmation types, allowing multiple different confirmations to be paused independently
 - `immortal-cravings`: prioritize high-value meals, properly split of portions, and don't go eating or drinking on a full stomach
+- `uniform-unstick`: no longer causes units to equip multiples of assigned items
+- `caravan`: in the pedestal item assignment dialog, add new items at the end of the list of displayed items instead of at a random position
+- `caravan`: in the pedestal item assignment dialog, consistently remove items from the list of displayed items
 
 ## Misc Improvements
+- `devel/hello-world`: updated to show off the new Slider widget
 
 ## Removed
 

confirm.lua

@@ -63,6 +63,7 @@ function ConfirmOverlay:init()
             }
         end
     end
+    self.paused_confs = {}
 end
 
 function ConfirmOverlay:preUpdateLayout()
@@ -77,11 +78,14 @@ function ConfirmOverlay:preUpdateLayout()
 end
 
 function ConfirmOverlay:overlay_onupdate()
-    if self.paused_conf and
-        not dfhack.gui.matchFocusString(self.paused_conf.context,
+    for conf in pairs(self.paused_confs) do
+        if not dfhack.gui.matchFocusString(conf.context,
                 dfhack.gui.getDFViewscreen(true))
-    then
-        self.paused_conf = nil
+        then
+            self.paused_confs[conf] = nil
+        end
+    end
+    if not next(self.paused_confs) then
         self.overlay_onupdate_max_freq_seconds = 300
     end
 end
@@ -108,19 +112,22 @@ function ConfirmOverlay:matches_conf(conf, keys, scr)
 end
 
 function ConfirmOverlay:onInput(keys)
-    if self.paused_conf or self.simulating then
+    if self.simulating then
         return false
     end
     local scr = dfhack.gui.getDFViewscreen(true)
     for id, conf in pairs(specs.REGISTRY) do
         if specs.config.data[id].enabled and self:matches_conf(conf, keys, scr) then
+            if self.paused_confs[conf] then
+                return false
+            end
             local mouse_pos = xy2pos(dfhack.screen.getMousePos())
             local propagate_fn = function(pause)
                 if conf.on_propagate then
                     conf.on_propagate()
                 end
                 if pause then
-                    self.paused_conf = conf
+                    self.paused_confs[conf] = true
                     self.overlay_onupdate_max_freq_seconds = 0
                 end
                 if keys._MOUSE_L then
@@ -131,8 +138,9 @@ function ConfirmOverlay:onInput(keys)
                 gui.simulateInput(scr, keys)
                 self.simulating = false
             end
+            local pause_fn = conf.pausable and curry(propagate_fn, true) or nil
             dialogs.showYesNoPrompt(conf.title, utils.getval(conf.message):wrap(45), COLOR_YELLOW,
-                propagate_fn, nil, curry(propagate_fn, true), curry(dfhack.run_script, 'gui/confirm', tostring(conf.id)))
+                propagate_fn, nil, pause_fn, curry(dfhack.run_script, 'gui/confirm', tostring(conf.id)))
             return true
         end
     end

devel/hello-world.lua

@@ -12,17 +12,27 @@ local HIGHLIGHT_PEN = dfhack.pen.parse{
 
 HelloWorldWindow = defclass(HelloWorldWindow, widgets.Window)
 HelloWorldWindow.ATTRS{
-    frame={w=20, h=14},
+    frame={w=25, h=25},
     frame_title='Hello World',
     autoarrange_subviews=true,
-    autoarrange_gap=1,
+    autoarrange_gap=2,
+    resizable=true,
+    resize_min={w=25, h=25},
 }
 
 function HelloWorldWindow:init()
+    local LEVEL_OPTIONS = {
+        {label='Low', value=1},
+        {label='Medium', value=2},
+        {label='High', value=3},
+        {label='Pro', value=4},
+        {label='Insane', value=5},
+    }
+
     self:addviews{
         widgets.Label{text={{text='Hello, world!', pen=COLOR_LIGHTGREEN}}},
         widgets.HotkeyLabel{
-            frame={l=0, t=0},
+            frame={l=0},
             label='Click me',
             key='CUSTOM_CTRL_A',
             on_activate=self:callback('toggleHighlight'),
@@ -32,6 +42,28 @@ function HelloWorldWindow:init()
             frame={w=10, h=5},
             frame_style=gui.INTERIOR_FRAME,
         },
+        widgets.Divider{
+            frame={h=1},
+            frame_style_l=false,
+            frame_style_r=false,
+        },
+        widgets.CycleHotkeyLabel{
+            view_id='level',
+            frame={l=0, w=20},
+            label='Level:',
+            key_back='CUSTOM_SHIFT_C',
+            key='CUSTOM_SHIFT_V',
+            options=LEVEL_OPTIONS,
+            initial_option=LEVEL_OPTIONS[1].value,
+        },
+        widgets.Slider{
+            frame={l=1},
+            num_stops=#LEVEL_OPTIONS,
+            get_idx_fn=function()
+                return self.subviews.level:getOptionValue()
+            end,
+            on_change=function(idx) self.subviews.level:setOption(idx) end,
+        },
     }
 end
 

docs/entomb.rst

@@ -0,0 +1,66 @@
+entomb
+======
+
+.. dfhack-tool::
+    :summary: Entomb any corpse into tomb zones.
+    :tags: fort items buildings
+
+Assign any unit regardless of citizenship, residency, pet status,
+or affiliation to an unassigned tomb zone for burial.
+
+Usage
+-----
+
+``entomb [<options>]``
+
+Select a unit's corpse or body part, or specify the unit's ID
+when executing this script to assign an unassigned tomb zone to
+the unit, and flag the unit's corpse as well as any severed body
+parts to become valid items for interment.
+
+Optionally, specify the tomb zone's ID to assign a specific tomb
+zone to the unit.
+
+A non-citizen, non-resident, or non-pet unit that is still alive
+may even be assigned a tomb zone if they have lost any body part
+that can be placed inside a tomb, e.g. teeth or severed limbs.
+New corpse items after a tomb has already been assigned will not
+be properly interred until the script is executed again with the
+unit ID specified, or the unit's corpse or any body part selected.
+
+If executed on slaughtered animals, all its butchering returns will
+become valid burial items and no longer usable for cooking or crafting.
+
+Examples
+--------
+
+``entomb --unit <id>``
+    Assign an unassigned tomb zone to the unit with the specified ID.
+
+``entomb --tomb <id>``
+    Assign a tomb zone with the specified ID to the selected corpse
+    item's unit.
+
+``entomb -u <id> -t <id> -h``
+    Assign a tomb zone with the specified ID to the unit with the
+    specified ID and task all its burial items for simultaneous
+    hauling into the coffin in the tomb zone.
+
+Options
+-------
+
+``-u``, ``--unit <id>``
+    Specify the ID of the unit to be assigned to a tomb zone.
+
+``-t``, ``--tomb <id>``
+    Specify the ID of the zone into which a unit will be interred.
+
+``-a``, ``--add-item``
+    Add a selected item, or multiple items at the keyboard cursor's
+    position to be interred together with a unit. A unit or tomb
+    zone ID must be specified when calling this option.
+
+``-n``, ``--haul-now``
+    Task all of the unit's burial items for simultaneous hauling
+    into the coffin of its assigned tomb zone. This option can be
+    called even after a tomb zone is already assigned to the unit.

docs/husbandry.rst

@@ -0,0 +1,61 @@
+husbandry
+=========
+
+.. dfhack-tool::
+    :summary: Automatically milk and shear animals.
+    :tags: fort auto
+
+This tool will automatically create milking and shearing orders at farmer's
+workshops. Unlike the ``automilk`` and ``autoshear`` options from the control
+panel, which create general work orders for milking and shearing jobs,
+``husbandry`` will directly create jobs for individual animals at specific
+workshops. This allows milking and shearing jobs to reliably be created at
+nearby workshops (e.g. inside the pasture that an animal is assigned to),
+minimizing the labor required to re-pasture animals after milking or shearing,
+in particular in the case of multiple pastures that are far apart.
+
+
+Usage
+-----
+
+::
+
+    enable husbandry
+    husbandry [status]
+    husbandry now
+    husbandry [set|unset] [shearing|milking|roaming|pasture]+
+
+Flags can be set or unset using the command ``husbandry set`` or ``husbandry
+unset``. The ``shearing`` and ``milking`` flags (both enabled by default)
+control whether shearing or milking jobs are created at all.
+
+Further, ``husbandry`` distinguishes between animals that are assigned to
+pastures and those that are "roaming".
+
+If an animal is pastured and the pasture contains at least one workshop with the
+appropriate labour (i.e. milking or shearing) enabled, jobs will be created
+exclusively at those workshops. If the pasture does not contain a workshop with
+the appropriate labor enabled the behavior depends on the ``pasture`` flag
+(disabled by default): if set, no jobs will be created at workshops outside of
+pastures, otherwise jobs may be created at the closest workshop in your fort.
+
+For animals that are roaming, jobs will only be created if the ``roaming`` flag
+is set, which is the default. In this case, jobs are created at the closest
+workshop with the appropriate labours enabled.
+
+Examples
+--------
+
+``enable husbandry``
+    Start generating milking and shearing orders for animals.
+
+``husbandry now``
+    Run a single cycle, detecting animals that can be milked/sheared an creating
+    jobs. Does not require the tool to be enabled.
+
+``husbandry unset roaming``
+    Disable the creation of jobs for roaming animals.
+
+``husbandry set milking shearing pasture``
+    Create milking and shearing jobs for pastured animals, but only at workshops
+    inside their pastures.