Create gui/spectate

[TymurGubayev]

Configuration UI for the spectate plugin

[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 DFHack/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.

[TymurGubayev]

Config UI with current defaults

[myk002]

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]

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]

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

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

[myk002]

order of rendering in render()

[TymurGubayev]

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]

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]

config UI is now a list:

[TymurGubayev]

btw, in case anyone is wondering: I haven't forgotten about merging this with spectate, I'm just trying to finish the new stuff first.

[myk002]

no worries! I haven't done my part on spectate yet anyway, so it's not quite ready for you

edit: spectate is ready for you now. I added stubs and empty files in preparation

[TymurGubayev]

some things there might deserve to be moved to some more central location:

• ToggleLabel is like ToggleHotkeyLabel, but uses icon instead of "On"/"Off" text. Maybe make it an option?
• pairsByKeys is a trivial table iterator in key order (with an optional sorting function). I didn't find one; this one I had to write twice (here and in the plugins/spectate.lua)
• rpad is just return string.format("%-"..i.."s", s)... which may be too trivial
• append (which should maybe called concat) concats two sequences together (which is also trivial enough)

[myk002]

I'll see what I can upstream, then I'll clean things up

first upstreamed change: DFHack/dfhack#5296

[TymurGubayev]

that's a lot of red :)