Template:Item/doc
This subpage provides documentation for Template:Item.
This template is under development should only be used for skill gems at this point. Please refer to Module:Item for the time being
Semantic Mediawiki version of the item template.
Overview
This template should be used for all items on the wiki and it will take of setting semantic properties, creating an infobox as well as setting categories.
It is meant for usage on permanent pages, do not use it on user pages.
Currently the template is safe to use for the following item classes:
- Active Skill Gems
- Support Skill Gems
Parameters
Base
| Parameter | Value | Required | Property | Description |
|---|---|---|---|---|
| class | str | ✓
|
Has item class | A valid item class |
| rarity | str | ✓
|
Has rarity | rarity of the item, one of:
|
| name | str | ✓
|
Has name | Name of the item |
| name_list | str | ✗
|
Has names | List of aliases for this item; this should be used carefully and only for legacy versions of the item (i.e. Caustic Arrow vs Poison Arrow).
The current item name is always added to this list automatically |
| size_x | int | ✗
|
Has inventory width | x-size in inventory units, i.e. the width |
| size_y | int | ✗
|
Has inventory height | y-size in inventory units, i.e. the height |
| drop_enabled | bool | ✗
|
Is drop enabled | Whether the item is drop enabled; this defaults to true.
Specify false for legacy items that do not drop anymore. |
| drop_level | int | ✗
|
Has drop level | At which level the item starts dropping at (may differ from required_level) |
| required_level | int | ✗
|
Has level requirement | Which level is required to use the item (may differ from drop_level) |
| required_dexterity | int | ✗
|
Has base dexterity requirement | The dexterity requirement of the item if any |
| required_intelligence | int | ✗
|
Has base intelligence requirement | The intelligence requirement of the item if any |
| required_strength | int | ✗
|
Has base strength requirement | The strength requirement of the item if any |
| flavour_text | str | ✗
|
Has flavour text | Flavour text if any (i.e. for unique items, vaal fragments, divination cards, etc) |
| help_text | str | ✗
|
Has help text | Help text if any
For some item classes such as gems a default string is inserted if this value is missing. |
| tags | list[str] | ✗
|
Has tags | List of internal tags |
| metadata_id | str | ✗
|
Has metadata id | Internal metadata id of the item |
Class groups
Parameters that apply to various groups of item classes.
Flasks
Eligible item classes:
Life Flasks, Mana Flasks, Hybrid Flasks, Utility Flasks, Critical Utility Flasks
| Parameter | Value | Required | Description |
|---|---|---|---|
| flask_duration | int | ✗
|
How long the flask lasts |
| charges_max | int | ✗
|
Maximum number of charges the flask holds |
| charges_per_use | int | ✗
|
Charges consumed when the flask is used |
Weapons
Eligible item classes:
'Claws', 'Daggers', 'Wands', 'One Hand Swords', 'Thrusting One Hand Swords', 'One Hand Axes', 'One Hand Maces', 'Bows', 'Staves', 'Two Hand Swords', 'Two Hand Axes', 'Two Hand Maces', 'Sceptres'
| Parameter | Value | Required | Description |
|---|---|---|---|
| critical_strike_chance | int | ✗
|
Base critical strike chance of the weapon |
| attack_speed | int | ✗
|
Base attack speed of the weapon |
| damage_min | int | ✗
|
Minimum base physical damage of the weapon |
| damage_max | int | ✗
|
Maximum base physical damage of the weapon |
| range | int | ✗
|
Range in game units of the weapon |
Armour
Eligible item classes:
'Gloves', 'Boots', 'Body Armours', 'Helmets', 'Shields'
| Parameter | Value | Required | Description |
|---|---|---|---|
| armour | int | ✗
|
Armour of the armour |
| energy_shield | int | ✗
|
Energy Shield of the armour |
| evasion | int | ✗
|
Evasion Rating of the armour |
Gems
Eligible item classes:
'Active Skill Gems', 'Support Skill Gems'
They also inherit all parameters from the Skill template.
| Parameter | Value | Required | Property | Description |
|---|---|---|---|---|
| gem_tags | list[str] | ✗
|
Has gem tags | List of gem tags.
The gem tags will be matched against a list of verified tags. Any tags that are not present on the gem will be added to Property:Has gem tags difference. |
| dexterity_percent | int | ✗
|
Has dexterity percentage | Dexterity portion of the gem stat distribution.
For pure gems, this is usually 100 for the primary attribute and 0 for the other attribute. For hybrid gems, this is usually 60 for the primary attribute, 40 for the secondary attribute, and 0 for the remaining attribute. |
| strength_percent | int | ✗
|
Has strength percentage | Strength portion of the gem stat distribution. |
| intelligence_percent | int | ✗
|
Has intelligence percentage | Intelligence portion of the gem stat distribution. |
With all arguments supplied, these properties will also be set:
| Property | Description |
|---|---|
| Has primary attribute | Will be set to the primary attribute (highest percentage) |
Stackables
Eligible item classes:
'Currency', 'Stackable Currency', 'Hideout Doodads', 'Microtransactions', 'Divination Card'
| Parameter | Value | Required | Description |
|---|---|---|---|
| stack_size | int | ✗
|
Maximum stack size of the item |
Item class
Parameters specific to item classes
| Class | Parameter | Value | Required | Description |
|---|---|---|---|---|
| Life Flasks
Hybrid Flasks |
flask_life | int | ✗
|
How much Life the flask recovers |
| Mana Flasks
Hybrid Flasks |
flask_mana | int | ✗
|
How much Mana the flask recovers |
| Shields | block | int | ✗
|
The base chance to block on shields |
| Amulets | is_talisman | bool | ✗
|
Whether the amulet is a talisman (defaults to no) |
See also