Difference between revisions of "Item info/Documentation"
Stratonian (talk | contribs) m |
Stratonian (talk | contribs) m (→Parameters) |
||
| Line 8: | Line 8: | ||
{{parameter|random|Displays a note stating that the Item's appearance may change randomly.||Set to any value to enable.}} | {{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|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|tooltip|The tooltip text that appears upon hovering over the item.|}} | ||
{{parameter|description|A description of the item.|}} | {{parameter|description|A description of the item.|}} | ||
Revision as of 22:34, 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
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.
- random: Displays a note stating that the Item's appearance may change randomly.
- 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. '
[value1] [stat1], [value2] [stat2], 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.
- level: The hero 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.
- •Quest Items.
- •Raw Materials.
- •Runes.
- •Weapons.
- quests: The semicolon-separated names of quests the item is a part of.
- Optional.
Errors
No description was provided. Add a description parameter.