gui/probe candidate

changelog.txt

@@ -27,6 +27,7 @@ Template for new versions:
 # Future
 
 ## New Tools
+- `gui/probe`: Now you can check the properties of a tile by hovering the mouse over it.
 
 ## New Features
 

docs/gui/probe.rst

@@ -0,0 +1,17 @@
+gui/probe
+===========
+
+.. dfhack-tool::
+    :summary: Check tile properties.
+    :tags: fort inspection map
+
+Shows the output of "probe"(tiletype, material, temperature, etc...) on the tile below mouse on a window on the right hand of the screen. 
+
+Usage
+-----
+
+::
+
+    gui/confirm
+
+Hover the mouse over the tile you wish to inspect, left click to lock on the current tile.

gui/probe.lua

@@ -0,0 +1,132 @@
+-- Shows the info given by `probe` in a friendly display
+
+local gui = require('gui')
+local guidm = require('gui.dwarfmode')
+local widgets = require('gui.widgets')
+local overlay = require('plugins.overlay')
+
+Probe = defclass(Probe, widgets.Window)
+Probe.ATTRS{
+    frame = {
+        w = 40,
+        h = 45,
+        r = 2,
+        t = 18,
+    },
+    resizable=true,
+    frame_title='Probe',
+    cycle_lock=false,
+}
+
+local cursor_pen = dfhack.pen.parse {
+    ch = "+",
+    fg = COLOR_YELLOW,
+    keep_lower = true,
+    tile = dfhack.screen.findGraphicsTile(
+        "CURSORS",
+        0,
+        22
+    ),
+}
+
+function Probe:init()
+    self:addviews{
+        widgets.ToggleHotkeyLabel{
+            key='CUSTOM_CTRL_F',
+            view_id='lock',
+            frame={t=0, l=0},
+            key='CUSTOM_CTRL_F',
+            label='Lock on tile:',
+            initial_option=false,
+        },
+        widgets.WrappedLabel{
+            view_id='report',
+            frame={t=2, l=0},
+        },
+    }
+end
+
+function Probe:onRenderBody()
+    --Cycle the cursor lock if the user just clicked the map.
+    if self.cycle_lock then
+        if not (dfhack.gui.getSelectedUnit(true) or dfhack.gui.getSelectedBuilding(true)) then
+            self.subviews.lock:cycle()
+        end
+        self.cycle_lock = false
+    end
+
+    --If a unit is selected, show unit details.
+    if dfhack.gui.getSelectedUnit(true) then
+        local report = dfhack.run_command_silent('cprobe')
+        self.subviews.report.text_to_wrap = report
+        self:updateLayout()
+        return true
+    end
+
+    --If a building is selected, show building details.
+    if dfhack.gui.getSelectedBuilding(true) then
+        local report = dfhack.run_command_silent('bprobe')
+        self.subviews.report.text_to_wrap = report
+        self:updateLayout()
+        return true
+    end
+
+    --If nor unit nor building is selected, show cursor and details on the tile under mouse.
+    if dfhack.screen.inGraphicsMode() then
+        guidm.renderMapOverlay(function() return cursor_pen end, {x1 = pos.x, x2= pos.x, y1 = pos.y, y2= pos.y, z1 = pos.z, z2= pos.z})
+    elseif gui.blink_visible(500) then
+        guidm.renderMapOverlay(function() return cursor_pen end, {x1 = pos.x, x2= pos.x, y1 = pos.y, y2= pos.y, z1 = pos.z, z2= pos.z})
+    end
+
+    if not (self.subviews.lock:getOptionValue() or self:getMouseFramePos()) then
+        pos = dfhack.gui.getMousePos() or pos
+    end
+    local report = dfhack.run_command_silent('probe', '--cursor', string.format("%d,%d,%d", pos.x, pos.y, pos.z))
+    self.subviews.report.text_to_wrap = report
+    self:updateLayout()
+end
+
+function Probe:onInput(keys)
+    if Probe.super.onInput(self, keys) then
+        return true
+    end
+
+    --Cycle the cursor lock if the user clicks the map.
+    if keys._MOUSE_L and not self:getMouseFramePos() then
+        self.cycle_lock = true
+        return false
+    end
+
+    if (keys.LEAVESCREEN or keys._MOUSE_R) then
+        if dfhack.gui.getSelectedUnit(true) or dfhack.gui.getSelectedBuilding(true) then
+            self.parent_view:sendInputToParent(keys)
+            return true
+        else
+            self.parent_view:dismiss()
+            return true
+        end
+    end
+end
+
+ProbeScreen = defclass(ProbeScreen, gui.ZScreen)
+ProbeScreen.ATTRS{
+    focus_string = 'probe',
+    pass_pause = true,
+    pass_movement_keys = true,
+    pass_mouse_clicks = true,
+    defocusable=false,
+}
+
+function ProbeScreen:init()
+    self:addviews{Probe{}}
+end
+
+function ProbeScreen:onDismiss()
+    view = nil
+end
+
+if not dfhack.isMapLoaded() then
+    qerror("This script requires a fortress map to be loaded")
+end
+
+view = view and view:raise() or ProbeScreen {}:show()