Partial rewrite of 'fastdwarf' plugin:

* add "fastdwarf 2" to use DF builtin "turbo speed" debug setting
* use Units::isCitizen() instead of race/civ check
* only scan active units, not all of them
* do both fastdwarf and teledwarf in the same loop
* teledwarf: don't use MapCache - it's faster to do it directly
* teledwarf: don't clear both occupancy flags - check unit 'prone' flag
* teledwarf: set proper unit occupancy flag at destination tile
* teledwarf: if destination tile has standing unit, make dwarf lie down
* cleanup 'fastdwarf' command
* improve help text

plugins/fastdwarf.cpp

@@ -2,134 +2,165 @@
 #include "Console.h"
 #include "Export.h"
 #include "PluginManager.h"
-#include "modules/MapCache.h"
+#include "modules/Units.h"
+#include "modules/Maps.h"
 
 #include "DataDefs.h"
-#include "df/ui.h"
 #include "df/world.h"
 #include "df/unit.h"
+#include "df/map_block.h"
 
 using std::string;
 using std::vector;
 using namespace DFHack;
 
 using df::global::world;
-using df::global::ui;
 
 // dfhack interface
 DFHACK_PLUGIN("fastdwarf");
 
+static bool enable_fastdwarf = false;
+static bool enable_teledwarf = false;
+
 DFhackCExport command_result plugin_shutdown ( color_ostream &out )
 {
+    if (df::global::debug_turbospeed)
+        *df::global::debug_turbospeed = false;
     return CR_OK;
 }
 
