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

[TymurGubayev]

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

[myk002]

I am intrigued and delighted : )

[myk002]

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

[myk002]

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

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

[myk002]

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.

[TymurGubayev]

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

[myk002]

needs more description of the two options and their effects.

[TymurGubayev]

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

[myk002]

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

[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]

• 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]

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.