I've been working on a mod which adds a shortcut accessed selector item, and I've noticed that shortcuts don't display localised descriptions when moussed over, even if it's defined.
Now, I'm still on an older version (.19), but looking at the changelog, I don't think it was addressed at all. Is that still the case?
Shortcut localised_description unused?
Re: Shortcut localised_description unused?
Just stumbled across the same problem: I've defined a Prototype/Shortcut with both localised_name and localised_description:
Suggestion: In the list of available shortcuts (see the left red rectangle in the screenshot above), display localised_name, and use localised_description as tooltip for the shortcut hovered over with the mouse. In the quick-select shortcut list (the red rectangle on the right), combine name and description, so the tooltip is
However, the only thing I see used in the game is localised_name:
Quite a dilemma: I feel I need a description because selecting an area will do something other (open a GUI with the selected entities, or add selected entities to an existing GUI for alt-select, or remove selected entities from an existing GUI for reverse-select) than clicking on a distinct position ("claim", "lock/unlock", or "summon" a single entity). But the description is too long to be useful as a title -- "GCKI: Keys" is short enough for that to see what kind of shortcut it is, and what mod introduced it.Suggestion: In the list of available shortcuts (see the left red rectangle in the screenshot above), display localised_name, and use localised_description as tooltip for the shortcut hovered over with the mouse. In the quick-select shortcut list (the red rectangle on the right), combine name and description, so the tooltip is
Code: Select all
{"", {"shortcut-name.name-of-your-shortcut"}, ":\n", {"shortcut-description.your-description"}}
A good mod deserves a good changelog. Here's a tutorial (WIP) about Factorio's way too strict changelog syntax!