Difference between revisions of "Item info/Documentation"

Latest revision as of 12:34, 12 July 2024

Description[edit]

Displays an information page about an item.

Usage[edit]

{{Item info|<icon=icon>|<name=name>|<tooltip=tooltip>|<description=description>|<tier=I>|<stats=28 Weapon Damage>|<duration=120>|<level=1>|<mastery=Destroyer>|<value=1>|<category=category>|<quests=Quest 1; Quest 2>}}

Parameters[edit]

icon: An image of the item.: Optional. Defaults to '{{PAGENAME}}.png'.; Notes: Only use if the icon name differs from the name of the page.

change: Displays a note stating that the Item's appearance may change.: Optional.; Notes: Set to any value to enable.

name: 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.

binding: The binding of the item.: Optional.; Notes: Only use if the item is bound. Choose between 'equip', 'pickup', or a custom binding.

tooltip: The tooltip text that appears upon hovering over the item.: Optional.

description: A description of the item.: Optional.

quality: The item's quality.: Optional.; Notes: Input ranges of qualities with '[quality1]-[quality2]'.

tier: The item's tier.: Optional.; Notes: In roman numerals.

stats: A comma-separated list of the item's stat values and names.: Optional.; Notes: e.g. '[stat1]: [value1], [stat2]: [value2], etc.'

duration: The duration, in seconds, of the item's effect.: Required.

satiety effect: A comma-separated list of the item's satiety effect stat values and names.: Optional.; Notes: e.g. '[value1] [stat1], [value2] [stat2], etc.'

satiety duration: The duration, in seconds, of the item's satiety effect.: Required.

level: The player level required for item use.: Optional.

hero: The hero required for item use.: Optional.; Notes: If the 'mastery' parameter is specified, do not use this parameter.

mastery: The mastery required for item use.: Optional.

value: The item's selling price when sold to a vendor.: Optional.

category: The item's category.: Optional.

Possible categories:

•Armor

•Artifacts

•Chips

•Consumables

•Crafting Materials

•Items

•Quest Items

•Raw Materials

•Runes

•Weapons

quests: The semicolon-separated names of quests the item is a part of.: Optional.

Errors[edit]

No description was provided. Add a description parameter.

@@ Line 2: / Line 2: @@
 Displays an information page about an item.
 ==Usage==
-{{T|Item info|icon{{=}}icon|name{{=}}name|tooltip{{=}}tooltip|description{{=}}description|tier{{=}}I|stats{{=}}28 Weapon Damage|level{{=}}1|hero{{=}}Bomber|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|duration{{=}}120|level{{=}}1|mastery{{=}}Destroyer|value{{=}}1|category{{=}}category|quests{{=}}Quest 1; Quest 2}}
 ==Parameters==
 {{parameter|icon|An image of the item.|<nowiki>{{PAGENAME}}.png</nowiki>|Only use if the icon name differs from the name of the page.}}
+{{parameter|change|Displays a note stating that the Item's appearance may change.||Set to any value to enable.}}
 {{parameter|name|The name of the item.|<nowiki>{{PAGENAME}}</nowiki>|Only use if the template is on a different page to the item's main article.}}
+{{parameter|binding|The binding of the item.||Only use if the item is bound. Choose between '<code>equip</code>', '<code>pickup</code>', or a custom binding.}}
 {{parameter|tooltip|The tooltip text that appears upon hovering over the item.|}}
 {{parameter|description|A description of the item.|}}
 {{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|stats|A comma-separated list of the item's stat value and name.||Stat duration may also be input. e.g. '<code>[value1] [stat1], [value2] [stat2], ..., [duration] seconds</code>'}}
+{{parameter|stats|A comma-separated list of the item's stat values and names.||e.g. '<code>[stat1]: [value1], [stat2]: [value2], etc.</code>'}}
+{{parameter|duration|The duration, in seconds, of the item's effect.}}
+{{parameter|satiety effect|A comma-separated list of the item's satiety effect stat values and names.||e.g. '<code>[value1] [stat1], [value2] [stat2], etc.</code>'}}
+{{parameter|satiety duration|The duration, in seconds, of the item's satiety effect.}}
 {{parameter|level|The player level required for item use.|}}
+{{parameter|hero|The hero required for item use.||If the '<code>mastery</code>' parameter is specified, do not use this parameter.}}
+{{parameter|mastery|The mastery required for item use.|}}
 {{parameter|value|The item's selling price when sold to a vendor.|}}
 {{parameter|category|The item's category.|}}
 Possible categories:<br>
-:{{bullet}}Armor.
+:{{bullet}}Armor
-:{{bullet}}Artifacts.
+:{{bullet}}Artifacts
-:{{bullet}}Chips.
+:{{bullet}}Chips
-:{{bullet}}Consumables.
+:{{bullet}}Consumables
-:{{bullet}}Crafting Materials.
+:{{bullet}}Crafting Materials
-:{{bullet}}Quest Items.
+:{{bullet}}Items
-:{{bullet}}Raw Materials.
+:{{bullet}}Quest Items
-:{{bullet}}Runes.
+:{{bullet}}Raw Materials
-:{{bullet}}Weapons.
+:{{bullet}}Runes
+:{{bullet}}Weapons
 {{parameter|quests|The semicolon-separated names of quests the item is a part of.|}}