Merge branch 'develop' into add_library_time_class

dhthwy · web-flow · commit 65a534b8923a · 2023-10-29T23:46:12.000-04:00
diff --git a/docs/changelog.txt b/docs/changelog.txt
@@ -54,16 +54,23 @@ Template for new versions:
 ## New Tools
 
 ## New Features
+- `prospect`: can now give you an estimate of resources from the embark screen. hover the mouse over a potential embark area and run `prospect`.
 
 ## Fixes
+- `stockpiles`: hide configure and help buttons when the overlay panel is minimized
+- `caravan`: price of vermin swarms correctly adjusted down. a stack of 10000 bees is worth 10, not 10000
 
 ## Misc Improvements
+- `buildingplan`: display how many items are available on the planner panel
+- `sort`: allow searching by profession on the squad assignment page
 
 ## Documentation
 
 ## API
+- ``Gui::revealInDwarfmodeMap``: gained ``highlight`` parameter to control setting the tile highlight on the zoom target
 
 ## Lua
+- ``dfhack.gui.revealInDwarfmodeMap``: gained ``highlight`` parameter to control setting the tile highlight on the zoom target
 
 ## Removed
 
diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst
@@ -1053,11 +1053,13 @@ Fortress mode
   Same as ``resetDwarfmodeView``, but also recenter if position is valid. If ``pause`` is false, skip pausing. Respects
   ``RECENTER_INTERFACE_SHUTDOWN_MS`` in DF's ``init.txt`` (the delay before input is recognized when a recenter occurs.)
 
-* ``dfhack.gui.revealInDwarfmodeMap(pos[,center])``
-  ``dfhack.gui.revealInDwarfmodeMap(x,y,z[,center])``
+* ``dfhack.gui.revealInDwarfmodeMap(pos[,center[,highlight]])``
+  ``dfhack.gui.revealInDwarfmodeMap(x,y,z[,center[,highlight]])``
 
-  Centers the view on the given coordinates. If ``center`` is true, make sure the
-  position is in the exact center of the view, else just bring it on screen.
+  Centers the view on the given coordinates. If ``center`` is true, make sure
+  the position is in the exact center of the view, else just bring it on screen.
+  If ``highlight`` is true, then mark the target tile with a pulsing highlight
+  until the player clicks somewhere else.
 
   ``pos`` can be a ``df.coord`` instance or a table assignable to a ``df.coord`` (see `lua-api-table-assignment`),
   e.g.::
diff --git a/docs/plugins/prospector.rst b/docs/plugins/prospector.rst
@@ -11,8 +11,8 @@ prospector
 .. dfhack-command:: prospect
    :summary: Shows a summary of resources that exist on the map.
 
-It can also calculate an estimate of resources available in the selected embark
-area.
+It can also calculate an estimate of resources available in the currently
+highlighted embark area.
 
 Usage
 -----
diff --git a/library/LuaApi.cpp b/library/LuaApi.cpp
@@ -1660,11 +1660,19 @@ static int gui_revealInDwarfmodeMap(lua_State *state)
     switch (lua_gettop(state))
     {
         default:
+        case 5:
+            rv = Gui::revealInDwarfmodeMap(CheckCoordXYZ(state, 1, false), lua_toboolean(state, 4), lua_toboolean(state, 5));
+            break;
         case 4:
             rv = Gui::revealInDwarfmodeMap(CheckCoordXYZ(state, 1, false), lua_toboolean(state, 4));
             break;
         case 3:
-            rv = Gui::revealInDwarfmodeMap(CheckCoordXYZ(state, 1, false));
+            if (lua_isboolean(state, 3)) {
+                Lua::CheckDFAssign(state, &p, 1);
+                rv = Gui::revealInDwarfmodeMap(p, lua_toboolean(state, 2), lua_toboolean(state, 3));
+            }
+            else
+                rv = Gui::revealInDwarfmodeMap(CheckCoordXYZ(state, 1, false));
             break;
         case 2:
             Lua::CheckDFAssign(state, &p, 1);
diff --git a/library/include/modules/Gui.h b/library/include/modules/Gui.h
@@ -165,8 +165,8 @@ namespace DFHack
         DFHACK_EXPORT DwarfmodeDims getDwarfmodeViewDims();
 
         DFHACK_EXPORT void resetDwarfmodeView(bool pause = false);
-        DFHACK_EXPORT bool revealInDwarfmodeMap(int32_t x, int32_t y, int32_t z, bool center = false);
-        DFHACK_EXPORT inline bool revealInDwarfmodeMap(df::coord pos, bool center = false) { return revealInDwarfmodeMap(pos.x, pos.y, pos.z, center); };
+        DFHACK_EXPORT bool revealInDwarfmodeMap(int32_t x, int32_t y, int32_t z, bool center = false, bool highlight = false);
+        DFHACK_EXPORT inline bool revealInDwarfmodeMap(df::coord pos, bool center = false, bool highlight = false) { return revealInDwarfmodeMap(pos.x, pos.y, pos.z, center, highlight); };
         DFHACK_EXPORT bool pauseRecenter(int32_t x, int32_t y, int32_t z, bool pause = true);
         DFHACK_EXPORT inline bool pauseRecenter(df::coord pos, bool pause = true) { return pauseRecenter(pos.x, pos.y, pos.z, pause); };
         DFHACK_EXPORT bool refreshSidebar();
diff --git a/library/modules/Gui.cpp b/library/modules/Gui.cpp
@@ -2094,13 +2094,13 @@ void Gui::resetDwarfmodeView(bool pause)
         *df::global::pause_state = true;
 }
 
