Merge pull request #5288 from myk002/myk_spectate_jump

[spectate] add API for gui/sitemap

Author: myk002

data/init/dfhack.keybindings.init

@@ -41,6 +41,7 @@ keybinding add Ctrl-A@choose_start_site gui/embark-anywhere
 # in the game root directory
 keybinding add Ctrl-T@dwarfmode/ViewSheets/UNIT|dwarfmode/ViewSheets/ITEM|dungeonmode/ViewSheets/UNIT|dungeonmode/ViewSheets/ITEM markdown
 
+keybinding add Ctrl-G@dwarfmode/Default|dungeonmode/Default gui/sitemap
 
 ######################
 # dwarfmode bindings #

docs/changelog.txt

@@ -59,6 +59,7 @@ Template for new versions:
 - `spectate`: new global keybinding for toggling spectate mode: Ctrl-Shift-S
 - `spectate`: new overlay panel that allows you to cycle through following next/prevous units (regardless of whether spectate mode is enabled)
 - ``disable-vanilla-dimensions``: new binpatch to disable the vanilla dimensions tooltip
+- `gui/sitemap`: is now the official "go to" tool. new global hotkey for fort and adventure mode: Ctrl-G
 
 ## Fixes
 - Windows console: fix possible hang if the console returns a too-small window width (for any reason)

plugins/lua/spectate.lua

@@ -563,7 +563,7 @@ FollowPanelOverlay.ATTRS{
     default_pos={x=6,y=-5},
     viewscreens='dwarfmode/Default',
     default_enabled=true,
-    frame={w=39, h=1},
+    frame={w=29, h=1},
     visible=follow_panel_is_visible,
 }
 
@@ -582,13 +582,14 @@ function FollowPanelOverlay:init()
         widgets.Label{
             frame={l=10, t=0, w=25},
             text={
-                ' spectate mode: ',
-                {text=function() return isEnabled() and 'enabled ' or 'disabled ' end},
+                ' spectate:',
+                {text=function() return isEnabled() and ' on ' or 'off ' end,
+                 pen=function() return isEnabled() and COLOR_GREEN or COLOR_LIGHTRED end},
             },
             on_click=function() dfhack.run_command(isEnabled() and 'disable' or 'enable', 'spectate') end,
         },
         widgets.ConfigureButton{
-            frame={l=36, t=0},
+            frame={l=26, t=0},
             on_click=function() dfhack.run_script('gui/spectate') end,
         }
     }

plugins/spectate.cpp

@@ -175,17 +175,36 @@ static class UnitHistory {
         offset = 0;
     }
 
+    void add_to_history(color_ostream &out, int32_t unit_id) {
+        if (offset > 0) {
+            DEBUG(cycle,out).print("trimming history forward of offset %zd\n", offset);
+            history.resize(history.size() - offset);
+            offset = 0;
+        }
+        if (history.size() && history.back() == unit_id) {
+            DEBUG(cycle,out).print("unit %d is already current unit; not adding to history\n", unit_id);
+        } else {
+            history.push_back(unit_id);
+            if (history.size() > MAX_HISTORY) {
+                DEBUG(cycle,out).print("history full, truncating\n");
+                history.pop_front();
+            }
+        }
+        DEBUG(cycle,out).print("history now has %zd entries\n", history.size());
+    }
+
     void add_and_follow(color_ostream &out, df::unit *unit) {
         // if we're currently following a unit, add it to the history if it's not already there
         if (plotinfo->follow_unit > -1 && plotinfo->follow_unit != get_cur_unit_id()) {
             DEBUG(cycle,out).print("currently following unit %d that is not in history; adding\n", plotinfo->follow_unit);
-            update_history(out, plotinfo->follow_unit);
+            add_to_history(out, plotinfo->follow_unit);
         }
 
         int32_t id = unit->id;
-        update_history(out, id);
+        add_to_history(out, id);
         DEBUG(cycle,out).print("now following unit %d: %s\n", id, DF2CONSOLE(Units::getReadableName(unit)).c_str());
         Gui::revealInDwarfmodeMap(Units::getPosition(unit), false, World::ReadPauseState());
+        plotinfo->follow_item = -1;
         plotinfo->follow_unit = id;
     }
 
@@ -199,6 +218,7 @@ static class UnitHistory {
         DEBUG(cycle,out).print("scanning back to unit %d at offset %zd\n", unit_id, offset);
         if (auto unit = df::unit::find(unit_id))
             Gui::revealInDwarfmodeMap(Units::getPosition(unit), false, World::ReadPauseState());
+        plotinfo->follow_item = -1;
         plotinfo->follow_unit = unit_id;
     }
 
@@ -214,6 +234,7 @@ static class UnitHistory {
         DEBUG(cycle,out).print("scanning forward to unit %d at offset %zd\n", unit_id, offset);
         if (auto unit = df::unit::find(unit_id))
             Gui::revealInDwarfmodeMap(Units::getPosition(unit), false, World::ReadPauseState());
+        plotinfo->follow_item = -1;
         plotinfo->follow_unit = unit_id;
     }
 
@@ -222,25 +243,6 @@ static class UnitHistory {
             return -1;
         return history[history.size() - (1 + offset)];
     }
-
-private:
-    void update_history(color_ostream &out, int32_t unit_id) {
-        if (offset > 0) {
-            DEBUG(cycle,out).print("trimming history forward of offset %zd\n", offset);
-            history.resize(history.size() - offset);
-            offset = 0;
-        }
-        if (history.size() && history.back() == unit_id) {
-            DEBUG(cycle,out).print("unit %d is already current unit; not adding to history\n", unit_id);
-        } else {
-            history.push_back(unit_id);
-            if (history.size() > MAX_HISTORY) {
-                DEBUG(cycle,out).print("history full, truncating\n");
-                history.pop_front();
-            }
-        }
-        DEBUG(cycle,out).print("history now has %zd entries\n", history.size());
-    }
 } unit_history;
 
 /////////////////////////////////////////////////////
@@ -392,7 +394,7 @@ DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_chan
 DFhackCExport command_result plugin_onupdate(color_ostream &out) {
     announcement_settings.on_update(out);
 
-    if (config.auto_disengage && (plotinfo->follow_unit < 0 || is_squads_open())) {
+    if (config.auto_disengage && (plotinfo->follow_unit < 0 || plotinfo->follow_item > -1 || is_squads_open())) {
         DEBUG(cycle,out).print("auto-disengage triggered\n");
         is_enabled = false;
         plotinfo->follow_unit = -1;
@@ -600,9 +602,19 @@ static void spectate_followNext(color_ostream &out) {
     set_next_cycle_unpaused_ms(out);
 };
 
+static void spectate_addToHistory(color_ostream &out, int32_t unit_id) {
+    DEBUG(control,out).print("entering spectate_addToHistory; unit_id=%d\n", unit_id);
+    if (!df::unit::find(unit_id)) {
+        WARN(control,out).print("unit with id %d not found; not adding to history\n", unit_id);
+        return;
+    }
+    unit_history.add_to_history(out, unit_id);
+}
+
 DFHACK_PLUGIN_LUA_FUNCTIONS {
     DFHACK_LUA_FUNCTION(spectate_setSetting),
     DFHACK_LUA_FUNCTION(spectate_followPrev),
     DFHACK_LUA_FUNCTION(spectate_followNext),
+    DFHACK_LUA_FUNCTION(spectate_addToHistory),
     DFHACK_LUA_END
 };