reinstate flashstep

Author: myk002

changelog.txt

@@ -35,6 +35,7 @@ Template for new versions:
 - `unretire-anyone`: (reinstated) choose anybody in the world as an adventurer
 - `reveal-adv-map`: (reinstated) reveal (or hide) the adventure map
 - `resurrect-adv`: (reinstated) allow your adventurer to recover from death
+- `flashstep`: (reinstated) teleport your adventurer to the mouse cursor
 
 ## New Features
 - `instruments`: new subcommand ``instruments order`` for creating instrument work orders

docs/flashstep.rst

@@ -2,11 +2,12 @@ flashstep
 =========
 
 .. dfhack-tool::
-    :summary: Teleport your adventurer to the cursor.
-    :tags: unavailable
+    :summary: Teleport your adventurer to the mouse cursor.
+    :tags: adventure armok units
 
 ``flashstep`` is a hotkey-friendly teleport that places your adventurer where
-your cursor is.
+your mouse cursor is. A small area around the target tile is revealed. If you
+take a step, then the normal vision cone area around the unit is revealed.
 
 Usage
 -----

flashstep.lua

@@ -1,19 +1,26 @@
---Teleports adventurer to cursor
---[====[
-
-flashstep
-=========
-A hotkey-friendly teleport that places your adventurer where your cursor is.
-
-]====]
+local function reveal_tile(pos)
+    local block = dfhack.maps.getTileBlock(pos)
+    local des = block.designation[pos.x%16][pos.y%16]
+    des.hidden = false
+    des.pile = true  -- reveal the tile on the map
+end
 
-function flashstep()
-    local unit = df.global.world.units.active[0]
-    if df.global.adventure.menu ~= df.ui_advmode_menu.Look then
-        qerror("No [l] cursor located! You kinda need it for this script.")
+local function flashstep()
+    local unit = dfhack.world.getAdventurer()
+    if not unit then return end
+    local pos = dfhack.gui.getMousePos()
+    if not pos then return end
+    if dfhack.units.teleport(unit, pos) then
+        reveal_tile(xyz2pos(pos.x-1, pos.y-1, pos.z))
+        reveal_tile(xyz2pos(pos.x,   pos.y-1, pos.z))
+        reveal_tile(xyz2pos(pos.x+1, pos.y-1, pos.z))
+        reveal_tile(xyz2pos(pos.x-1, pos.y,   pos.z))
+        reveal_tile(pos)
+        reveal_tile(xyz2pos(pos.x+1, pos.y,   pos.z))
+        reveal_tile(xyz2pos(pos.x-1, pos.y+1, pos.z))
+        reveal_tile(xyz2pos(pos.x,   pos.y+1, pos.z))
+        reveal_tile(xyz2pos(pos.x+1, pos.y+1, pos.z))
     end
-    dfhack.units.teleport(unit, xyz2pos(pos2xyz(df.global.cursor)))
-    dfhack.maps.getTileBlock(unit.pos).designation[unit.pos.x%16][unit.pos.y%16].hidden = false
 end
 
 flashstep()