-bool Gui::revealInDwarfmodeMap(int32_t x, int32_t y, int32_t z, bool center)
+bool Gui::revealInDwarfmodeMap(int32_t x, int32_t y, int32_t z, bool center, bool highlight)
 {   // Reverse-engineered from DF announcement and scrolling code
     using df::global::window_x;
     using df::global::window_y;
     using df::global::window_z;
 
-    if (!window_x || !window_y || !window_z || !world)
+    if (!window_x || !window_y || !window_z || !world || !game)
         return false;
 
     auto dims = getDwarfmodeViewDims();
@@ -2137,6 +2137,12 @@ bool Gui::revealInDwarfmodeMap(int32_t x, int32_t y, int32_t z, bool center)
     game->minimap.update = true;
     game->minimap.mustmake = true;
 
+    if (highlight) {
+        game->main_interface.recenter_indicator_m.x = x;
+        game->main_interface.recenter_indicator_m.y = y;
+        game->main_interface.recenter_indicator_m.z = z;
+    }
+
     return true;
 }
 
diff --git a/library/modules/Items.cpp b/library/modules/Items.cpp
@@ -2042,10 +2042,16 @@ int Items::getValue(df::item *item, df::caravan_state *caravan)
     {
         int divisor = 1;
         auto creature = vector_get(world->raws.creatures.all, mat_type);
-        if (creature && size_t(mat_subtype) < creature->caste.size())
-            divisor = creature->caste[mat_subtype]->misc.petvalue_divisor;
-        if (divisor > 1)
+        if (creature) {
+            size_t caste = std::max(0, mat_subtype);
+            if (caste < creature->caste.size())
+                divisor = creature->caste[caste]->misc.petvalue_divisor;
+        }
+        if (divisor > 1) {
             value /= divisor;
+            if (!value)
+                value = 1;
+        }
     }
 
     // Add in value from units contained in cages
diff --git a/plugins/lua/buildingplan/planneroverlay.lua b/plugins/lua/buildingplan/planneroverlay.lua
@@ -294,7 +294,7 @@ function ItemLine:get_item_line_text()
         uibs.building_type, uibs.building_subtype, uibs.custom_type, idx - 1)
     if self.available >= quantity then
         self.note_pen = COLOR_GREEN
-        self.note = ' Available now'
+        self.note = (' %d available now'):format(self.available)
     elseif self.available >= 0 then
         self.note_pen = COLOR_BROWN
         self.note = (' Will link next (need to make %d)'):format(quantity - self.available)
diff --git a/plugins/lua/sort.lua b/plugins/lua/sort.lua
@@ -3,7 +3,7 @@ local _ENV = mkmodule('plugins.sort')
 local gui = require('gui')
 local overlay = require('plugins.overlay')
 local setbelief = reqscript('modtools/set-belief')
-local textures = require('gui.textures')
+local sortoverlay = require('plugins.sort.sortoverlay')
 local utils = require('utils')
 local widgets = require('gui.widgets')
 
@@ -1031,7 +1031,7 @@ local function filter_matches(unit_id, filter)
     if filter.maimed == 'only' and not is_maimed(unit) then return false end
     if filter.maimed == 'exclude' and is_maimed(unit) then return false end
     if #filter.search == 0 then return true end
-    local search_key = dfhack.TranslateName(dfhack.units.getVisibleName(unit))
+    local search_key = sortoverlay.get_unit_search_key(unit)
     return normalize_search_key(search_key):find(dfhack.toSearchNormalized(filter.search))
 end
 
