Equip-v2 : have flavour text for all equipment

[mwerle]

From discussion in #5734 : #5734 (comment)

---

TODO:

GENERAL: All equipment should contain a small blurb about itself, what it does, and some flavour text. Some equipment already has "what it does"

• Missile racks should display the number/type/size of missiles it can store.
  

• Missiles should display their damage, max-range, and manoeuvrability
  

• Hyperdrives should display the max jump-distance and fuel-usage (given the current ship)
  

• Shields should display protection stats for the given ship
  

[sturnclaw]

Note: this work should also include populating equipment comparison stats for different equip types, see data/modules/Equipment/Stats.lua.

[mwerle]

One issue is that the "_DESCRIPTION" string is currently being used for both the description as well as the tooltip for equipment.

This is fine for short and concise descriptions, but is inappropriate for longer, potentially humorous, flavour text.

Proposal: "_DESCRIPTION" is used as currently defined, and "_EXTENDED_DESCRIPTION" or "_DESCRIPTION_LONG" is appended to the "_DESCRIPTION" in the description field.

For example:

"MISSILE_UNGUIDED_DESCRIPTION": {
"description": "Used in tooltip and start of the long description",
"message": "A generic dumb-fire rocket mass-produced on most worlds."
},
"MISSILE_UNGUIDED_DESCRIPTION_LONG": {
"description": "Used to extend the DESCRIPTION",
"message": "Manufactured by local producers, from being loving hand-crafted by artisans on developing worlds to being mindlessly churned out by the millions in automated mega-factories on hyper-industrialised ones, these are nevertheless guaranteed to work in most ship systems as their specifications are tightly controlled by GalCop(*). Simply aim and fire to solve your problems."
},

(*) Yes, I need to read my way more into the lore of Pioneer and leave that of Elite behind..

---

This would show in the tooltip as :
"A generic dumb-fire rocket mass-produced on most worlds."

And in the description panel on the outfitting screen as:
"A generic dumb-fire rocket mass-produced on most worlds.
Manufactured by local producers, from being loving hand-crafted by artisans on developing worlds to being mindlessly churned out by the millions in automated mega-factories on hyper-industrialised ones, these are nevertheless guaranteed to work in most ship systems as their specifications are tightly controlled by GalCop(*). Simply aim and fire to solve your problems."

---

Alternatively, use "_TOOLTIP" for, you guessed it, the tooltip (as in a lot of other parts of the codebase), and "_DESCRIPTION" only for the description panel. This might lead to a lot of duplicate text though.

One option could be that the _TOOLTIP, if not explicitly specified, uses the _DESCRIPTION, which would be fallback to the current implementation.

---

Thoughts?

[bszlrd]

Artisanal rockets? I love that

[sturnclaw]

Could also have it as <MISSILE>_DESCRIPTION for the tooltip/one-line overview of what the equipment does, and <MISSILE>_FLAVOR for the multi-line flavor text explanation. Overall I like the idea.

EDIT: I'm strongly in favor of appending the flavor text to the existing tooltip description - otherwise there's a good bit of duplication.