Merge branch 'master' into c3r341-global-necronomicon

Author: myk002

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

changelog.txt

@@ -28,6 +28,8 @@ Template for new versions:
 
 ## New Tools
 - `fix/wildlife`: prevent wildlife from getting stuck when trying to exit the map. This fix needs to be enabled manually in `gui/control-panel` on the Bug Fixes tab since not all players want this bug to be fixed.
+- `immortal-cravings`: allow immortals to satisfy their cravings for food and drink
+- `justice`: various functions pertaining to the justice system, currently with a command to pardon a unit's prison sentence
 
 ## New Features
 - `force`: support the ``Wildlife`` event to allow additional wildlife to enter the map
@@ -38,6 +40,10 @@ Template for new versions:
 - `makeown`: halt any hostile jobs the unit may be engaged in, like kidnapping
 - `fix/loyaltycascade`: allow the fix to work on non-dwarven citizens
 - `control-panel`: fix setting numeric preferences from the commandline
+- `gui/quickfort`: fix build mode evluation rules to allow placement of various furniture and constructions on tiles with stair shapes or without orthagonal floor.
+- `emigration`: save-and-reload no longer resets the emigration cycle timeout, making gameplay more consistent
+- `geld`, `ungeld`: fix gelding/ungelding being undone for units who are historical figures when reloading a game
+- `rejuvenate`: fix error when specifying ``--age`` parameter
 
 ## Misc Improvements
 - `control-panel`: Add realistic-melting tweak to control-panel registry

docs/immortal-cravings.rst

@@ -0,0 +1,19 @@
+immortal-cravings
+=================
+
+.. dfhack-tool::
+    :summary: Allow immortals to satisfy their cravings for food and drink.
+    :tags: fort gameplay
+
+When enabled, this script watches your fort for units that have no physiological
+need to eat or drink but still have personality needs that can only be satisfied
+by eating or drinking (e.g. necromancers). This enables those units to help
+themselves to a drink or a meal when they crave one and are not otherwise
+occupied.
+
+Usage
+-----
+
+::
+
+    enable immortal-cravings

docs/justice.rst

@@ -0,0 +1,34 @@
+justice
+=======
+
+.. dfhack-tool::
+    :summary: Mess with the justice system.
+    :tags: fort armok units
+
+This tool allows control over aspects of the justice system, such as the
+ability to pardon criminals.
+
+Usage
+-----
+
+::
+    justice [list]
+    justice pardon [--unit <id>]
+
+Pardon the selected unit or the one specified by unit id (if provided).
+Currently only applies to prison time and doesn't cancel beatings or
+hammerings.
+
+Examples
+--------
+
+``justice``
+    List the convicts currently serving sentences.
+``justice pardon``
+    Commutes the sentence of the currently selected convict.
+
+Options
+-------
+
+``-u``, ``--unit <id>``
+    Specifies a specific unit instead of using a selected unit.

emigration.lua

@@ -1,18 +1,27 @@
 --@module = true
 --@enable = true
 
+local utils = require('utils')
+
 local GLOBAL_KEY = 'emigration' -- used for state change hooks and persistence
 
-enabled = enabled or false
+local function get_default_state()
+    return {enabled=false, last_cycle_tick=0}
+end
+
+state = state or get_default_state()
 
 function isEnabled()
-    return enabled
+    return state.enabled
 end
 
 local function persist_state()
-    dfhack.persistent.saveSiteData(GLOBAL_KEY, {enabled=enabled})
+    dfhack.persistent.saveSiteData(GLOBAL_KEY, state)
 end
 
+local TICKS_PER_MONTH = 33600
+local TICKS_PER_YEAR = 12 * TICKS_PER_MONTH
+
 function desireToStay(unit,method,civ_id)
     -- on a percentage scale
     local value = 100 - unit.status.current_soul.personality.stress / 5000
@@ -191,27 +200,36 @@ function checkmigrationnow()
     else
         for _, civ_id in pairs(merchant_civ_ids) do checkForDeserters('merchant', civ_id) end
     end
+
+    state.last_cycle_tick = dfhack.world.ReadCurrentTick() + TICKS_PER_YEAR * dfhack.world.ReadCurrentYear()
 end
 
 local function event_loop()
-    if enabled then
-        checkmigrationnow()
-        dfhack.timeout(1, 'months', event_loop)
+    if state.enabled then
+        local current_tick = dfhack.world.ReadCurrentTick() + TICKS_PER_YEAR * dfhack.world.ReadCurrentYear()
+        if current_tick - state.last_cycle_tick < TICKS_PER_MONTH then
+            local timeout_ticks = state.last_cycle_tick - current_tick + TICKS_PER_MONTH
+            dfhack.timeout(timeout_ticks, 'ticks', event_loop)
+        else
+            checkmigrationnow()
+            dfhack.timeout(1, 'months', event_loop)
+        end
     end
 end
 
 dfhack.onStateChange[GLOBAL_KEY] = function(sc)
     if sc == SC_MAP_UNLOADED then
