Module:AbilityHints/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Browse history interactively
Newer edit →

Vergir (talk | contribs)

2 user groups
1,624 edits
undo
VisualWikitext
Vergir (talk | contribs)
Contributors, Interface administrators
1,624 edits
add doc
 
Vergir (talk | contribs)
Contributors, Interface administrators
1,624 edits
Docs: update CONFIG contract — item replaced by file + link; note the absolute-URL requirement for suppressing Page Previews (with help from vergir-bot LLM)
Line 1: Line 1:
== Overview ==
== 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.
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 <code>is_member</code> in [[Module:AbilityTable]].  To change ability-icon matching, edit [[Module:AbilityTable/Lists]] (this will also update relevant ability tables).
Membership is decided by <code>is_member</code> in [[Module:AbilityTable]].  To change ability-icon matching, edit [[Module:AbilityTable/Lists]] (this will also update relevant ability tables).
Line 20: Line 20:
| <code>list</code> || List name in [[Module:AbilityTable/Lists]] whose membership triggers the icon.
| <code>list</code> || List name in [[Module:AbilityTable/Lists]] whose membership triggers the icon.
|-
|-
| <code>item</code> || Item whose icon represents the interaction (rendered via [[Module:Icon]]).
| <code>file</code> || Image file to display, e.g. <code>Reactive Barrier.png</code>.
|-
| <code>link</code> || URL opened when the icon is clicked. Use a full/absolute URL (e.g. <code>https://deadlock.wiki/Reactive_Barrier</code>): an absolute URL keeps the anchor title-less, so [[mw:Extension:Popups|Page Previews]] ignores it. A bare page name would re-introduce the preview popup.
|-
|-
| <code>tip</code> || Hover tooltip text. May contain simple HTML (<code><nowiki><br></nowiki></code>, <code><nowiki><b></nowiki></code>).
| <code>tip</code> || Hover tooltip text. May contain simple HTML (<code><nowiki><br></nowiki></code>, <code><nowiki><b></nowiki></code>).
|}
|}


To add an icon, add a <code>CONFIG</code> row referencing an existing list. To re-scope which abilities it covers, edit the list in [[Module:AbilityTable/Lists]].
To add an icon, add a <code>CONFIG</code> row: pick the triggering <code>list</code>, the display <code>file</code>, the click <code>link</code>, and the <code>tip</code>. The <code>file</code> and <code>link</code> 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 ==
== See also ==

Revision as of 23:14, 13 July 2026

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

Retrieved from "https://deadlock.wiki/Module:AbilityHints/doc?oldid=92425"