Merge branch 'develop' into tweak/material_size_for_melting

Birkow · Sep 28, 2024 · f6b1523 · f6b1523
2 parents 076031a + 9c69796
commit f6b1523
Show file tree

Hide file tree

Showing 30 changed files with 3,560 additions and 3,333 deletions.
diff --git a/docs/changelog.txt b/docs/changelog.txt
@@ -68,8 +68,12 @@ Template for new versions:
 
 ## API
 
+- ``DFHack::Units``: new function ``setPathGoal``
+
 ## Lua
 
+- ``dfhack.units``: new function ``setPathGoal``
+
 ## Removed
 
 # 50.14-r1

diff --git a/docs/dev/Lua API.rst b/docs/dev/Lua API.rst
@@ -1703,6 +1703,11 @@ Units module
   ``dfhack.units.isOwnCiv`` or another appropriate predicate on the unit
   in question.
 
+* ``dfhack.units.setPathGoal(unit, pos, goal)``
+
+  Set target coordinates and goal (of type ``df.unit_path_goal``) for the given
+  unit. In case of a change, also clears the unit's current path.
+
 * ``dfhack.units.create(race, caste)``
 
   Creates a new unit from scratch. The unit will be added to the

diff --git a/library/LuaApi.cpp b/library/LuaApi.cpp
@@ -2065,6 +2065,7 @@ static const LuaWrapper::FunctionReg dfhack_units_module[] = {
     WRAPM(Units, getIdentity),
     WRAPM(Units, getNemesis),
     WRAPM(Units, makeown),
+    WRAPM(Units, setPathGoal),
     WRAPM(Units, create),
     WRAPM(Units, getPhysicalAttrValue),
     WRAPM(Units, getMentalAttrValue),

diff --git a/library/include/modules/Units.h b/library/include/modules/Units.h
@@ -42,6 +42,7 @@ distribution.
 #include "df/physical_attribute_type.h"
 #include "df/unit_action.h"
 #include "df/unit_action_type_group.h"
+#include "df/unit_path_goal.h"
 
 #include <ranges>
 
@@ -238,6 +239,9 @@ DFHACK_EXPORT bool unassignTrainer(df::unit *unit);
 /// to determine if the makeown operation was successful.
 DFHACK_EXPORT void makeown(df::unit *unit);
 
+// Set the units target location and goal, clearing any existing goal or path
+DFHACK_EXPORT void setPathGoal(df::unit *unit, df::coord pos, df::unit_path_goal goal);
+
 /// Create new unit and add to all units vector (but not active). No HF, nemesis, pos,
 /// labors, or group associations. Will have race, caste, name, soul, body, and mind.
 DFHACK_EXPORT df::unit *create(int16_t race, int16_t caste);