-        enabled = false
+        state.enabled = false
         return
     end
 
     if sc ~= SC_MAP_LOADED or df.global.gamemode ~= df.game_mode.DWARF then
         return
     end
 
-    local persisted_data = dfhack.persistent.getSiteData(GLOBAL_KEY, {enabled=false})
-    enabled = persisted_data.enabled
+    state = get_default_state()
+    utils.assign(state, dfhack.persistent.getSiteData(GLOBAL_KEY, state))
+
     event_loop()
 end
 
@@ -230,11 +248,11 @@ if dfhack_flags and dfhack_flags.enable then
 end
 
 if args[1] == "enable" then
-    enabled = true
+    state.enabled = true
 elseif args[1] == "disable" then
-    enabled = false
+    state.enabled = false
 else
-    print('emigration is ' .. (enabled and 'enabled' or 'not enabled'))
+    print('emigration is ' .. (state.enabled and 'enabled' or 'not enabled'))
     return
 end
 

geld.lua

@@ -1,39 +1,17 @@
--- Gelds or ungelds animals
--- Written by Josh Cooper(cppcooper) on 2019-12-10, last modified: 2020-02-23
-
-utils = require('utils')
+local utils = require('utils')
 
 local validArgs = utils.invert({
     'unit',
     'toggle',
     'ungeld',
     'help',
-    'find',
 })
 local args = utils.processArgs({...}, validArgs)
-local help = [====[
-
-geld
-====
-Geld allows the user to geld and ungeld animals.
-
-Valid options:
-
-``-unit <id>``: Gelds the unit with the specified ID.
-                This is optional; if not specified, the selected unit is used instead.
-
-``-ungeld``:    Ungelds the specified unit instead (see also `ungeld`).
-
-``-toggle``:    Toggles the gelded status of the specified unit.
 
-``-help``:      Shows this help information
-
-]====]
-
-unit=nil
+local unit = nil
 
 if args.help then
-    print(help)
+    print(dfhack.script_help())
     return
 end
 
@@ -42,7 +20,7 @@ if args.unit then
     if id then
         unit = df.unit.find(id)
     else
-        qerror("Invalid ID provided.")
+        qerror("Invalid unit ID provided.")
     end
 else
     unit = dfhack.gui.getSelectedUnit()
@@ -53,55 +31,75 @@ if not unit then
 end
 
 if unit.sex == df.pronoun_type.she then
-    qerror("Cannot geld female animals")
-    return
+    qerror("Cannot geld female animals.")
 end
 
-function FindBodyPart(unit,newstate)
-    bfound = false
-    for i,wound in ipairs(unit.body.wounds) do
-        for j,part in ipairs(wound.parts) do
-            if unit.body.wounds[i].parts[j].flags2.gelded ~= newstate then
-                bfound = true
-                if newstate ~= nil then
-                    unit.body.wounds[i].parts[j].flags2.gelded = newstate
-                end
-            end
+-- Find the geldable body part id, returns -1 on failure
+local function FindBodyPartId(unit)
+    for i,part in ipairs(unit.body.body_plan.body_parts) do
+        if part.flags.GELDABLE then
+            return i
         end
     end
-    return bfound
+    return -1
 end
 
-function AddParts(unit)
-    for i,wound in ipairs(unit.body.wounds) do
-        if wound.id == 1 and #wound.parts == 0 then
-            utils.insert_or_update(unit.body.wounds[i].parts,{ new = true, body_part_id = 1 }, 'body_part_id')
-        end
+-- Sets the gelded status of a unit, returns false on failure
+local function SetGelded(unit, state)
+    -- Gelded status is set in a number of places:
+    -- unit.flags3
+    -- unit.body.wounds
+    -- unit.body.components.body_part_status
+
+    local part_id = FindBodyPartId(unit)
+    if part_id == -1 then
+        print("Could not find a geldable body part.")
+        return false
     end
-end
 
-function Geld(unit)
-    unit.flags3.gelded = true
-    if not FindBodyPart(unit,true) then
-        utils.insert_or_update(unit.body.wounds,{ new = true, id = unit.body.wound_next_id }, 'id')
+    unit.flags3.gelded = state
+
+    if state then
+        -- Create new wound
+        local _,wound,_ = utils.insert_or_update(unit.body.wounds, { new = true, id = unit.body.wound_next_id }, 'id')
         unit.body.wound_next_id = unit.body.wound_next_id + 1
