Template:StatBox/doc: Difference between revisions
m documentation updated; example is now a statbox not statboxes; box_name example from Weapon to CitadelCategoryWeapon |
m box_name refer to Data:Lang_en |
||
Line 24: | Line 24: | ||
===Parameters=== | ===Parameters=== | ||
box_name: See [[Data:Lang_en.json]] for all english localization keys; ensure the box_name is a key that can be localized<br> | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
"box_name": { | "box_name": { | ||
"description": "Unlocalized name of the StatBox which will be localized to both the label and the image.", | "description": "Unlocalized name of the StatBox which will be localized to both the label and the image. ", | ||
"example": "CitadelCategoryWeapon", | "example": "CitadelCategoryWeapon", | ||
"type": "string" | "type": "string" |
Latest revision as of 03:46, 19 September 2024
Overview[edit source]
A stat box is created similar to the display seen in the shop when hovering over each stat category (Weapon, Vitality, Spirit).
When hovered, a box appears to the right that contains a table with specified cell values, preferably containing an icon, stat prefix, value, postfix, and name.
Examples[edit source]
{{StatBox |box_name = CitadelCategoryWeapon |box_rgb = 213, 144, 63 |num_cols = 2 |cell_values = 800 MaxHealth,2 BaseHealthRegen,10 DPS }}
Outputs
800 MaxHealth | 2 BaseHealthRegen |
10 DPS |
See Template:StatBoxes which creates all 3 for a given hero dynamically using their stats and scalings
Parameters[edit source]
box_name: See Data:Lang_en.json for all english localization keys; ensure the box_name is a key that can be localized
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
box_name | box_name | Unlocalized name of the StatBox which will be localized to both the label and the image.
| String | optional |
box_rgb | box_rgb | RGB values for the box, comma separated. RGBA is not supported, as the alpha channel is modified by the template.
| String | optional |
num_cols | num_cols | Number of columns in the table.
| Number | optional |
cell_values | cell_values | Number of cell values, comma separated (no space after comma). Rows are added automatically based on the number of cell values and columns.
| String | optional |