Difference between revisions of "Item info/Documentation"

m (→‎Parameters: quality ranges)
Line 2: Line 2:
 
Displays an information page about an item.
 
Displays an information page about an item.
 
==Usage==
 
==Usage==
{{T|Item info|icon{{=}}icon|name{{=}}name|tooltip{{=}}tooltip|description{{=}}description|tier{{=}}I|level{{=}}1|value{{=}}1|category{{=}}category|quests{{=}}Quest 1, Quest 2}}
+
{{T|Item info|icon{{=}}icon|name{{=}}name|tooltip{{=}}tooltip|description{{=}}description|tier{{=}}I|stats={{=}}28 Weapon Damage|level{{=}}1|value{{=}}1|category{{=}}category|quests{{=}}Quest 1, Quest 2}}
  
 
==Parameters==
 
==Parameters==
Line 11: Line 11:
 
{{parameter|quality|The item's quality.||Input ranges of qualities with '<code>[quality1]-[quality2]</code>'.}}
 
{{parameter|quality|The item's quality.||Input ranges of qualities with '<code>[quality1]-[quality2]</code>'.}}
 
{{parameter|tier|The item's tier.||In [https://en.wikipedia.org/wiki/Roman_numerals roman numerals].}}
 
{{parameter|tier|The item's tier.||In [https://en.wikipedia.org/wiki/Roman_numerals roman numerals].}}
 +
{{parameter|stats|A comma-separated list of the item's stat value and name.||e.g. '<code>[value1] [stat1], [value2] [stat2], etc</code>'}}
 
{{parameter|level|The player level required for item use.|}}
 
{{parameter|level|The player level required for item use.|}}
 
{{parameter|value|The item's selling price when sold to a vendor.|}}
 
{{parameter|value|The item's selling price when sold to a vendor.|}}

Revision as of 22:33, 30 September 2023

Description

Displays an information page about an item.

Usage

{{Item info|<icon=icon>|<name=name>|<tooltip=tooltip>|<description=description>|<tier=I>|<level=1>|<value=1>|<category=category>|<quests=Quest 1, Quest 2>}}

Parameters

Arrow.pngicon: An image of the item.
Optional. Defaults to '{{PAGENAME}}.png'.
Notes: Only use if the icon name differs from the name of the page.
Arrow.pngname: The name of the item.
Optional. Defaults to '{{PAGENAME}}'.
Notes: Only use if the template is on a different page to the item's main article.
Arrow.pngtooltip: The tooltip text that appears upon hovering over the item.
Optional.
Arrow.pngdescription: A description of the item.
Optional.
Arrow.pngquality: The item's quality.
Optional.
Notes: Input ranges of qualities with '[quality1]-[quality2]'.
Arrow.pngtier: The item's tier.
Optional.
Notes: In roman numerals.
Arrow.pngstats: A comma-separated list of the item's stat value and name.
Optional.
Notes: e.g. '[value1] [stat1], [value2] [stat2], etc'
Arrow.pnglevel: The player level required for item use.
Optional.
Arrow.pngvalue: The item's selling price when sold to a vendor.
Optional.
Arrow.pngcategory: The item's category.
Optional.

Possible categories:

Armor.
Artifacts.
Chips.
Consumables.
Crafting Materials.
Quest Items.
Raw Materials.
Runes.
Weapons.
Arrow.pngquests: The semicolon-separated names of quests the item is a part of.
Optional.

Errors

No description was provided. Add a description parameter.