Merge branch 'develop' into adv_cursor

Author: myk002

depends/dfhooks

@@ -66,14 +66,17 @@ Template for new versions:
 
 ## Misc Improvements
 - `spectate`: player-set configuration is now stored globally instead of per-fort
+- `autobutcher`: treat animals on restraints as unavailable for slaughter
 
 ## Documentation
 - `stonesense-art-guide`: new guide for making sprite art for Stonesense
 
 ## 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
 

docs/changelog.txt

@@ -1986,6 +1986,14 @@ Military module
 
   Returns the name of a squad as a string.
 
+* ``dfhack.military.removeFromSquad(unit_id)``
+
+  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.
+
 Items module
 ------------
 

docs/dev/Lua API.rst

@@ -15,6 +15,7 @@ Units are protected from being automatically butchered if they are:
 * Untamed
 * Named or nicknamed
 * Caged, if and only if the cage is in a zone (to protect zoos)
+* On a restraint
 * Trained for war or hunting
 * Females who are pregnant or brooding a clutch of fertile eggs
 

docs/plugins/autobutcher.rst

@@ -13,9 +13,9 @@ to following a different dwarf. It can also switch to following animals,
 hostiles, or visiting units. You can switch to the next target (or a previous
 target) immediately with the left/right arrow keys.
 
-`spectate` will disengage and turn itself off when you move the map, just like
-the vanilla follow mechanic. It will also disengage immediately if you open the
-squads menu for military action.
+By default, `spectate` will disengage and turn itself off when you move the
+map, just like the vanilla follow mechanic. It will also disengage immediately
+if you open the squads menu for military action.
 
 It can also annotate your dwarves on the map with their name, job, and other
 information, either as floating tooltips or in a panel that comes up when you
@@ -37,7 +37,7 @@ Usage
     spectate [status]
     spectate toggle
     spectate set <setting> <value>
-    spectate overlay <name> enable|disable
+    spectate overlay enable|disable
 
 Examples
 --------
@@ -59,16 +59,18 @@ Examples
 ``spectate set follow-seconds 30``
     Configure `spectate` to switch targets every 30 seconds when in follow mode.
 
-``spectate overlay follow enable``
-    Show informative tooltips that follow each unit on the map.
+``spectate overlay enable``
+    Show informative tooltips that follow each unit on the map. Note that this
+    can be enabled independently of `spectate` itself.
 
 Settings
 --------
 
 ``auto-disengage`` (default: enabled)
     Toggle automatically disabling the plugin when the player moves the map or
     opens the squad panel. If this is disabled, you will need to manually
-    disable the plugin to turn off follow mode.
+    disable the plugin to turn off follow mode. You can still interact normally
+    with the DF UI.
 
 ``auto-unpause`` (default: disabled)
     Toggle auto-dismissal of announcements that pause the game, like sieges,
@@ -82,7 +84,7 @@ Settings
     include time that the game is paused.
 
 ``include-animals`` (default: disabled)
