Improve tooltip moddability @ FFF318

[eradicator]

What?
With https://factorio.com/blog/post/fff-318 promising fancy new tooltips for vanilla i'd like to take the chance and grab some attention to moddability of those. Currently there are two methods for tooltip modding:

Rich Text

hacky proof of concept

Code: Select all

/c --[[quick and dirty hack to create a recipe tooltip with rich text formatting]]

local CLOCK = "[img=utility/clock] "
local PROD = "Products:"
local ING = "Ingredients:"
local NL = '\n'
local FONT = '[font=default-large]'
local ICON_FONT = '[font=default]'
local SECONDS = ' seconds'

local function icon(type,name) return ICON_FONT..'['..type..'='..name..'][/font]' end
local function append(t,x) local n=#t for i=1,#x do t[n+i] = x[i] end end
local function format(x)
  local r = {'',}
  for _,v in pairs(x) do  
    local prefix = 'item-name.'; if v.type == 'fluid' then prefix = 'fluid-name.'
    elseif game.item_prototypes[v.name].place_result then prefix = 'entity-name.' end
    r[#r+1] = {'','  ',icon(v.type,v.name),' ',v.amount,' × ',{prefix..v.name},NL}
    end
  return r
  end

local function recipe_tooltip(name)
  local r = game.recipe_prototypes[name]
  local t = {
    '',FONT,
    icon('recipe',name),' ',r.localised_name,NL,
    '  ',icon('img','utility/clock'),r.energy,SECONDS,'',NL,
    }
  append(t,{NL,PROD,NL,format(r.products)})
  append(t,{NL,ING,NL,format(r.ingredients)})
  t[#t+1] = '[/font]'
  return t
  end

local p = game.players[1]

p.gui.center.clear()
--[[
p.gui.center.add{type='button'}.tooltip = recipe_tooltip('coal-liquefaction')
p.gui.center.add{type='button'}.tooltip = recipe_tooltip('steam-turbine')
p.gui.center.add{type='button'}.tooltip = recipe_tooltip('light-oil-cracking')
p.gui.center.add{type='button'}.tooltip = recipe_tooltip('nuclear-reactor')
]]

local pane = p.gui.center.add{type='scroll-pane'}
local tbl = pane.add{type='table',column_count=9}
pane.style.width  = 400
pane.style.height = 400

for k,v in pairs(game.recipe_prototypes) do
  tbl.add{type='sprite-button',sprite='recipe/'..k}.tooltip = recipe_tooltip(k)
  tbl.add{type='choose-elem-button',elem_type='recipe',recipe=v.name}.enabled=false
  end

tooltip_richtext.png (304.32 KiB) Viewed 2053 times

Disabled choose-elem-button

tooltip_chose_elm.png (266.4 KiB) Viewed 2053 times

Both methods have problems:

Rich Text while better than the plain text from pre-0.17 only offers very limited format control, but complete content control, and can be used on any type of gui element, not only buttons.

Disabled choose-elem-buttons automatically create standard tooltips and thus can not be extended with mod-specific information. They also can not be used on anything else like labels or sliders, switches etc.

So what?
So, i'd like to request more moddability for tooltips. There are two stages that this could be improved:

Stage1: Allow assigning a new "fancy multi-tooltip" of arbitrary composition to all LuaGuiElement types (or if difficult a limited subset). This means that it's up to the mod which tooltips should be shown, i.e. it should be possible to show a recipe alongside it's technology instead of it's products.

Stage2: Allow accessing tooltips as standard LuaGuiElements so they can be completely customized. As this needs to be performant for large numbers of tooltips on the same screen (i.e. Helmod/FactoryPlanner) i'm not sure how this would be done. Pre-creating all tooltips when a majority of them will never be shown seems inefficient. Using an event-based solution like "on_player_focused_element" to allow mods to dynamically create tooltips would incur multiplayer lag on tooltips which is also undesirable. And assigning a sandboxed function to each tooltip that dynamically creates it seems unrealistic, as does a custom "tooltip description language". So... given my lack of knowledge of engine internals and coding inexperience i regrettably don't really have a workable proposition for this :|.

Thank your for reading this far. And hopefully someone has useful feedback-feedback ;).

[Rseding91]

Allowing mods to define a Lua GUI elements tooltip as another Lua GUI element might be viable. It's definitely not a simple task though.

Making all tooltips use the LuaGuiElement system is never going to happen so that's just out automatically.

[eradicator]

Allowing mods to define a Lua GUI elements tooltip as another Lua GUI element might be viable. It's definitely not a simple task though.

Making all tooltips use the LuaGuiElement system is never going to happen so that's just out automatically.

Do you just mean that there would be two ways to define tooltips? Ofc i don't want to break existing mods.

Speaking of which, the FFF mentions that the system uses "Categories" in the background, so regarding "Stage 1" of the OP, would it be possible/realistic/useful to expose these so that mods can construct a "vanilla like" tooltip i.e. by specifying it as a table. And would that be less work/more performant than the "tooltip as a LuaGuiElement" approach?

A very rough example:

Code: Select all

a_gui_element.fancy_tooltips = { 
  direction = 'horizontal' --how to show several tooltips at once
  components = {{ --list of multiple tooltips (as described in the FFF for recipies+products)
    {category = 'root', --free text description field
     text = {'item-description.personal-roboport'}},
    {category  = 'placed-in-equipment-grid'
      name = 'personal-roboport'}, -- take the information from a known prototype?
    {category = 'consumes-electricity',
     something = '1kJ',
     something = '2MW',
    }},
  }
}

[Therenas]

I would appreciate the proposals here quite a bit. I would mainly make use of stage 1, so I can display proper recipe tooltips where I want them to be. I assume the new fancy multi-stage recipe tooltips would be useable for this too, as those are really nice and not reproduceable easily or at all by a mod.

Regarding the stage 2 of this, now that I think about it I assume the (old) vanilla recipe tooltips use a system similar to the GUI one themselves? Either way, we'd probably not need all GUI elements to be available for use in tooltips, only some basic ones like flows, tables, labels and sprites, if limiting it to those makes the implementation easier.

[Optera]

Even being able to allow adding certain lines to existing tooltips would be enough for my purposes.
Namely displaying max_speed of all rolling stock and not just locomotives.

[Therenas]

I just tried the workaround to not being able to have the nice tooltips. I created locked choose-elem-buttons instead of normal sprite-buttons. On an admittedly large set of 1500 buttons, it makes the creation time (for the whole function) go from 55ms to 850ms. Even on much smaller sets of 16 buttons, it goes from 2.7ms to 4.6ms. So that workaround is obviously not going to work. I assume that performance loss has nothing to do with the tooltips themselves, but more with the fact that choose-elem-buttons are not at all intended to be used this way. So this is another argument to why being able to put the tooltips on other elements might be needed.

[KiwiHawk]

Bump!

I'm working on improvements for Helmod. I'd like to create vanilla style tooltips for energy "recipes". Current tooltip:

HelmodTooltip.png (72.01 KiB) Viewed 1256 times

I'd like to make it look more like this, but probably without details of products:

HelmodTooltip2.png (123.22 KiB) Viewed 1256 times