Main Page

Difference between revisions of "Template:NGSItem"

From Arks-Visiphone
Jump to navigation Jump to search
(fix templatedata)
(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.",
+
"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",
+
"format": "inline",
    "params": {
+
"params": {
        "Icon": {
+
"Icon": {
            "label": "UI Icon",
+
"label": "UI Icon",
            "description": "The small icon that is used in-game. This appears to the left of the item name.",
+
"description": "The small icon that is used in-game. This appears to the left of the item name.",
            "type": "string",
+
"type": "string",
            "example": "NGS Sword",
+
"example": "NGS Sword",
            "suggested": true
+
"suggested": true
        },
+
},
        "PageName": {
+
"PageName": {
            "label": "Page Name",
+
"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.",
+
"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",
+
"type": "string",
            "example": "Swords_(NGS)",
+
"example": "Swords_(NGS)",
            "suggested": true
+
"suggested": true
        },
+
},
        "RealName": {
+
"RealName": {
            "label": "Real Name",
+
"label": "Real Name",
            "description": "This is the name of the item visible in-game. This is required.",
+
"description": "This is the name of the item visible in-game. This is required.",
            "type": "string",
+
"type": "string",
            "example": "Prinm Sword",
+
"example": "Prim Sword",
            "required": true
+
"required": true
        },
+
},
        "Amount": {
+
"Amount": {
            "label": "Amount of Item",
+
"label": "Amount of Item",
            "description": "This is the amount of the item. If you only get one of the item, then ignore this. Optional.",
+
"description": "This is the amount of the item. If you only get one of the item, then ignore this. Optional.",
            "type": "number",
+
"type": "number",
            "example": "50"
+
"example": "50"
        }
+
}
    }
+
},
 +
"paramOrder": [
 +
"Icon",
 +
"RealName",
 +
"PageName",
 +
"Amount"
 +
]
 
}
 
}
 
</templatedata>
 
</templatedata>
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 13:15, 15 May 2022

{{{RealName}}}

Template documentation

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:

Sword (NGS) Prim Sword.

but if you don't include a PageName, it won't be linked:

Sword (NGS) 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:

Tool (NGS) N-Grinder ×50.

Use this template on NGS pages to display an item name that does not line-break. Optionally, a UI icon can be included.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
UI IconIcon

The small icon that is used in-game. This appears to the left of the item name.

Example
NGS Sword
Stringsuggested
Real NameRealName

This is the name of the item visible in-game. This is required.

Example
Prim Sword
Stringrequired
Page NamePageName

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.

Example
Swords_(NGS)
Stringsuggested
Amount of ItemAmount

This is the amount of the item. If you only get one of the item, then ignore this. Optional.

Example
50
Numberoptional