Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

TymurGubayev · 2025-01-04T16:31:12Z

The script shows some info (currently: name of the job) in tooltips (sort of...) following units and or mouse (see screenshot).

myk002 · 2025-01-06T03:23:04Z

I am intrigued and delighted : )

myk002 · 2025-01-06T09:08:27Z

Let me finish reviewing DFHack/dfhack#4959 so getUnitsInBox no longer returns inactive units

myk002 · 2025-01-06T08:58:49Z

gui/tooltips.lua

@@ -0,0 +1,281 @@
+-- Show tooltips on units and/or mouse
+
+local RELOAD = false -- set to true when actively working on this script


FYI, devel/clear-script-env has the same effect:

multicmd devel/clear-script-env gui/tooltips; gui/tooltips

gui/tooltips.lua

myk002 · 2025-01-06T09:27:21Z

docs/gui/tooltips.rst

+    :tags: fort inspection
+
+This script shows "tooltips" following units and/or mouse with job names.
+


needs disclaimer that tooltips will show over any vanilla UI elements:

The dig ascii overlays suffer from the same problem. I don't know of any good solution here. I'm not saying that any behavior needs to change -- just needs to be documented.

added an **IMPORTANT NOTE** at the beginning of the description text

docs/gui/tooltips.rst

myk002 · 2025-01-06T09:29:39Z

docs/gui/tooltips.rst

+    :summary: Show tooltips with useful info.
+    :tags: fort inspection
+
+This script shows "tooltips" following units and/or mouse with job names.


needs more description of the two options and their effects.

added a bit of clarification...
It's kind of hard to describe though

gui/tooltips.lua

Co-authored-by: Myk <[email protected]>

myk002 · 2025-01-06T19:00:09Z

Btw this PR has started some discussion on the Discord server where your input would be valuable: https://discord.com/channels/793331351645323264/807444515194798090/1325754489659195502

Also, simplify GetUnitJob

myk002

My feedback:

this would be better as a fullscreen overlay that could be toggled via a keybinding bound to dwarfmode/Default and dungeonmode/Default (file). It could also be toggleable from gui/tooltips (which becomes just the configuration interface instead of the rendering mechanism). I don't want to promote leaving a windowed DFHack tool on the screen indefinitely because of Prevent crash if DFHack GUI window is open when exiting fort dfhack#4183
the enabled state should be managed by the overlay framework. this means that whether the tooltips are displayed is a per-player global setting. The tooltip behavior/contents configuration would likewise be global, stored in dfhack-config/tooltips.json

There were some reservations about the name gui/tooltips -- I'll get more feedback from people about that on Discord.

not required for this PR but maybe consider as a future enhancement:

the configuration for which elements to display could be a matrix of checkboxes so players could choose any combination of information for the tooltip and the mouseover.

TymurGubayev · 2025-01-12T12:29:29Z

the configuration for which elements to display could be a matrix of checkboxes so players could choose any combination of information for the tooltip and the mouseover.

is there a CheckBox control, or what should I use for this?

myk002 · 2025-01-15T01:03:45Z

There isn't a super convenient widget for that yet, largely because every place I've needed toggle checkboxes so far, they've been in a list (which doesn't take widgets). See gui/control-panel or maybe the prototype code in gui/manipulator for examples of the list-based approach. You could likely reuse the graphic assets and just slap them on a Label for a non-List option.

TymurGubayev · 2025-01-18T22:51:41Z

Config UI with current defaults

myk002 · 2025-01-20T21:44:04Z

gui/tooltips.lua

@@ -267,7 +269,7 @@ function MouseTooltip:render(dc)

    local pos = dfhack.gui.getMousePos()
    local text = GetTooltipText(pos)
-    if #text == 0 then return end
+    if not text or #text == 0 then return end


not just an ascii mode exception -- dfhack.gui.getMousePos() would return nil in graphics mode too if the mouse cursor is not over the DF window

I couldn't reproduce it in graphics though, probably because of the check just above for the dfhack.screen.getMousePos() return value.

myk002 · 2025-01-20T22:09:36Z

should probably ensure the mouseover panel renders over the other floating text:

myk002

as discussed on Discord, could you rename gui/tooltips to gui/spectate and move the overlay code to plugins/lua/spectate.lua? spectate itself will need a bit of an overhaul. I can do that or you can if you'd like to.

myk002 · 2025-01-20T22:11:27Z

gui/tooltips.lua

+local gui = require('gui')
+local widgets = require('gui.widgets')
+local overlay = require('plugins.overlay')
+local ResizingPanel = require('gui.widgets.containers.resizing_panel')


this doesn't need to be individually imported -- it can already be addressed as widgets.ResizingPanel

myk002 · 2025-01-20T22:12:42Z

gui/tooltips.lua

+
+-- pens are the same as gui/control-panel.lua
+local textures = require('gui.textures')
+local function get_icon_pens()