-        AddParts(unit)
-        if not FindBodyPart(unit,true) then
-            error("could not find body part")
+        local _,part,_ = utils.insert_or_update(wound.parts, { new = true, body_part_id = part_id}, 'body_part_id')
+        part.flags2.gelded = true
+    else
+        -- Remove gelding from any existing wounds
+        for _,wound in ipairs(unit.body.wounds) do
+            for _,part in ipairs(wound.parts) do
+                part.flags2.gelded = false
+            end
+        end
+    end
+
+    if state then
+        -- Set part status to gelded
+        unit.body.components.body_part_status[part_id].gelded = true
+    else
+        -- Remove gelded status from all parts
+        for _,part in ipairs(unit.body.components.body_part_status) do
+            part.gelded = false
         end
     end
-    print(string.format("unit %s gelded.",unit.id))
+    return true
 end
 
-function Ungeld(unit)
-    unit.flags3.gelded = false
-    FindBodyPart(unit,false)
-    print(string.format("unit %s ungelded.",unit.id))
+local function Geld(unit)
+    if SetGelded(unit, true) then
+        print(string.format("Unit %s gelded.", unit.id))
+    else
+        print(string.format("Failed to geld unit %s.", unit.id))
+    end
 end
 
-if args.find then
-    print(FindBodyPart(unit) and "found" or "not found")
-    return
+local function Ungeld(unit)
+    if SetGelded(unit, false) then
+        print(string.format("Unit %s ungelded.", unit.id))
+    else
+        print(string.format("Failed to ungeld unit %s.", unit.id))
+    end
 end
 
 local oldstate = dfhack.units.isGelded(unit)
@@ -122,5 +120,5 @@ if newstate ~= oldstate then
         Ungeld(unit)
     end
 else
-    qerror(string.format("unit %s is already %s", unit.id, oldstate and "gelded" or "ungelded"))
+    qerror(string.format("Unit %s is already %s.", unit.id, oldstate and "gelded" or "ungelded"))
 end

gui/journal.lua

@@ -5,7 +5,6 @@ local gui = require 'gui'
 local widgets = require 'gui.widgets'
 local utils = require 'utils'
 local json = require 'json'
-local text_editor = reqscript('internal/journal/text_editor')
 local shifter = reqscript('internal/journal/shifter')
 local table_of_contents = reqscript('internal/journal/table_of_contents')
 
@@ -113,7 +112,7 @@ function JournalWindow:init()
             interior_b=true,
             frame_style_t=false,
         },
-        text_editor.TextEditor{
+        widgets.TextArea{
             view_id='journal_editor',
             frame={t=1, b=3, l=25, r=0},
             resize_min={w=30, h=10},

gui/manipulator.lua

@@ -1341,9 +1341,12 @@ function ManipulatorOverlay:init()
     }
 end
 
-OVERLAY_WIDGETS = {
-    launcher=ManipulatorOverlay,
-}
+--
+-- disable overlay widget while tool is still in dark launch mode
+--
+-- OVERLAY_WIDGETS = {
+--     launcher=ManipulatorOverlay,
+-- }
 
 if dfhack_flags.module then return end
 

gui/notify.lua

@@ -132,14 +132,14 @@ DwarfNotifyOverlay.ATTRS{
 }
 
 local DWARFMODE_CONFLICTING_TOOLTIPS = utils.invert{
-    df.main_hover_instruction.InfoUnits,
-    df.main_hover_instruction.InfoJobs,
-    df.main_hover_instruction.InfoPlaces,
-    df.main_hover_instruction.InfoLabors,
-    df.main_hover_instruction.InfoWorkOrders,
-    df.main_hover_instruction.InfoNobles,
-    df.main_hover_instruction.InfoObjects,
-    df.main_hover_instruction.InfoJustice,
+    df.main_hover_instruction.MAIN_OPEN_CREATURES,
+    df.main_hover_instruction.MAIN_OPEN_TASKS,
+    df.main_hover_instruction.MAIN_OPEN_PLACES,
+    df.main_hover_instruction.MAIN_OPEN_LABOR,
+    df.main_hover_instruction.MAIN_OPEN_WORK_ORDERS,
+    df.main_hover_instruction.MAIN_OPEN_NOBLES,
+    df.main_hover_instruction.MAIN_OPEN_OBJECTS,
+    df.main_hover_instruction.MAIN_OPEN_JUSTICE,
 }
 
 local mi = df.global.game.main_interface