Merge branch 'DFHack:master' into caravan-work

Author: SilasD

.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.3
+  rev: 0.34.1
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

autocheese.lua

@@ -1,14 +1,12 @@
 --@module = true
 
-local ic = reqscript('idle-crafting')
-
 ---make cheese using a specific barrel and workshop
 ---@param barrel df.item
 ---@param workshop df.building_workshopst
 ---@return df.job
 function makeCheese(barrel, workshop)
     ---@type df.job
-    local job = ic.make_job()
+    local job = dfhack.job.createLinked()
     job.job_type = df.job_type.MakeCheese
 
     local jitem = df.job_item:new()
@@ -22,29 +20,17 @@ function makeCheese(barrel, workshop)
         dfhack.error('could not attach item')
     end
 
-    ic.assignToWorkshop(job, workshop)
+    dfhack.job.assignToWorkshop(job, workshop)
     return job
 end
 
-
-
----unit is ready to take jobs
+---checks that unit can path to workshop
 ---@param unit df.unit
+---@param workshop df.building_workshopst
 ---@return boolean
-function unitIsAvailable(unit)
-    if unit.job.current_job then
-        return false
-    elseif #unit.individual_drills > 0 then
-        return false
-    elseif unit.flags1.caged or unit.flags1.chained then
-        return false
-    elseif unit.military.squad_id ~= -1 then
-        local squad = df.squad.find(unit.military.squad_id)
-        -- this lookup should never fail
-        ---@diagnostic disable-next-line: need-check-nil
-        return #squad.orders == 0 and squad.activity == -1
-    end
-    return true
+function canAccessWorkshop(unit, workshop)
+    local workshop_position = xyz2pos(workshop.centerx, workshop.centery, workshop.z)
+    return dfhack.maps.canWalkBetween(unit.pos, workshop_position)
 end
 
 ---check if unit can perform labor at workshop
@@ -54,8 +40,8 @@ end
 ---@return boolean
 function availableLaborer(unit, unit_labor, workshop)
     return unit.status.labors[unit_labor]
-       and unitIsAvailable(unit)
-       and ic.canAccessWorkshop(unit, workshop)
+       and dfhack.units.isJobAvailable(unit)
+       and canAccessWorkshop(unit, workshop)
 end
 
 ---find unit with a particular labor enabled

autotraining.lua

@@ -139,9 +139,9 @@ end
 
 function getTrainingSquads()
     local squads = {}
-    for squad_id, _ in pairs(state.training_squads) do
+    for squad_id, active in pairs(state.training_squads) do
         local squad = df.squad.find(squad_id)
-        if squad then
+        if active and squad then
             table.insert(squads, squad)
         else
             -- setting to nil during iteration is permitted by lua

ban-cooking.lua

@@ -80,9 +80,18 @@ funcs.booze = function()
 end
 
 funcs.honey = function()
-    local mat = dfhack.matinfo.find("CREATURE:HONEY_BEE:HONEY")
-    if mat then
-        ban_cooking('honey bee honey', mat.type, mat.index, df.item_type.LIQUID_MISC, -1)
+    for _, c in ipairs(df.global.world.raws.creatures.all) do
+        for _, m in ipairs(c.material) do
+            if m.flags.EDIBLE_COOKED then
+                for _, s in ipairs(m.reaction_product.id) do
+                    if s.value == "DRINK_MAT" then
+                        local matinfo = dfhack.matinfo.find(c.creature_id, m.id)
+                        ban_cooking(c.name[2] .. ' ' .. m.id, matinfo.type, matinfo.index, df.item_type.LIQUID_MISC, -1)
+                        break
+                    end
+                end
+            end
+        end
     end
 end
 

changelog.txt

@@ -38,13 +38,64 @@ Template for new versions:
 
 ## Removed
 
