Template:Sandbox/MoonOverMira/class attributes/doc: Difference between revisions
Jump to navigation
Jump to search
MoonOverMira (talk | contribs) No edit summary |
MoonOverMira (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Lua|Module:Skill}} | |||
==Overview== | |||
Creates a table of classes and their base attributes. This data comes from [[Module:Game]], though similar information can be found in [[Special:CargoTables/character_classes]]. | |||
== | ==Parameters== | ||
The only required parameter is cols. | |||
===Examples=== | {| class="wikitable" | ||
! Parameter | |||
! Value | |||
! Description | |||
|- | |||
| cols | |||
| str | |||
| A comma-separated list of the attributes to include as columns. Valid attributes are <code>[str, dex, int]</code>. | |||
|- | |||
| show_total | |||
| bool | |||
| Whether to include the total of the attributes as a column at the end. | |||
|- | |||
| sort_col | |||
| str | |||
| An attribute to sort the table by. Only one of the valid attributes should be given. | |||
|- | |||
| reverse_sort | |||
| bool | |||
| Whether to sort the attribute column given by <code>sort_col</code> from greatest to least instead of from least to greatest. | |||
|} | |||
==Examples== | |||
{| class="wikitable" | |||
! Description | |||
! Usage | |||
! Result | |||
|- | |||
|All attributes and a total | |||
|<pre> | |||
{{Class attributes | {{Class attributes | ||
|cols=str,dex,int | |cols=str,dex,int | ||
|show_total=true | |show_total=true | ||
}} | }} | ||
</pre> | |||
|{{Class attributes | |||
|cols=str,dex,int | |||
|show_total=true | |||
}} | |||
|- | |||
|A single attribute, sorted from greatest to least | |||
|<pre> | |||
{{Class attributes | {{Class attributes | ||
|cols=str | |cols=str | ||
Line 17: | Line 65: | ||
|reverse_sort=true | |reverse_sort=true | ||
}} | }} | ||
</pre> | |||
|{{Class attributes | |||
|cols=str | |||
|sort_col=str | |||
|reverse_sort=true | |||
}} | |||
|} | |||
{{Documentation categories| | {{Documentation categories| |
Revision as of 04:42, 4 March 2023
This subpage provides documentation for Template:Sandbox/MoonOverMira/class attributes.
Overview
Creates a table of classes and their base attributes. This data comes from Module:Game, though similar information can be found in Special:CargoTables/character_classes.
Parameters
The only required parameter is cols.
Parameter | Value | Description |
---|---|---|
cols | str | A comma-separated list of the attributes to include as columns. Valid attributes are [str, dex, int] .
|
show_total | bool | Whether to include the total of the attributes as a column at the end. |
sort_col | str | An attribute to sort the table by. Only one of the valid attributes should be given. |
reverse_sort | bool | Whether to sort the attribute column given by sort_col from greatest to least instead of from least to greatest.
|
Examples
Description | Usage | Result |
---|---|---|
All attributes and a total | {{Class attributes |cols=str,dex,int |show_total=true }} |
Template:Class attributes |
A single attribute, sorted from greatest to least | {{Class attributes |cols=str |sort_col=str |reverse_sort=true }} |
Template:Class attributes |