Difference between revisions of "Item info/Documentation"

m (→‎Parameters: satiety effect)
m
Line 6: Line 6:
 
==Parameters==
 
==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|icon|An image of the item.|<nowiki>{{PAGENAME}}.png</nowiki>|Only use if the icon name differs from the name of the page.}}
 +
{{parameter|random|Displays a note stating that the Item's appearance may change randomly.||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|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|tooltip|The tooltip text that appears upon hovering over the item.|}}
 
{{parameter|tooltip|The tooltip text that appears upon hovering over the item.|}}

Revision as of 22:22, 9 February 2024

Description

Displays an information page about an item.

Usage

{{Item info|<icon=icon>|<name=name>|<tooltip=tooltip>|<description=description>|<tier=I>|<stats=28 Weapon Damage>|<duration=120>|<level=1>|<hero=Bomber>|<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.pngrandom: Displays a note stating that the Item's appearance may change randomly.
Optional.
Notes: Set to any value to enable.
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 values and names.
Optional.
Notes: e.g. '[value1] [stat1], [value2] [stat2], etc.'
Arrow.pngduration: The duration, in seconds, of the item's effect.
Required.
Arrow.pngsatiety effect: A comma-separated list of the item's satiety effect stat values and names.
Optional.
Notes: e.g. '[value1] [stat1], [value2] [stat2], etc.'
Arrow.pngsatiety duration: The duration, in seconds, of the item's satiety effect.
Required.
Arrow.pnglevel: The player level required for item use.
Optional.
Arrow.pnglevel: The hero 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.