+# 53.01-r1
+
+## New Tools
+- `fix/symbol-unstick`: unstick noble symbols that cannot be re-designated.
+- `resize-armor`: resize armor or clothing item to any creature size.
+
+## New Features
+
+## Fixes
+- `autotraining`: squads once used for training then disabled now properly are treated as disabled.
+
+## Misc Improvements
+
+## Removed
+- `fix/archery-practice`: removed from the control panel's bug fixes tab.
+
+# 52.05-r2
+
+## New Tools
+
+## New Features
+
+## Fixes
+- `fix/archery-practice`: now splits instead of combining ammo items in quivers, and moves quivers to end of unit's inventory list
+
+## Misc Improvements
+
+## Removed
+
+# 52.05-r1
+
+## New Tools
+- `fix/archery-practice`: combine ammo items in units' quivers to fix 'Soldier (no item)' issue
+- `gui/adv-finder`: UI for tracking historical figures and artifacts in adventure mode
+- `store-owned`: task owned items to be stored in the owner's room furniture
+
+## New Features
+
+## Fixes
+- `ban-cooking`: bans honey added by creatures other than vanilla honey bee
+- `uniform-unstick`: added quivers, backpacks, and flasks/waterskins to uniform analysis
+- `uniform-unstick`: the ``--drop`` option now only evaluates clothing as possible items to drop
+- `uniform-unstick`: the ``--free`` option no longer redundantly reports an improperly assigned item when that item is removed from a uniform
+- `uniform-unstick`: the ``--drop`` and ``--free`` options now only drop items which are actually in a unit's inventory
+- `uniform-unstick`: the ``--all`` and ``--drop`` options, when used together, now print the separator line between each unit's report in the proper place
+
+## Misc Improvements
+- adapt Lua tools to use new API functionality for creating and assigning jobs
+- `idle-crafting`: properly interrupt interruptible (i.e. "green") social activities
+
+## Removed
+
 # 52.03-r2
 
 ## 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

docs/fix/archery-practice.rst

@@ -0,0 +1,75 @@
+fix/archery-practice
+====================
+
+.. dfhack-tool::
+    :summary: Fix quivers and training ammo items to allow archery practice to take place.
+    :tags: fort bugfix items
+
+Make quivers the last item in the inventory of every ranged unit currently
+training and split stacks of ammo items assigned for training inside the
+quivers to ensure each training unit can have more than one stack to allow
+archery practice to take place.
+
+Note
+----
+
+The bug preventing units from initiating archery practice was fixed in
+DF version 53.01. See below for more information about the issue and how
+this tool works to mitigate it. Running this tool for any other archery
+related issues will not yield useful results.
+
+Usage
+-----
+
+``fix/archery-practice``
+    Move quivers to the end of units' inventory list and split stacks of
+    training ammo items inside the quivers.
+
+``fix/archery-practice -q``, ``fix/archery-practice --quiet``
+    Move quivers to the end of units' inventory list and split stacks of
+    training ammo items inside the quivers. Do not print to console.
+
+This tool will set quivers as the last item in the inventory of units in
+squads that are currently set to train as well as split ammo items inside
+their quivers into multiple stacks if a quiver contains only ammo item
+with a stack size of 25 or larger assigned for training. The original
+training ammo item with a reduced stack size will remain in the quiver
+while new ammo items split from it will be placed on the ground where
+the unit is located to be picked up later.
+
+Why are archers not practicing archery?
+---------------------------------------
+
+Due to a bug in the game, a unit that is scheduled to train will not be
+able to practice archery at the archery range when their quiver contains
+only one stack of ammo item assigned for training. This is sometimes
+indicated on the unit by the 'Soldier (no item)' status.
+
+During versions 52.03 and 52.04, the issue was the complete reverse;
+units would not practice when their quivers contained more than one
+stack of ammo items assigned for training.
+
+Another issue in 52.05 is that units will not practice archery if their
+quiver is not the last item in their inventory.
+
+This tool provides an interim remedy by moving quivers to the end of
+every training unit's inventory list and splitting stacks of ammo items
+inside their quivers to prompt the game to give them multiple stacks
+of training ammo items.
+
+Limitations
+-----------
+
+The game has a tendency to reshuffle the squad's ammo/unit pairings if
+the newly split ammo items are force paired to the units holding the
+original ammo item. As a compromise, the new items are placed on the
+ground instead and added to the squad's training ammo assignment pool,
+so that the game can distribute the items normally without causing the
+pairing for ammo items already in quivers to be reshuffled.
+
+Although this tool would allow units to practice archery, the activity
+will still be aborted once they have only one stack of training ammo
+item remaining in their quivers. Practicing units will gain skill from
+practice, but not the positive thought they would have gained from
+having completed the activity. Once the game assigns more training
+ammo items to them, they can continue practicing archery.

docs/fix/symbol-unstick.rst

@@ -0,0 +1,18 @@
+fix/symbol-unstick
+==================
+
+.. dfhack-tool::
+    :summary: Unstick noble symbols that cannot be re-designated.
+    :tags: fort bugfix items
+
+Remove symbol designation from artifacts that cannot be re-designated
+after the noble's promotion to a higher position.
+
+Usage
+-----
+
+``fix/symbol-unstick``
+
+Select an artifact that was designated as a noble's symbol and run the
+command to remove its designation as a symbol. The operation will only
+be performed if the symbol is claimed by a vacated noble position.

docs/gui/adv-finder.rst

