Module:AbilityTable/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Vergir (talk | contribs)
Docs: document is_member (shared membership predicate) and its use by Module:AbilityHints (with help from vergir-bot LLM)
Vergir (talk | contribs)
update with new api
 
Line 1: Line 1:
This module exposes two functions. <code>render</code> generates a table of hero abilities matching a named list, and is invoked via [[Template:AbilityTable|<code><nowiki>{{AbilityTable}}</nowiki></code>]]. <code>is_member(list, record, ability_num)</code> is the shared membership predicate that decides whether a single ability belongs to a list (applying the same properties and exclusions); it is used both internally by <code>render</code> and externally by [[Module:AbilityHints]], so the ability-hint icons always stay in sync with these tables.
This module exposes two functions.


The module reads ability lists and exclusions from submodules, matches them against [[Data:AbilityData.json]], and renders the results as either a sortable wikitable or a compact list.
* <code>render</code> generates a table of hero abilities matching a named list, and is invoked via [[Template:AbilityTable|<code><nowiki>{{AbilityTable}}</nowiki></code>]].
* <code>is_member(list, ability_key, ability_num)</code> is a shared function that decides whether a single ability belongs to a list (applying the same properties and exclusions); it is used both internally by <code>render</code> and externally by [[Module:AbilityHints]], so the ability-hint icons always stay in sync with these tables.


== See also ==
== See also ==

Latest revision as of 14:57, 17 July 2026

This module exposes two functions.

  • render generates a table of hero abilities matching a named list, and is invoked via {{AbilityTable}}.
  • is_member(list, ability_key, ability_num) is a shared function that decides whether a single ability belongs to a list (applying the same properties and exclusions); it is used both internally by render and externally by Module:AbilityHints, so the ability-hint icons always stay in sync with these tables.

See also

[edit source]