Difference between revisions of "Item info/Documentation"
Stratonian (talk | contribs) m (→Usage) |
Stratonian (talk | contribs) m (→Parameters: satiety effect) |
||
| 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 | + | {{parameter|stats|A comma-separated list of the item's stat values and names.||e.g. '<code>[value1] [stat1], [value2] [stat2], etc.</code>'}} |
{{parameter|duration|The duration, in seconds, of the item's effect.}} | {{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|level|The player level required for item use.|}} | ||
{{parameter|level|The hero required for item use.|}} | {{parameter|level|The hero required for item use.|}} | ||
Revision as of 13:41, 3 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.
- 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.
- 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.