Merge branch 'develop' into patch-10

Author: TymurGubayev

CMakeLists.txt

@@ -6,8 +6,8 @@ cmake_policy(SET CMP0048 NEW)
 cmake_policy(SET CMP0074 NEW)
 
 # set up versioning.
-set(DF_VERSION "51.04")
-set(DFHACK_RELEASE "r1.1")
+set(DF_VERSION "51.05")
+set(DFHACK_RELEASE "r1")
 set(DFHACK_PRERELEASE FALSE)
 
 set(DFHACK_VERSION "${DF_VERSION}-${DFHACK_RELEASE}")

docs/about/Authors.rst

@@ -158,6 +158,7 @@ NotRexButCaesar         NotRexButCaesar
 Nuno Fernandes          UnknowableCoder
 nuvu                    vallode
 Omniclasm
+Ong Ying Gao            ong-yinggao98
 oorzkws                 oorzkws
 OwnageIsMagic           OwnageIsMagic
 palenerd                dlmarquis

docs/changelog.txt

@@ -35,11 +35,8 @@ Template for new versions:
 ## Documentation
 
 ## API
-- ``Military::removeFromSquad``: removes unit from any squad assignments
 
 ## Lua
-- ``dfhack.units.setAutomaticProfessions``: sets unit labors according to current work detail settings
-- ``dfhack.military.removeFromSquad``: Lua API for ``Military::removeFromSquad``
 
 ## Removed
 
@@ -57,27 +54,40 @@ Template for new versions:
 ## New Tools
 
 ## New Features
-- `spectate`: can now specify number of seconds (in real time) before switching to follow a new unit unit
+- `spectate`: can now specify number of seconds (in real time) before switching to follow a new unit
 - `spectate`: new "cinematic-action" mode that dynamically speeds up perspective switches based on intensity of conflict
 - `spectate`: new global keybinding for toggling spectate mode: Ctrl-Shift-S
+- `spectate`: when spectate mode is enabled, left/right arrow will cycle through following next/prevous units
 
 ## Fixes
+- `createitem`: output items will now end up at look cursor if active
 - `spectate`: don't allow temporarily modified announcement settings to be written to disk when "auto-unpause" mode is enabled
 - `changevein`: fix a crash that could occur when attempting to change a vein into itself
 
 ## Misc Improvements
 - `spectate`: player-set configuration is now stored globally instead of per-fort
 - `autobutcher`: treat animals on restraints as unavailable for slaughter
+- `stockpiles`: add property filters for brewable, millable, and processable (e.g. at a Farmer's workshop) organic materials
 
 ## Documentation
-- `stonesense-art-guide`: new guide for making sprite art for Stonesense
+- `stonesense-art-guide`: guide for making sprite art for Stonesense
 
 ## API
+- ``Military::removeFromSquad``: removes unit from any squad assignments
+- ``Buildings::checkFreeTiles``: now replaces the extents parameter for a building pointer
 
 ## Lua
+- ``dfhack.units.setAutomaticProfessions``: sets unit labors according to current work detail settings
+- ``dfhack.military.removeFromSquad``: Lua API for ``Military::removeFromSquad``
+- ``gui.dwarfmode``: adventure mode cursor now supported in ``getCursorPos``, ``setCursorPos``, and ``clearCursorPos`` funcitons
+- ``dfhack.buildings.checkFreeTiles``: now replaces the extents parameter for a building pointer
 
 ## Removed
 
+# 51.05-r1
+
+## Misc Improvements
+- Compatibility with DF 51.05
 # 51.04-r1.1
 
 ## Fixes

docs/dev/Lua API.rst

@@ -1991,8 +1991,9 @@ Military module
   Removes a unit from its squad. Unsets the unit's
   military information (i.e., ``unit.military.squad_id`` and
   ``unit.military.squad_pos``), the squad's position information (i.e.,
-  ``squad.positions[squad_pos].occupant``), and modifies the unit's entity links
-  to indicate former squad membership or command.
+  ``squad.positions[squad_pos].occupant``), modifies the unit's entity links
+  to indicate former squad membership or command, and creates a corresponding
+  world history event.
 
 Items module
 ------------
@@ -2476,14 +2477,15 @@ General
   using width and height for flexible dimensions.
   Returns *is_flexible, width, height, center_x, center_y*.
 
-* ``dfhack.buildings.checkFreeTiles(pos,size[,extents[,change_extents[,allow_occupied[,allow_wall[,allow_flow]]]]])``
+* ``dfhack.buildings.checkFreeTiles(pos,size[,bld[,change_extents[,allow_occupied[,allow_wall[,allow_flow]]]]])``
 