@@ -1233,14 +1233,15 @@ local function init_face_tiles()
         FACE_TILES[idx-1] = face
     end
 end
+init_face_tiles()
 
 function get_stress_face_tile(idx, x, y)
     local elem = rating_annotations[idx]
     if not elem or not elem.val or elem.val < 0 then
         return x == 0 and y == 1 and DASH_PEN or gui.CLEAR_PEN
     end
     local val = math.min(6, elem.val)
-    return FACE_TILES[val][y][x]
+    return safe_index(FACE_TILES, val, y, x)
 end
 
 function SquadAnnotationOverlay:init()
diff --git a/plugins/lua/sort/info.lua b/plugins/lua/sort/info.lua
@@ -97,16 +97,9 @@ local function get_sort()
     end
 end
 
-local function get_unit_search_key(unit)
-    return ('%s %s %s'):format(
-        dfhack.units.getReadableName(unit),  -- last name is in english
-        dfhack.units.getProfessionName(unit),
-        dfhack.TranslateName(unit.name, false, true))  -- get untranslated last name
-end
-
 local function get_cri_unit_search_key(cri_unit)
     return ('%s %s'):format(
-        cri_unit.un and get_unit_search_key(cri_unit.un) or '',
+        cri_unit.un and sortoverlay.get_unit_search_key(cri_unit.un) or '',
         cri_unit.job_sort_name)
 end
 
@@ -132,7 +125,7 @@ local function work_details_search(vec, data, text, incremental)
         data.selected = work_details.selected_work_detail_index
     end
     sortoverlay.single_vector_search(
-        {get_search_key_fn=get_unit_search_key},
+        {get_search_key_fn=sortoverlay.get_unit_search_key},
         vec, data, text, incremental)
 end
 
@@ -161,7 +154,7 @@ end
 local function get_candidate_search_key(cand)
     if not cand.un then return end
     return ('%s %s'):format(
-        get_unit_search_key(cand.un),
+        sortoverlay.get_unit_search_key(cand.un),
         serialize_skills(cand.un))
 end
 
@@ -420,15 +413,15 @@ function InterrogationOverlay:init()
     self:register_handler('INTERROGATING', justice.interrogation_list,
         curry(sortoverlay.flags_vector_search,
             {
-                get_search_key_fn=get_unit_search_key,
+                get_search_key_fn=sortoverlay.get_unit_search_key,
                 get_elem_id_fn=function(unit) return unit.id end,
                 matches_filters_fn=self:callback('matches_filters'),
             },
         justice.interrogation_list_flag))
     self:register_handler('CONVICTING', justice.conviction_list,
         curry(sortoverlay.single_vector_search,
             {
-                get_search_key_fn=get_unit_search_key,
+                get_search_key_fn=sortoverlay.get_unit_search_key,
                 matches_filters_fn=self:callback('matches_filters'),
             }))
 end
diff --git a/plugins/lua/sort/slab.lua b/plugins/lua/sort/slab.lua
@@ -5,7 +5,6 @@ local sortoverlay = require('plugins.sort.sortoverlay')
 local widgets = require('gui.widgets')
 
 local building = df.global.game.main_interface.building
-local view_sheets = df.global.game.main_interface.view_sheets
 
 -- ----------------------
 -- SlabOverlay
@@ -95,9 +94,7 @@ end
 function SlabOverlay:get_search_key(if_button)
     local unit = get_unit(if_button)
     if not unit then return if_button.filter_str end
-    return ('%s %s'):format(
-        dfhack.units.getReadableName(unit),  -- last name is in english
-        dfhack.TranslateName(unit.name, false, true))  -- get untranslated last name
+    return sortoverlay.get_unit_search_key(unit)
 end
 
 local function needs_slab(if_button)
diff --git a/plugins/lua/sort/sortoverlay.lua b/plugins/lua/sort/sortoverlay.lua
@@ -3,6 +3,13 @@ local _ENV = mkmodule('plugins.sort.sortoverlay')
 local overlay = require('plugins.overlay')
 local utils = require('utils')
 
+function get_unit_search_key(unit)
+    return ('%s %s %s'):format(
+        dfhack.units.getReadableName(unit),  -- last name is in english
+        dfhack.units.getProfessionName(unit),
+        dfhack.TranslateName(unit.name, false, true))  -- get untranslated last name
+end
+
 local function copy_to_lua_table(vec)
     local tab = {}
     for k,v in ipairs(vec) do