this is ugly duplication, but we don't have a good widget API for it yet, so I don't think there's a better option. We can change this later once we have a better way to address this fairly common use case. I see orders.lua does some similar duplication for the workshop labor restrictions overlay.

TymurGubayev · 2025-01-20T22:18:56Z

should probably ensure the mouseover panel renders over the other floating text

yeah, that might be a good idea :) But how?

myk002 · 2025-01-20T22:19:21Z

order of rendering in render()

TymurGubayev · 2025-01-20T22:21:34Z

as discussed on Discord, could you rename gui/tooltips to gui/spectate and move the overlay code to plugins/lua/spectate.lua? spectate itself will need a bit of an overhaul. I can do that or you can if you'd like to.

I'll try to do that, just can't promise when.

myk002 · 2025-01-20T22:23:01Z

I can overhaul spectate in the 51.01-r2 release timeframe. that would give us about a month to get this all finalized and merged

TymurGubayev added 2 commits January 4, 2025 16:51

Create tooltips.lua

1ed5e22

Create tooltips.rst

7abc355

myk002 reviewed Jan 6, 2025

View reviewed changes

TymurGubayev and others added 2 commits January 6, 2025 11:16

Update docs/gui/tooltips.rst

66dce0d

Co-authored-by: Myk <[email protected]>

Update gui/tooltips.lua

c27777a

Co-authored-by: Myk <[email protected]>

TymurGubayev added 3 commits January 7, 2025 23:27

enter emoticons

0ca5a9a

fix GetScreenCoordinates for ASCII mode

0f6aeba

Also, simplify GetUnitJob

tooltips.rst: add IMPORTANT NOTE as well as some clarifications

be5bccd

myk002 reviewed Jan 11, 2025

View reviewed changes

TymurGubayev added 3 commits January 12, 2025 11:22

vieport.window_x -> .coord

9484f8e

use getUnitsInBox(pos1, pos2) overload

33dbe85

make this an overlay

8d345a7

TymurGubayev added 2 commits January 18, 2025 23:44

make possible to show specific stress/happiness levels; add config UI

66d8d39

trim trailing whitespaces

e97201c

fix an ASCII mode exception

2e1cf87

myk002 reviewed Jan 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

TymurGubayev commented Jan 4, 2025

myk002 commented Jan 6, 2025

myk002 commented Jan 6, 2025

myk002 Jan 6, 2025

myk002 Jan 6, 2025 •

edited

Loading

TymurGubayev Jan 7, 2025

myk002 Jan 6, 2025

TymurGubayev Jan 7, 2025 •

edited

Loading

myk002 commented Jan 6, 2025 •

edited

Loading

myk002 left a comment

TymurGubayev commented Jan 12, 2025

myk002 commented Jan 15, 2025 •

edited

Loading

TymurGubayev commented Jan 18, 2025

myk002 Jan 20, 2025

TymurGubayev Jan 20, 2025

myk002 commented Jan 20, 2025

myk002 left a comment

myk002 Jan 20, 2025

myk002 Jan 20, 2025

TymurGubayev commented Jan 20, 2025 •

edited

Loading

myk002 commented Jan 20, 2025

TymurGubayev commented Jan 20, 2025

myk002 commented Jan 20, 2025

		@@ -0,0 +1,281 @@
		-- Show tooltips on units and/or mouse

		local RELOAD = false -- set to true when actively working on this script

		:tags: fort inspection

		This script shows "tooltips" following units and/or mouse with job names.

Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

Are you sure you want to change the base?

Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

Conversation

TymurGubayev commented Jan 4, 2025

myk002 commented Jan 6, 2025

myk002 commented Jan 6, 2025

myk002 Jan 6, 2025

Choose a reason for hiding this comment

myk002 Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

TymurGubayev Jan 7, 2025

Choose a reason for hiding this comment

myk002 Jan 6, 2025

Choose a reason for hiding this comment

TymurGubayev Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

myk002 commented Jan 6, 2025 • edited Loading

myk002 left a comment

Choose a reason for hiding this comment

TymurGubayev commented Jan 12, 2025

myk002 commented Jan 15, 2025 • edited Loading

TymurGubayev commented Jan 18, 2025

myk002 Jan 20, 2025

Choose a reason for hiding this comment

TymurGubayev Jan 20, 2025

Choose a reason for hiding this comment

myk002 commented Jan 20, 2025

myk002 left a comment

Choose a reason for hiding this comment

myk002 Jan 20, 2025

Choose a reason for hiding this comment

myk002 Jan 20, 2025

Choose a reason for hiding this comment

TymurGubayev commented Jan 20, 2025 • edited Loading

myk002 commented Jan 20, 2025

TymurGubayev commented Jan 20, 2025

myk002 commented Jan 20, 2025

myk002 Jan 6, 2025 •

edited

Loading

TymurGubayev Jan 7, 2025 •

edited

Loading

myk002 commented Jan 6, 2025 •

edited

Loading

myk002 commented Jan 15, 2025 •

edited

Loading

TymurGubayev commented Jan 20, 2025 •

edited

Loading