The Deadlock Wiki

Template:AbilityTable/doc: Difference between revisions

Browse history interactively

LVL (talk | contribs)

3 user groups
4,834 edits
undo
VisualWikitext
Vergir (talk | contribs)
Contributors, Interface administrators
1,631 edits
Create /doc subpage with usage, parameters, see also, and live example (with help from vergir-bot LLM)
 
LVL (talk | contribs)
Contributors, Interface administrators, Moderators
4,834 edits
Updated doc to add collapsed info and also added TemplateData
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
Renders a sortable table of all abilities matching a named list, or a compact inline list. 
Renders a sortable table of all abilities that have the named stat.
The table can optionally be made collapsible.


== Usage ==
== Usage ==


<pre>{{AbilityTable|charges}}</pre>
<pre>{{AbilityTable|charges}}</pre>
Compact mode (renders as an inline list instead of a table):
<pre>{{AbilityTable|charges|compact=1}}</pre>


With a hidden column:
With a hidden column:
Line 11: Line 14:
Multiple columns can be hidden using a comma-separated list:
Multiple columns can be hidden using a comma-separated list:
<pre>{{AbilityTable|charges|hide=Time Between Charges, Notes}}</pre>
<pre>{{AbilityTable|charges|hide=Time Between Charges, Notes}}</pre>
Collapsible table, initially hidden:
<pre>{{AbilityTable|charges|collapsed=yes}}</pre>
Collapsible table, initially shown (toggleable via header):
<pre>{{AbilityTable|charges|collapsed=no}}</pre>


== Parameters ==
== Parameters ==


; 1 : The stat name. Must match a key in [[Module:AbilityTable|the stat_to_props table]].
; 1 : The list name. Must match a key in [[Module:AbilityTable/Lists]].
; hide : Optional. A comma-separated list of column names to exclude. Hero and Ability columns cannot be hidden.
; compact : Optional. When set to any non‑empty value (e.g. <code>compact=1</code>), renders a compact inline list instead of a full table. Abilities are grouped by hero with notes shown in parentheses. Collapsing does not apply in this mode.
; hide : Optional. A comma‑separated list of column names to exclude from the table. Hero and Ability columns cannot be hidden. Has no effect in compact mode.
; collapsed : Optional. Enables collapsible behaviour for the table. 
:* <code>collapsed=yes</code> (or <code>true</code>, <code>1</code>) – table starts hidden; click the header to expand. 
:* <code>collapsed=no</code> (or any other non‑empty value) – table shows a collapse toggle but starts fully expanded. 
: Omit the parameter entirely to render a static, non‑collapsible table (default behaviour).
: Has no effect when <code>compact</code> is used.


== Example ==
== Examples ==


The following renders a table of all abilities with a '''melee''' stat:
The following renders a table of all abilities in the '''melee''' list:


<pre>{{AbilityTable|melee}}</pre>
<pre>{{AbilityTable|melee}}</pre>


{{AbilityTable|melee}}
{{AbilityTable|melee}}
The same list in compact mode:
<pre>{{AbilityTable|melee|compact=1}}</pre>
{{AbilityTable|melee|compact=1}}
A collapsible table that starts hidden (click the header to reveal):
<pre>{{AbilityTable|melee|collapsed=yes}}</pre>
{{AbilityTable|melee|collapsed=yes}}
A collapsible table that starts open with a visible collapse button:
<pre>{{AbilityTable|melee|collapsed=no}}</pre>
{{AbilityTable|melee|collapsed=no}}


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


* [[Template:ItemPropTable]] — equivalent template for items
* [[Module:AbilityTable]] — backing Lua module
* [[Module:AbilityTable]] — backing Lua module
* [[Module:AbilityTable/Lists]] — defines which properties each list matches on
* [[Module:AbilityTable/Notes]] — editor‑authored notes for abilities
* [[Template:AbilityTable/styles.css]] — stylesheet for this template
* [[Template:AbilityTable/styles.css]] — stylesheet for this template
* [[Module:GameData]] — shared data-loading framework
 
<templatedata>
{
    "description": "Renders a sortable table of abilities matching a named list, or a compact inline list. Optionally collapsible.",
    "params": {
        "1": {
            "label": "List name",
            "description": "Name of the ability list to display (must match a key in Module:AbilityTable/Lists).",
            "type": "string",
            "required": true,
            "example": "charges"
        },
        "compact": {
            "label": "Compact mode",
            "description": "If set to any non‑empty value (e.g. 1), render a compact inline list instead of a table.",
            "type": "string",
            "required": false,
            "example": "1"
        },
        "hide": {
            "label": "Hide columns",
            "description": "Comma‑separated column names to exclude from the table (e.g. \"Time Between Charges, Notes\"). Hero and Ability cannot be hidden. Ignored in compact mode.",
            "type": "string",
            "required": false
        },
        "collapsed": {
            "label": "Collapse table",
            "description": "Makes the table collapsible. Use 'yes' to start hidden, 'no' to start expanded with a toggle. Omit for a static table.",
            "type": "string",
            "suggestedvalues": ["yes", "no"],
            "required": false
        }
    },
    "format": "inline"
}
</templatedata>


<includeonly>[[Category:Ability templates]]</includeonly>
<includeonly>[[Category:Ability templates]]</includeonly>
Retrieved from "https://deadlock.wiki/Template:AbilityTable/doc"