Module:AbilityHints/doc

From The Deadlock Wiki
Revision as of 19:52, 12 July 2026 by Vergir (talk | contribs) (add doc)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 links to its item 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.
item Item whose icon represents the interaction (rendered via Module:Icon).
tip Hover tooltip text. May contain simple HTML (<br>, <b>).

To add an icon, add a CONFIG row referencing an existing list. To re-scope which abilities it covers, edit the list in Module:AbilityTable/Lists.

See also