Editing Module:AbilityHints/docGive feedback

== Overview ==

Renders a small strip of item icons showing how an ability interacts with items and used by [[Module:AbilitySection]]. 
Each icon displays a configured image and has a hover tooltip.

Hints can be "automatic" and "manual".
* Automatic come from [[Module:AbilityTable/Lists]]. If an ability is part of 'debuffresist' list, then it will show automatic debuff resist hint. List of enabled automatic hints is configured through CONFIG in this module. Clicking on an icon does nothing, however tooltip often will have a link to relevant item/mechanic.
* Manual hints come from {{tl|AbilityInteraction}} blocks used on AbilitySection. Whenetever an editor describes an interaction using that block a hint will be displayed. Clicking on a hint reveals that hand-written block.

== Entry point ==

=== <code>p.get_icons(ability_key, ability_num)</code> ===
Returns the rail HTML for one ability, or an empty string when the ability matches no lists.

== Configuration ==

=== <code>CONFIG</code> ===
List of the icons the rail can show. Order within <code>CONFIG</code> does not affect the rendered output — see [[#Display order|Display order]]. Each entry:

{| class="wikitable"
! Field !! Description
|-
| <code>list</code> || List name in [[Module:AbilityTable/Lists]] whose membership triggers the icon.
|-
| <code>file</code> || Image file to display, e.g. <code>Reactive Barrier.png</code>. Also determines the icon's position in the rail.
|-
| <code>tip</code> || Hover tooltip text. May contain wikilinks and simple HTML (<code><nowiki><br></nowiki></code>, <code><nowiki><b></nowiki></code>).
|}

To add an icon, add a <code>CONFIG</code> row: pick the triggering <code>list</code>, the display <code>file</code>, and the <code>tip</code>. To re-scope which abilities an icon covers, edit the list in [[Module:AbilityTable/Lists]].