Difference between revisions of "Template:NGSItem"
MoonRunestar (talk | contribs) (fix templatedata) |
MoonRunestar (talk | contribs) (Edit templatedata) |
||
Line 25: | Line 25: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
− | + | "description": "Use this template on NGS pages to display an item name that does not line-break. Optionally, a UI icon can be included.", | |
− | + | "format": "inline", | |
− | + | "params": { | |
− | + | "Icon": { | |
− | + | "label": "UI Icon", | |
− | + | "description": "The small icon that is used in-game. This appears to the left of the item name.", | |
− | + | "type": "string", | |
− | + | "example": "NGS Sword", | |
− | + | "suggested": true | |
− | + | }, | |
− | + | "PageName": { | |
− | + | "label": "Page Name", | |
− | + | "description": "This is the page that clicking the name of the item will link to. If not specified, then the item link on the page will not have a link.", | |
− | + | "type": "string", | |
− | + | "example": "Swords_(NGS)", | |
− | + | "suggested": true | |
− | + | }, | |
− | + | "RealName": { | |
− | + | "label": "Real Name", | |
− | + | "description": "This is the name of the item visible in-game. This is required.", | |
− | + | "type": "string", | |
− | + | "example": "Prim Sword", | |
− | + | "required": true | |
− | + | }, | |
− | + | "Amount": { | |
− | + | "label": "Amount of Item", | |
− | + | "description": "This is the amount of the item. If you only get one of the item, then ignore this. Optional.", | |
− | + | "type": "number", | |
− | + | "example": "50" | |
− | + | } | |
− | + | }, | |
+ | "paramOrder": [ | ||
+ | "Icon", | ||
+ | "RealName", | ||
+ | "PageName", | ||
+ | "Amount" | ||
+ | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</noinclude> | </noinclude> |
Revision as of 13:15, 15 May 2022
{{{RealName}}}
This template is intended to be used on NGS pages to list the names of items, while showing a UI icon and preventing a line break mid-name.
Example
Writing the following:
{{NGSItem|Icon=NGS Sword|PageName=Swords_(NGS)|RealName=Prim Sword}}
results in this:
but if you don't include a PageName, it won't be linked:
Prim Sword.
You can also specify the amount of the item, which is great for items like Materials that you get multiple of for example, like N-Grinders.
{{NGSItem|Icon=NGS Tool|RealName=N-Grinder|Amount=50}}
Results in this:
N-Grinder ×50.
Editors can experiment in this template's sandbox (create) and testcases (create) pages. Subpages of this template. |
Use this template on NGS pages to display an item name that does not line-break. Optionally, a UI icon can be included.
Parameter | Description | Type | Status | |
---|---|---|---|---|
UI Icon | Icon | The small icon that is used in-game. This appears to the left of the item name.
| String | suggested |
Real Name | RealName | This is the name of the item visible in-game. This is required.
| String | required |
Page Name | PageName | This is the page that clicking the name of the item will link to. If not specified, then the item link on the page will not have a link.
| String | suggested |
Amount of Item | Amount | This is the amount of the item. If you only get one of the item, then ignore this. Optional.
| Number | optional |