@@ -0,0 +1,112 @@
+gui/adv-finder
+==============
+
+.. dfhack-tool::
+    :summary: Find and track historical figures and artifacts
+    :tags: adventure armok inspection items units
+
+A real-time tracker for historical figures and artifacts. Select a target by
+clicking the settings icon [☼] and selecting an entry from the list in the
+relevant tab. The list can be filtered by search string, as well as by
+excluding dead figures (displayed in red text). Artifacts can exclude books,
+and the "dead" option excludes artifacts held by dead figures (which are
+generally unrecoverable). Dismissing the screen (e.g., right-click) will
+close the target search window first. A second dismissal will close the
+finder window, but target settings will be preserved until the world is
+unloaded.
+
+Your coordinates will be kept up to date alongside your target's. There are
+two types of coordinates, and they will be displayed as long as they can be
+determined.
+
+==========  ==========
+Coord Type  Meaning
+==========  ==========
+Global      Distance in map blocks from the world origin (northwest corner).
+            The adventurer usually moves by 3 blocks during fast travel, but
+            slows to 1 when the zoomed site map is displayed. Equivalent to
+            16 local tiles. Always available except for targets with an
+            indeterminate location.
+Local       Tile coordinates, available outside of fast travel and sleeping.
+            Your target's local coordinates are displayed when nearby and
+            loaded. Local coordinates will remain consistent within a site, but
+            may jump around in the wilderness as areas of the world are loaded.
+==========  ==========
+
+For global coordinates, the Z component will only be displayed if it can be
+specifically determined by the location type. This represents an underground
+layer depth, so the surface is indicated by ``Z0`` and the first cavern layer
+is ``Z-1``.
+
+A compass and relative coordinates will be displayed. The relative coordinate
+display uses the most precise coordinate type shared between you and your
+target.
+
+There are six types of location types displayed for targets:
+
+=============  ==========
+Location Type  Meaning
+=============  ==========
+Nearby         The target is loaded into the map area and the local
+               coordinates will be displayed. If you don't see this when you're
+               in the correct area and outside fast travel, then the target
+               isn't loading for some reason and you'll never be able to find
+               them.
+Site           The target is located within a site. The text displays
+               "At <Sitename>" and the global coords will represent the center
+               of the site if the target doesn't track its own precise
+               coordinates (e.g., worldgen being vague).
+Traveling      The target is traveling around the world map like an army.
+Wilderness     The target is somewhere on the surface not in a site.
+Underground    The target is somewhere in the caverns not in a site.
+None           The target's location isn't defined in the game world.
+               Maybe they're a deity. Maybe they got dropped off in limbo
+               after their army disbanded. If they're dead, the location
+               wasn't recorded properly in history. The text displays "Missing"
+               if they're dead or can die of old age, else "Transcendent"
+               because nothing can touch them.
+=============  ==========
+
+Dead figures generally can't be encountered at all, and they take their items
+with them if they weren't separated properly by worldgen. The coord given is
+usually a death or abstract burial location, but the corpse isn't guaranteed to
+exist. Generally, wilderness and underground locations only have coords if you
+left something there in adventure mode. Anything lost there during worldgen or a
+fort mode mission likely can't be located. Anything in a site is usually a safe
+bet, but sometimes items won't load. (Fort missions can be used to acquire these
+for later retrieval, however.) Traveling targets are always valid.
+
+Usage
+-----
+
+::
+
+    gui/adv-finder [<options>]
+
+Examples
+--------
+
+``gui/adv-finder``
+    Open the finder window (unless already open). Target will be blank on first
+    use, but maintained on future invocations.
+``gui/adv-finder --histfig 1234``
+    Track the historical figure with ID #1234. Finder will be opened if not
+    already.
+``gui/adv-finder -h -1 -a -1``
+    Clear any target so it's just the adventurer. Finder will be opened if not
+    already.
+``gui/adv-finder --debug``
+    Display selected target IDs in the finder window title bar. Finder will be
+    opened if not already. This setting isn't saved, so it can be disabled by
+    invoking ``gui/adv-finder`` again without the option.
+
+Options
+-------
+
+``-h``, ``--histfig <id>``
+    Set the target to the historical figure with the given ID.
+``-a``, ``--artifact <id>``
+    Set the target to the artifact record with the given ID. (Not an item ID!)
+``-d``, ``--debug``
+    Display selected target IDs in the finder window title bar. Doesn't persist
+    between invocations.

docs/gui/aquifer.rst

@@ -12,7 +12,7 @@ tiles or warm tiles). Note that "just damp" tiles will still be highlighted if
 they are otherwise already visible.
 
 You can draw boxes around areas of tiles to alter their aquifer properties, or
-you can use the :kbd:`Ctrl`:kbd:`A`` shortcut to affect entire layers at a time.
+you can use the :kbd:`Ctrl`:kbd:`A` shortcut to affect entire layers at a time.
 
 If you want to see where the aquifer tiles are so you can designate digging,
 please run `gui/reveal`. If you only want to see the aquifer tiles and not