-  Checks if the rectangle defined by ``pos`` and ``size``, and possibly extents,
-  can be used for placing a building. If ``change_extents`` is true, bad tiles
-  are removed from extents. If ``allow_occupied``, the occupancy test is skipped.
-  Set ``allow_wall`` to true if the building is unhindered by walls (such as an
-  activity zone). Set ``allow_flow`` to true if the building can be built even
-  if there is deep water or any magma on the tile (such as abstract buildings).
+  Checks if the rectangle defined by ``pos`` and ``size``, and possibly the
+  extents associated with bld, can be used for placing a building. If
+  ``change_extents`` is true, bad tiles are removed from extents. If
+  ``allow_occupied``, the occupancy test is skipped. Set ``allow_wall`` to true
+  if the building is unhindered by walls (such as an activity zone). Set
+  ``allow_flow`` to true if the building can be built even if there is deep
+  water or any magma on the tile (such as abstract buildings).
 
 * ``dfhack.buildings.countExtentTiles(extents,defval)``
 

docs/plugins/stockpiles.rst

@@ -378,6 +378,12 @@ Flags and subcategory prefixes::
     paste/
     pressed/
 
+Properties::
+
+    brewable
+    millable
+    processable
+
 Settings files::
 
     preparedmeals

library/include/modules/Buildings.h

@@ -111,7 +111,7 @@ DFHACK_EXPORT bool getCorrectSize(df::coord2d &size, df::coord2d &center,
  * Checks if the tiles are free to be built upon.
  */
 DFHACK_EXPORT bool checkFreeTiles(df::coord pos, df::coord2d size,
-                                  df::building *bld,
+                                  df::building *bld = nullptr,
                                   bool create_ext = false,
                                   bool allow_occupied = false,
                                   bool allow_wall = false,

library/lua/custom-raw-tokens.lua

@@ -300,7 +300,7 @@ local function getTokenArg1Else(userdata, token)
     elseif df.is_instance(df.building_workshopst, userdata) or df.is_instance(df.building_furnacest, userdata) then
         rawStruct = df.building_def.find(userdata.custom_type)
     elseif df.is_instance(df.interaction_instance, userdata) then
-        rawStruct = df.global.world.raws.interactions[userdata.interaction_id]
+        rawStruct = df.global.world.raws.interactions.all[userdata.interaction_id]
     else
         -- Assume raw struct *is* argument 1
         rawStruct = userdata

library/lua/dfhack/workshops.lua

@@ -509,7 +509,7 @@ local function addReactionJobs(ret,bid,wid,cid)
 end
 local function scanRawsOres()
     local ret={}
-    for idx,ore in ipairs(df.global.world.raws.inorganics) do
+    for idx,ore in ipairs(df.global.world.raws.inorganics.all) do
         if #ore.metal_ore.mat_index~=0 then
             ret[idx]=ore
         end

library/lua/gui/dwarfmode.lua

@@ -7,6 +7,7 @@ local utils = require('utils')
 
 local dscreen = dfhack.screen
 
+local a_look = df.global.game.main_interface.adventure.look
 local g_cursor = df.global.cursor
 local g_sel_rect = df.global.selection_rect
 local world_map = df.global.world.map
@@ -38,17 +39,35 @@ end
 
 ---@return df.coord|nil
 function getCursorPos()
-    if g_cursor.x >= 0 then
+    if dfhack.world.isAdventureMode() then
+        if a_look.open then
+            return copyall(a_look.cursor)
+        end
+    elseif g_cursor.x >= 0 then
         return copyall(g_cursor)
     end
 end
 
 function setCursorPos(cursor)
-    df.global.cursor = copyall(cursor)
+    if dfhack.world.isAdventureMode() then
+        a_look.cursor = copyall(cursor)
+    else
+        df.global.cursor = copyall(cursor)
+    end
 end
 
 function clearCursorPos()
-    df.global.cursor = xyz2pos(nil)
+    if dfhack.world.isAdventureMode() then
+        if not a_look.open then
+            return
+        end
+        local u = dfhack.world.getAdventurer()
+        if u and u.pos:isValid() then
+            a_look.cursor = copyall(u.pos)
+        end
+    else
+        df.global.cursor = xyz2pos(nil)
+    end
 end
 
 function getSelection()

library/lua/gui/materials.lua

@@ -116,7 +116,7 @@ end
 function MaterialDialog:initInorganicMode()
     local choices = {}
 
-    for i,mat in ipairs(df.global.world.raws.inorganics) do
+    for i,mat in ipairs(df.global.world.raws.inorganics.all) do
         self:addMaterial(choices, mat.material, 0, i, false, mat)
     end
 
@@ -378,14 +378,14 @@ function ItemTraitsDialog(args)
     end
     --------------------------------------
     local set_ore_ix = {}
-    for i, raw in ipairs(df.global.world.raws.inorganics) do
+    for i, raw in ipairs(df.global.world.raws.inorganics.all) do
         for _, ix in ipairs(raw.metal_ore.mat_index) do
             set_ore_ix[ix] = true
         end
     end
     local ores = {}
     for ix in pairs(set_ore_ix) do
-        local raw = df.global.world.raws.inorganics[ix]
+        local raw = df.global.world.raws.inorganics.all[ix]
         ores[#ores+1] = {mat_index = ix, name = raw.material.state_name.Solid}
     end
     table.sort(ores, function(a,b) return a.name < b.name end)