Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365
Conversation
|
I am intrigued and delighted : ) |
|
Let me finish reviewing DFHack/dfhack#4959 so getUnitsInBox no longer returns inactive units
|
| @@ -0,0 +1,281 @@ | |||
| -- Show tooltips on units and/or mouse | |||
|
|
|||
| local RELOAD = false -- set to true when actively working on this script | |||
There was a problem hiding this comment.
FYI, devel/clear-script-env has the same effect:
multicmd devel/clear-script-env gui/tooltips; gui/tooltips
| :tags: fort inspection | ||
|
|
||
| This script shows "tooltips" following units and/or mouse with job names. | ||
|
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
added an **IMPORTANT NOTE** at the beginning of the description text
docs/gui/tooltips.rst
Outdated
| :summary: Show tooltips with useful info. | ||
| :tags: fort inspection | ||
|
|
||
| This script shows "tooltips" following units and/or mouse with job names. |
There was a problem hiding this comment.
needs more description of the two options and their effects.
There was a problem hiding this comment.
added a bit of clarification...
It's kind of hard to describe though
| local function GetTooltipText(x,y,z) | ||
| local txt = {} | ||
| local units = dfhack.units.getUnitsInBox(x,y,z,x,y,z) or {} -- todo: maybe (optionally) use filter parameter here? |
There was a problem hiding this comment.
can take a pos param to this function and pass pos, pos to getUnitsInBox -- it supports pos params as of DFHack/dfhack#5146
|
|
||
| -- -> map viewport offset | ||
| local vp = df.global.world.viewport | ||
| local vp_Coord = vp.window_x -- is actually coord |
There was a problem hiding this comment.
this field appears to be misnamed -- let me correct that to just window (or maybe "corner" since that's how it's named in the DF headers)
There was a problem hiding this comment.
the structure field rename PR has been merged. it's now called vp.corner
Co-authored-by: Myk <myk.taylor@gmail.com>
Co-authored-by: Myk <myk.taylor@gmail.com>
|
Btw this PR has started some discussion on the Discord server where your input would be valuable: https://discord.com/channels/793331351645323264/807444515194798090/1325754489659195502 |
The script shows some info (currently: name of the job) in tooltips (sort of...) following units and or mouse (see screenshot).