-    Toggle whether to sometimes follow fort animals.
+    Toggle whether to sometimes follow fort animals and wildlife.
 
 ``include-hostiles`` (default: disabled)
     Toggle whether to sometimes follow hostiles (eg. undead, titans, invaders,
@@ -102,47 +104,36 @@ Settings
     arrived on the map.
 
 ``tooltip-follow-job`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     job of the dwarf in the tooltip.
 
 ``tooltip-follow-name`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     name of the dwarf in the tooltip.
 
 ``tooltip-follow-stress`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     happiness level (stress) of the dwarf in the tooltip.
 
 ``tooltip-hover-job`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     job of the dwarf in the hover panel.
 
 ``tooltip-hover-name`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     name of the dwarf in the hover panel.
 
 ``tooltip-hover-stress`` (default: enabled)
-    If the ``spectate.follow`` overlay is enabled, toggle whether to show the
+    If the ``spectate.tooltip`` overlay is enabled, toggle whether to show the
     happiness level (stress) of the dwarf in the hover panel.
 
 Overlays
 --------
 
-``spectate`` provides two overlays via the `overlay` framework to add
-information and functionality to the main map. These overlays can be controlled
-via the ``spectate overlay`` command or the ``Overlays`` tab in
-`gui/control-panel`.
+``spectate.tooltip``
 
-The information displayed by these overlays can be configured via the
-``spectate set`` command or the `gui/spectate` interface.
+``spectate`` can show informative tooltips that follow each unit on the map
+and/or a popup panel with information when your mouse cursor hovers over a unit.
 
-``spectate.follow``
-    Show informative tooltips that follow each unit on the map. You can enable
-    this overlay by running ``spectate overlay follow enable`` or,
-    equivalently, ``overlay enable spectate.follow``.
-
-``spectate.hover``
-    Show a popup panel with selected information when your mouse cursor hovers
-    over a unit. You can enable this overlay by running
-    ``spectate overlay hover enable`` or, equivalently,
-    ``overlay enable spectate.hover``.
+This overlay is managed via the `overlay` framework. It can be controlled via
+the ``spectate overlay`` command or the ``Overlays`` tab in `gui/control-panel`.

docs/plugins/spectate.rst

@@ -99,6 +99,7 @@ distribution.
 #include "df/report_zoom_type.h"
 #include "df/specific_ref.h"
 #include "df/specific_ref_type.h"
+#include "df/squad_use_flags.h"
 #include "df/squad.h"
 #include "df/unit.h"
 #include "df/unit_misc_trait.h"
@@ -2341,6 +2342,7 @@ static const LuaWrapper::FunctionReg dfhack_military_module[] = {
     WRAPM(Military, makeSquad),
     WRAPM(Military, updateRoomAssignments),
     WRAPM(Military, getSquadName),
+    WRAPM(Military, removeFromSquad),
     { NULL, NULL }
 };
 
@@ -2442,7 +2444,7 @@ static int items_moveToBuilding(lua_State *state)
 static int items_moveToInventory(lua_State *state) {
     auto item = Lua::CheckDFObject<df::item>(state, 1);
     auto unit = Lua::CheckDFObject<df::unit>(state, 2);
-    auto use_mode = (df::unit_inventory_item::T_mode)luaL_optint(state, 3, 0);
+    auto use_mode = (df::inv_item_role_type)luaL_optint(state, 3, 0);
     int body_part = luaL_optint(state, 4, -1);
     lua_pushboolean(state, Items::moveToInventory(item, unit, use_mode, body_part));
     return 1;
@@ -2815,7 +2817,7 @@ int buildings_setSize(lua_State *state)
         lua_pushinteger(state, size.x);
         lua_pushinteger(state, size.y);
         lua_pushinteger(state, area);
-        lua_pushinteger(state, Buildings::countExtentTiles(&bld->room, area));
+        lua_pushinteger(state, Buildings::countExtentTiles(bld, area));
         return 5;
     }
     else

library/LuaApi.cpp

@@ -458,7 +458,7 @@ static command_result ListEnums(color_ostream &stream,
     BITFIELD(cie_add_tag_mask1);
     BITFIELD(cie_add_tag_mask2);
 
-    describe_bitfield<df::incident::T_flags>(out->mutable_death_info_flags());
+    describe_bitfield<df::incident_flag>(out->mutable_death_info_flags());
 
     ENUM(profession);
 

library/RemoteTools.cpp

@@ -1 +1 @@
-friend struct world_raws;
+friend struct world;

library/include/df/custom/creature_handler.methods.inc

@@ -44,7 +44,6 @@ namespace df {
     struct building;
     struct building_cagest;
     struct building_civzonest;
-    struct building_extents;
     struct building_stockpilest;
     struct item;
     struct job_item;
@@ -112,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_extents *ext = NULL,
+                                  df::building *bld,
                                   bool create_ext = false,
                                   bool allow_occupied = false,
                                   bool allow_wall = false,
@@ -121,7 +120,7 @@ DFHACK_EXPORT bool checkFreeTiles(df::coord pos, df::coord2d size,
 /**
  * Returns the number of tiles included by the extent, or defval.
  */
-DFHACK_EXPORT int countExtentTiles(df::building_extents *ext, int defval = -1);
+DFHACK_EXPORT int countExtentTiles(df::building *bld, int defval = -1);
 
 /**
  * Checks if the building contains the specified tile. If the building has

library/include/modules/Buildings.h

@@ -157,7 +157,7 @@ DFHACK_EXPORT bool moveToContainer(df::item *item, df::item *container);
 DFHACK_EXPORT bool moveToBuilding(df::item *item, df::building_actual *building,
     df::building_item_role_type use_mode = df::building_item_role_type::TEMP, bool force_in_building = false);
 DFHACK_EXPORT bool moveToInventory(df::item *item, df::unit *unit,
-    df::unit_inventory_item::T_mode mode = df::unit_inventory_item::Hauled, int body_part = -1);
+    df::inv_item_role_type mode = df::inv_item_role_type::Hauled, int body_part = -1);
 
 /// Remove item from jobs and inventories, hide and forbid.
 /// Unless no_uncat, item is marked for garbage collection.