Template:Performance/doc: Difference between revisions

From VRChat Wiki
(Created page with "== Documentation == Allows for the usage of performance icons. === Example Usage === <nowiki>{{performance|excellent|64px}}</nowiki> will make:<br> {{performance|excellent|64px}} === Template parameters === {| class="wikitable" |+ Caption text |- ! Name !! Variable !! Description |- | Rank || <code>1</code>|| excellent|good|medium|poor|verypoor (defaults to medium) |- | Size || <code>2</code> || (Optional) size of the image file, default is 64px |}")
 
(Updates to add TemplateData)
 
(4 intermediate revisions by 2 users not shown)
Line 8: Line 8:


=== Template parameters ===
=== Template parameters ===
{| class="wikitable"
<templatedata>
|+ Caption text
{
|-
"params": {
! Name !! Variable !! Description
"1": {
|-
"label": "Performance Ranking",
| Rank || <code>1</code>|| excellent|good|medium|poor|verypoor (defaults to medium)
"type": "string",
|-
"suggestedvalues": [
| Size || <code>2</code> || (Optional) size of the image file, default is 64px
"excellent",
|}
"good",
"medium",
"poor",
"verypoor"
],
"default": "medium",
"suggested": true,
"description": "What performance rank icon you want displayed",
"example": "excellent"
},
"2": {
"label": "Icon size (in pixels)",
"description": "Changes the size of the icon in pixels.",
"type": "number",
"suggestedvalues": [
"16",
"32",
"64",
"128"
],
"default": "32",
"suggested": true
}
},
"paramOrder": [
"1",
"2"
],
"format": "inline",
"description": "Performance ranking icon"
}
</templatedata>
<noinclude>[[Category:Template Documentation]]</noinclude>

Latest revision as of 23:33, 17 October 2024

Documentation

Allows for the usage of performance icons.

Example Usage

{{performance|excellent|64px}}

will make:

Template parameters

Performance ranking icon

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Performance Ranking1

What performance rank icon you want displayed

Suggested values
excellent good medium poor verypoor
Default
medium
Example
excellent
Stringsuggested
Icon size (in pixels)2

Changes the size of the icon in pixels.

Suggested values
16 32 64 128
Default
32
Numbersuggested