diff --git a/plugins/lua/sort/unitselector.lua b/plugins/lua/sort/unitselector.lua
@@ -20,10 +20,7 @@ UnitSelectorOverlay.ATTRS{
 local function get_unit_id_search_key(unit_id)
     local unit = df.unit.find(unit_id)
     if not unit then return end
-    return ('%s %s %s'):format(
-        dfhack.units.getReadableName(unit),  -- last name is in english
-        dfhack.units.getProfessionName(unit),
-        dfhack.TranslateName(unit.name, false, true))  -- get untranslated last name
+    return sortoverlay.get_unit_search_key(unit)
 end
 
 function UnitSelectorOverlay:init()
diff --git a/plugins/lua/stockpiles.lua b/plugins/lua/stockpiles.lua
@@ -403,11 +403,15 @@ StockpilesOverlay.ATTRS{
 function StockpilesOverlay:init()
     self.minimized = false
 
+    local function is_expanded()
+        return not self.minimized
+    end
+
     local main_panel = widgets.Panel{
         view_id='main',
         frame_style=gui.MEDIUM_FRAME,
         frame_background=gui.CLEAR_PEN,
-        visible=function() return not self.minimized end,
+        visible=is_expanded,
         subviews={
             -- widgets.HotkeyLabel{
             --     frame={t=0, l=0},
@@ -486,10 +490,12 @@ function StockpilesOverlay:init()
         widgets.ConfigureButton{
             frame={t=0, r=5},
             on_click=function() ConfigModal{on_close=self:callback('on_custom_config')}:show() end,
+            visible=is_expanded,
         },
         widgets.HelpButton{
             frame={t=0, r=1},
             command='stockpiles',
+            visible=is_expanded,
         },
     }
 end
diff --git a/plugins/prospector.cpp b/plugins/prospector.cpp
@@ -567,26 +567,11 @@ static command_result embark_prospector(color_ostream &out,
                                         df::viewscreen_choose_start_sitest *screen,
                                         const prospect_options &options)
 {
-    out.printerr("prospector at embark is not currently available.\n");
-    return CR_FAILURE;
-
-/*
-    if (!world || !world->world_data)
-    {
+    if (!world->world_data) {
         out.printerr("World data is not available.\n");
         return CR_FAILURE;
     }
 
-    df::world_data *data = world->world_data;
-    coord2d cur_region = screen->location.region_pos;
-    auto cur_details = get_details(data, cur_region);
-
-    if (!cur_details)
-    {
-        out.printerr("Current region details are not available.\n");
-        return CR_FAILURE;
-    }
-
     // Compute material maps
     MatMap layerMats;
     MatMap veinMats;
@@ -595,12 +580,18 @@ static command_result embark_prospector(color_ostream &out,
     // Compute biomes
     std::map<coord2d, int> biomes;
 
-    for (int x = screen->location.embark_pos_min.x; x <= 15 && x <= screen->location.embark_pos_max.x; x++)
-    {
-        for (int y = screen->location.embark_pos_min.y; y <= 15 && y <= screen->location.embark_pos_max.y; y++)
-        {
+    int32_t max_x = (world->worldgen.worldgen_parms.dim_x * 16) - 1;
+    int32_t max_y = (world->worldgen.worldgen_parms.dim_y * 16) - 1;
+
+    for (int x = screen->location.embark_pos_min.x; x <= max_x && x <= screen->location.embark_pos_max.x; ++x) {
+        for (int y = screen->location.embark_pos_min.y; y <= max_y && y <= screen->location.embark_pos_max.y; ++y) {
+            auto cur_details = get_details(world->world_data, coord2d(x / 16, y / 16));
+
+            if (!cur_details)
+                continue;
+
             EmbarkTileLayout tile;
-            if (!estimate_underground(out, tile, cur_details, x, y) ||
+            if (!estimate_underground(out, tile, cur_details, x % 16, y % 16) ||
                 !estimate_materials(out, tile, layerMats, veinMats))
                 return CR_FAILURE;
 
@@ -627,7 +618,6 @@ static command_result embark_prospector(color_ostream &out,
     out << std::endl << "Warning: the above data is only a very rough estimate." << std::endl;
 
     return CR_OK;
-*/
 }
 
 static command_result map_prospector(color_ostream &con,
diff --git a/scripts b/scripts
@@ -1 +1 @@
-Subproject commit 1fcc83838e471fd8ef50cc6d6cb9259b69f1d847
+Subproject commit 996c0401051c09f65a3c048f337f891b99aa142c
