Module:AbilityHints/doc

Revision as of 23:14, 13 July 2026 by Vergir (talk | contribs) (Docs: update CONFIG contract — item replaced by file + link; note the absolute-URL requirement for suppressing Page Previews (with help from vergir-bot LLM))

This is the documentation page for Module:AbilityHints

Overview

Renders the interaction-hint rail on ability cards (via Module:AbilitySection): a small strip of item icons showing how an ability interacts with items — dispellable, duration-reduced, blocked, etc. Each icon displays a configured image, links to a configured URL, and has a hover tooltip.

Membership is decided by is_member in Module:AbilityTable. To change ability-icon matching, edit Module:AbilityTable/Lists (this will also update relevant ability tables).

Entry point

p.get_icons(ability_key, ability_num)

Returns the rail HTML for one ability, or an empty string when the ability matches no lists. ability_key is the ability's Key (from Data:AbilityCards.json); ability_num is its slot (1–4).

Configuration

CONFIG

Ordered list of the icons the rail can show; order here is the display order. Each entry:

Field Description
list List name in Module:AbilityTable/Lists whose membership triggers the icon.
file Image file to display, e.g. Reactive Barrier.png.
link URL opened when the icon is clicked. Use a full/absolute URL (e.g. https://deadlock.wiki/Reactive_Barrier): an absolute URL keeps the anchor title-less, so Page Previews ignores it. A bare page name would re-introduce the preview popup.
tip Hover tooltip text. May contain simple HTML (<br>, <b>).

To add an icon, add a CONFIG row: pick the triggering list, the display file, the click link, and the tip. The file and link are arbitrary — they need not correspond to a single item. To re-scope which abilities an icon covers, edit the list in Module:AbilityTable/Lists.

See also