-static bool enable_fastdwarf = false;
-static bool enable_teledwarf = false;
-
 DFhackCExport command_result plugin_onupdate ( color_ostream &out )
 {
-    // check run conditions
+    // do we even need to do anything at all?
-    if(!world || !world->map.block_index)
+    if (!enable_fastdwarf && !enable_teledwarf)
+        return CR_OK;
+
+    // make sure the world is actually loaded
+    if (!world || !world->map.block_index)
     {
         enable_fastdwarf = enable_teledwarf = false;
         return CR_OK;
     }
-    int32_t race = ui->race_id;
+
-    int32_t civ = ui->civ_id;
+    df::map_block *old_block, *new_block;
-    
+    for (size_t i = 0; i < world->units.active.size(); i++)
-    if ( enable_fastdwarf ) {
+    {
-        for (size_t i = 0; i < world->units.all.size(); i++)
+        df::unit *unit = world->units.active[i];
+        // citizens only
+        if (!Units::isCitizen(unit))
+            continue;
+
+        if (enable_fastdwarf)
         {
-            df::unit *unit = world->units.all[i];
+
-            
+            if (unit->counters.job_counter > 0)
-            if (unit->race == race && unit->civ_id == civ && unit->counters.job_counter > 0)
                 unit->counters.job_counter = 0;
             // could also patch the unit->job.current_job->completion_timer
         }
-    }
+        if (enable_teledwarf)
-    if ( enable_teledwarf ) {
-        MapExtras::MapCache *MCache = new MapExtras::MapCache();
-        for (size_t i = 0; i < world->units.all.size(); i++)
         {
-            df::unit *unit = world->units.all[i];
+            // don't do anything if the dwarf isn't going anywhere
-            
+            if (unit->path.dest.x == -30000)
-            if (unit->race != race || unit->civ_id != civ || unit->path.dest.x == -30000)
                 continue;
-            if (unit->relations.draggee_id != -1 || unit->relations.dragger_id != -1)
+
+            // skip dwarves that are dragging creatures or being dragged
+            if ((unit->relations.draggee_id != -1) || (unit->relations.dragger_id != -1))
                 continue;
+
+            // skip dwarves that are following other units
             if (unit->relations.following != 0)
                 continue;
-            
+
-            MapExtras::Block* block = MCache->BlockAtTile(unit->pos);
+            old_block = Maps::getTileBlock(unit->pos.x, unit->pos.y, unit->pos.z);
-            df::coord2d pos(unit->pos.x % 16, unit->pos.y % 16);
+            new_block = Maps::getTileBlock(unit->path.dest.x, unit->path.dest.y, unit->path.dest.z);
-            df::tile_occupancy occ = block->OccupancyAt(pos);
+            // just to be safe, prevent the dwarf from being moved to an unallocated map block!
-            occ.bits.unit = 0;
+            if (!old_block || !new_block)
-            occ.bits.unit_grounded = 0;
+                continue;
-            block->setOccupancyAt(pos, occ);
+
-            
+            // clear appropriate occupancy flags at old tile
-            //move immediately to destination
+            if (unit->flags1.bits.on_ground)
+                // this is technically wrong, but the game will recompute this as needed
+                old_block->occupancy[unit->pos.x & 0xF][unit->pos.y & 0xF].bits.unit_grounded = 0;
+            else
+                old_block->occupancy[unit->pos.x & 0xF][unit->pos.y & 0xF].bits.unit = 0;
+
+            // if there's already somebody standing at the destination, then force the unit to lay down
+            if (new_block->occupancy[unit->path.dest.x & 0xF][unit->path.dest.y & 0xF].bits.unit)
+                unit->flags1.bits.on_ground = 1;
+
+            // set appropriate occupancy flags at new tile
+            if (unit->flags1.bits.on_ground)
+                new_block->occupancy[unit->path.dest.x & 0xF][unit->path.dest.y & 0xF].bits.unit_grounded = 1;
+            else
+                new_block->occupancy[unit->path.dest.x & 0xF][unit->path.dest.y & 0xF].bits.unit = 1;
+
+            // move unit to destination
             unit->pos.x = unit->path.dest.x;
             unit->pos.y = unit->path.dest.y;
             unit->pos.z = unit->path.dest.z;
         }
-        MCache->WriteAll();
-        delete MCache;
     }
     return CR_OK;
 }
 
 static command_result fastdwarf (color_ostream &out, vector <string> & parameters)
 {
-    if (parameters.size() == 1) {
+    if (parameters.size() > 2) {
-        if ( parameters[0] == "0" ) {
+        out.print("Incorrect usage.\n");
-            enable_fastdwarf = false;
+        return CR_FAILURE;
-            enable_teledwarf = false;
+    }
-        } else if ( parameters[0] == "1" ) {
+
-            enable_fastdwarf = true;
+    if (parameters.size() <= 2)
-            enable_teledwarf = false;
+    {
-        } else {
+        if (parameters.size() == 2)
-            out.print("Incorrect usage.\n");
+        {
-            return CR_OK;
+            if (parameters[1] == "0")
+                enable_teledwarf = false;
+            else if (parameters[1] == "1")
+                enable_teledwarf = true;
+            else
+            {
+                out.print("Incorrect usage.\n");
+                return CR_FAILURE;
+            }
         }
-    } else if (parameters.size() == 2) {
+        else
-        if ( parameters[0] == "0" ) {
+            enable_teledwarf = false;
+        if (parameters[0] == "0")
+        {
             enable_fastdwarf = false;
-        } else if ( parameters[0] == "1" ) {
+            if (df::global::debug_turbospeed)
+                *df::global::debug_turbospeed = false;
+        }
+        else if (parameters[0] == "1")
+        {
             enable_fastdwarf = true;
-        } else {
+            if (df::global::debug_turbospeed)
-            out.print("Incorrect usage.\n");
+                *df::global::debug_turbospeed = false;
-            return CR_OK;
         }
-        if ( parameters[1] == "0" ) {
+        else if (parameters[0] == "2")
-            enable_teledwarf = false;
+        {
-        } else if ( parameters[1] == "1" ) {
+            if (df::global::debug_turbospeed)
-            enable_teledwarf = true;
+            {
-        } else {
+                enable_fastdwarf = false;
-            out.print("Incorrect usage.\n");
+                *df::global::debug_turbospeed = true;
-            return CR_OK;
+            }
+            else
+            {
+                out.print("Speed level 2 not available.\n");
+                return CR_FAILURE;
+            }
         }
-    } else if (parameters.size() == 0) {
-        //print status
-        out.print("Current state: fast = %d, teleport = %d.\n", enable_fastdwarf, enable_teledwarf);
-    } else {
-        out.print("Incorrect usage.\n");
-        return CR_OK;
-    }
-    /*if (parameters.size() == 1 && (parameters[0] == "0" || parameters[0] == "1"))
-    {
-        if (parameters[0] == "0")
-            enable_fastdwarf = 0;
         else
-            enable_fastdwarf = 1;
+        {
-        out.print("fastdwarf %sactivated.\n", (enable_fastdwarf ? "" : "de"));
+            out.print("Incorrect usage.\n");
+            return CR_FAILURE;
+        }
     }
-    else
+
-    {
+    out.print("Current state: fast = %d, teleport = %d.\n",
-        out.print("Makes your minions move at ludicrous speeds.\n"
+        (df::global::debug_turbospeed && *df::global::debug_turbospeed) ? 2 : (enable_fastdwarf ? 1 : 0),
-            "Activate with 'fastdwarf 1', deactivate with 'fastdwarf 0'.\n"
+        enable_teledwarf ? 1 : 0);
-            "Current state: %d.\n", enable_fastdwarf);
-    }*/
 
     return CR_OK;
 }
@@ -139,14 +170,16 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
     commands.push_back(PluginCommand("fastdwarf",
         "enable/disable fastdwarf and teledwarf (parameters=0/1)",
         fastdwarf, false,
-        "fastdwarf: controls speedydwarf and teledwarf. Speedydwarf makes dwarves move quickly and perform tasks quickly. Teledwarf makes dwarves move instantaneously, but do jobs at the same speed.\n"
+        "fastdwarf: make dwarves faster.\n"
         "Usage:\n"
-        "  fastdwarf 0 0: disable both speedydwarf and teledwarf\n"
+        "  fastdwarf <speed> (tele)\n"
-        "  fastdwarf 0 1: disable speedydwarf, enable teledwarf\n"
+        "Valid values for speed:\n"
-        "  fastdwarf 1 0: enable speedydwarf, disable teledwarf\n"
+        " * 0 - Make dwarves move and work at standard speed.\n"
-        "  fastdwarf 1 1: enable speedydwarf, enable teledwarf\n"
+        " * 1 - Make dwarves move and work at maximum speed.\n"
-        "  fastdwarf 0: disable speedydwarf, disable teledwarf\n"
+        " * 2 - Make ALL creatures move and work at maximum speed.\n"
-        "  fastdwarf 1: enable speedydwarf, disable teledwarf\n"
+        "Valid values for (tele):\n"
+        " * 0 - Disable dwarf teleportation (default)\n"
+        " * 1 - Make dwarves teleport to their destinations instantly.\n"
         ));
     
     return CR_OK;