View source for Template:Item/doc

{{documentation subpage}}

{{lua|Module:Item2}}

{{ambox|type=speedy|text=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 types:
* jewellery
* armours
* weapons
* skill gems

==Base parameters==

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| class
| str
| {{yes}}
| {{yes}}
| [[Property:Has item class|Has item class]]
| A valid [[item class]]
|-
| rarity
| str
| {{yes}}
| {{yes}}
| [[Property:Has rarity|Has rarity]]
| [[rarity]] of the item, one of:
* Normal
* Magic
* Rare
* Unique
|-
| name
| str
| {{yes}}
| {{yes}}
| [[Property:Has name|Has name]]
| Name of the item
|-
| name_list
| str
| {{no}}
| {{no}}
| [[Property:Has names|Has names]]
[[Property:Has lowercase names|Has lowercase 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
| {{no}}
| {{yes}}
| [[Property:Has inventory width|Has inventory width]]
| x-size in inventory units, i.e. the width
|-
| size_y
| int
| {{no}}
| {{yes}}
| [[Property:Has inventory height|Has inventory height]]
| y-size in inventory units, i.e. the height
|-
| drop_enabled
| bool
| {{no}}
| <center>{{abbr|*|some edge cases are automatically added, however it is advisable to set it manually}}</center>
| [[Property:Is drop enabled|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
| {{no}}
| {{yes}}
| [[Property:Has drop level|Has drop level]]
| At which level the item starts dropping at (may differ from required_level)
|-
| drop_level_maximum
| int
| {{no}}
| {{yes}}
| [[Property:Has maximum drop level|Has maximum drop level]]
| Up to which level the item drops
|-
| required_level
| int
| {{no}}
| {{yes}}
| [[Property:Has level requirement|Has level requirement]]
| Which level is required to use the item (may differ from drop_level)
|-
| required_dexterity
| int
| {{no}}
| {{yes}}
| [[Property:Has base dexterity requirement|Has base dexterity requirement]]
| The [[dexterity]] requirement of the item if any
|-
| required_intelligence
| int
| {{no}}
| {{yes}}
| [[Property:Has base intelligence requirement|Has base intelligence requirement]]
| The [[intelligence]] requirement of the item if any
|-
| required_strength
| int
| {{no}}
| {{yes}}
| [[Property:Has base strength requirement|Has base strength requirement]]
| The [[strength]] requirement of the item if any
|-
| flavour_text
| str
| {{no}}
| {{yes}}
| [[Property:Has flavour text|Has flavour text]]
| Flavour text if any (i.e. for unique items, vaal fragments, divination cards, etc)
|-
| help_text
| str
| {{no}}
| {{yes}}
| [[Property:Has help text|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]
| {{no}}
| {{yes}}
| [[Property:Has tags|Has tags]]
| List of internal tags
|-
| metadata_id
| str
| {{no}}
| {{yes}}
| [[Property:Has metadata id|Has metadata id]]
| Internal metadata id of the item
|-
| release_version
| str
| {{no}}
| {{no}}
| [[Property:Has release version|Has release version]]
[[Property:Has release date|Has release date]]
| The version number of when this item was released. The version must a be a valid version number and there must be a version page or the template will return an error.
The release date property is automatically added when the version is specified - it holds the date of when the version was released. 
|-
| inventory_icon
| str
| {{no}}
| {{no}}
| [[Property:Has inventory icon]]
| '''This parameter only needs to be specified if the item name does not match the wiki page name.'''
When specified, the specified text will be used instead of the item name in front of the "inventory icon.png" suffix.

For example:
  name = Baller
  inventory_icon = Test item (cold and fire)
  -> File:Test item (cold and fire) inventory icon.png
|-
| alternate_art_inventory_icons
| list[str]
| {{no}}
| {{no}}
| [[Property:Has alternate inventory icons]]
| This parameter takes a comma-separated list of alternate art icon names, which each be inserted into the name of the item (or the provided override) and the "inventory icon.png" suffix.
The order of the item matters; if using the item link template, the items will can accessed in that order.

The list items should be named after where they were retrieved from (for example, which race season) and ordered by the date they were added.

Example:
  name = Test item
  alternate_art_inventory_icons = race season 1, emberwake
  -> File:Test item race season 1 inventory icon.png, File:Test item 1 emberwake inventory icon.png
|}

==Base item==
Items with a rarity above normal (i.e. magic/rare/unique) can have a base item set. 

When a base item is set, most of the attributes will be copied over to the item and only attributes that differ from the base item need to be set, due to that the base item **must** exist.

There should only be one of the following base item parameters be set; if possible consider using a base item that is guaranteed to be unique.

Note that regardless of which setting was used, all properties will be populated.

{| class="wikitable sortable"
! Parameter
! Value
! PyPoE<br>Export
! Unique
! Property
! Property on the base item
! Description
|-
| base_item
| str
| {{no}}
| {{no}}
| [[Property:Has base item|Has base item]]
| [[Property:Has name|Has name]]
| Base item name
|-
| base_item_id
| str
| {{no}}
| {{yes}}
| [[Property:Has base item metadata id|Has base item metadata id]]
| [[Property:Has metadata id|Has metadata id]]
| Base item metadata id.
|-
| base_item_page
| str
| {{no}}
| {{yes}}
| [[Property:Has base item wiki page|Has base item wiki page]]
| {{n/a}}
| Base item wiki page.
|}

==Setting mods==

Mods can be set on any item type. 

Generally there are two ways of doing this: 

# setting the mod id
# setting the mod text

The order of the mods does matter - it's how the mod's stats will appear on the item.

Mod id and mod text can mixed up.

All mods will be added to [[Property:Has mod ids]], regardless of where they come from.

Replace the <code><nowiki><i></nowiki></code> with the order of the mod starting at 1.

===Mod parameters===

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| implicit<i>
| str
| {{no}}
| {{yes}}
| [[Property:Has implicit mod ids|Has implicit mod ids]]
| Id of the implicit mod at index i
|-
| implicit<i>_text
| str
| {{no}}
| {{yes}}
| {{n/a}}
| Text of the implicit mod at index i
|-
| explicit<i>
| str
| {{no}}
| {{yes}}
| [[Property:Has explicit mod ids|Has explicit mod ids]]
| Id of the explicit mod at index i
|-
| explicit<i>_text
| str
| {{no}}
| {{yes}}
| {{n/a}}
| Text of the explicit mod at index i
|}

===When to use mod id and mod text===

The mod id must correspond to an existing mod id. please note the mod id may be different from the page itself, look on the particular mod page for the id itself (also see [[Template:Mod]])

The template will calculate adjustments to the base values of the item based on the mods. Make sure that any values on the item itself are set to the **base value** (before applying the stats) and not the final values.

If a base item is supplied for the item, any implicit mods will be copied over. Explicit mods will not be copied.

====Finding the appropriate mods for unique items====
Mods are exposed with several properties by [[Template:Mod]], as a result mods can be searched through ask queries.

If you have an unique item where the minimum and maximum rolls are known, or even just the stat texts, you can search those properties through queries.



For example, {{il|Brightbeak}} has 5 different stat lines which rolls are known, finding the mod for
 (50 to 75)% increased Physical Damage
can be done through a query like this:
<pre>{{#ask: 
 [[Is mod::+]]
 [[Has mod generation type::3]]
 [[Has stat text::~*Physical Damage*]]
 [[Has subobject::<q>
  [[Has minimum stat value::50]]
  [[Has maximum stat value::75]]
 </q>]]
 |?Has stat text
}}</pre>
This may yield multiple possible mods:
{{#ask: 
 [[Is mod::+]]
 [[Has mod generation type::3]]
 [[Has stat text::~*Physical Damage*]]
 [[Has subobject::<q>
  [[Has minimum stat value::50]]
  [[Has maximum stat value::75]]
 </q>]]
 |?Has stat text
}}

As you can see there is only 1 acceptable mod id in this case that has a matching stat text. 

In the case there is more then one result that would satisfy the condition, the internal id of the mod can be considered:

UniqueOneHandMace1 does fit what we're searching for: a modifier for an unique one hand mace

In addition once you have found multiple mods for the different stat texts, they usually will be named in a similar fashion (they should refer to a UniqueOneHandMace1 in this case).

====If you fail to find any mods====

Generally using mod text should be avoided, since it doesn't handle any automated updating of the values. 

However if there is no appropriate mod on the wiki yet (for example, for upcoming unique items!), you may want to use the <code>mod_text</code> parameter.

To address the system not updating the values on the item properly, you can also manually set stats on an item:

{| class="wikitable sortable"
! Parameter
! Value
! {{abbr|Range|if the value for a range. All parameters for either range or non range must be set}}
! Description
|-
| <nowiki>extra_stat<i>_id</nowiki>
| str
| {{n/a}}
| Identifier of the stat. Consider checking [[Module:Item2]] source code to see which ones are handled.
|-
| <nowiki>extra_stat<i>_value</nowiki>
| str
| {{no}}
| the value of a stat if it isn't a range.
|-
| <nowiki>extra_stat<i>_min</nowiki>
| str
| {{yes}}
| minimum range value of a stat
|-
| <nowiki>extra_stat<i>_max</nowiki>
| str
| {{yes}}
| maximum range value of a stat
|}

==Parameters available to groups of item classes==

Parameters that apply to various groups of item classes.

=== Flasks ===

'''Eligible item classes''':

Life Flasks, Mana Flasks, Hybrid Flasks, Utility Flasks, Critical Utility Flasks

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Properties
! Description
|-
| flask_duration
| int
| {{no}}
| {{yes}}
| [[Property:Has base flask duration|Has base flask duration]]
[[Property:Has flask duration range minimum|Has flask duration range minimum]]

[[Property:Has flask duration range average|Has flask duration range average]]

[[Property:Has flask duration range maximum|Has flask duration range maximum]]
| How long the flask lasts
|-
| charges_max
| int
| {{no}}
| {{yes}}
| [[Property:Has base maximum flask charges|Has base maximum flask charges]]
[[Property:Has maximum flask charges range minimum|Has maximum flask charges range minimum]]

[[Property:Has maximum flask charges range average|Has maximum flask charges range average]]

[[Property:Has maximum flask charges range maximum|Has maximum flask charges range maximum]]
| Maximum number of charges the flask holds
|-
| charges_per_use
| int
| {{no}}
| {{yes}}
| [[Property:Has base flask charges per use|Has base flask charges per use]]
[[Property:Has flask charges per use range minimum|Has flask charges per use range minimum]]

[[Property:Has flask charges per use range average|Has flask charges per use range average]]

[[Property:Has flask charges per use range maximum|Has flask charges per use range maximum]]
| 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'

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Properties
! Description
|-
| critical_strike_chance
| int
| {{no}}
| {{yes}}
| [[Property:Has base critical strike chance|Has base critical strike chance]]
[[Property:Has critical strike chance range minimum|Has critical strike chance range minimum]]

[[Property:Has critical strike chance range average|Has critical strike chance range average]]

[[Property:Has critical strike chance range maximum|Has critical strike chance range maximum]]
| Base critical strike chance of the weapon
|-
| attack_speed
| int
| {{no}}
| {{yes}}
| [[Property:Has base attack speed|Has base attack speed]]
[[Property:Has attack speed range minimum|Has attack speed range minimum]]

[[Property:Has attack speed range average|Has attack speed range average]]

[[Property:Has attack speed range maximum|Has attack speed range maximum]]
| Base attack speed of the weapon
|-
| damage_min
| int
| {{no}}
| {{yes}}
| [[Property:Has base minimum physical damage|Has base minimum physical damage]]
[[Property:Has minimum physical damage range minimum|Has minimum physical damage range minimum]]

[[Property:Has minimum physical damage range average|Has minimum physical damage range average]]

[[Property:Has minimum physical damage range maximum|Has minimum physical damage range maximum]]
| Minimum base physical damage of the weapon
|-
| damage_max
| int
| {{no}}
| {{yes}}
| [[Property:Has base maximum physical damage|Has base maximum physical damage]]
[[Property:Has maximum physical damage range minimum|Has maximum physical damage range minimum]]

[[Property:Has maximum physical damage range average|Has maximum physical damage range average]]

[[Property:Has maximum physical damage range maximum|Has maximum physical damage range maximum]]
| Maximum base physical damage of the weapon
|-
| range
| int
| {{no}}
| {{yes}}
| [[Property:Has base weapon range|Has base weapon range]]
[[Property:Has weapon range range minimum|Has weapon range range minimum]]

[[Property:Has weapon range range average|Has weapon range range average]]

[[Property:Has weapon range range maximum|Has weapon range range maximum]]
| Range in game units of the weapon
|}

=== Armour ===

'''Eligible item classes''':

'Gloves', 'Boots', 'Body Armours', 'Helmets', 'Shields'

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Properties
! Description
|-
| armour
| int
| {{no}}
| {{yes}}
| [[Property:Has base armour|Has base armour]]
[[Property:Has armour range minimum|Has armour range minimum]]

[[Property:Has armour range average|Has armour range average]]

[[Property:Has armour range maximum|Has armour range maximum]]
| [[Armour]] of the armour
|-
| energy_shield
| int
| {{no}}
| {{yes}}
| [[Property:Has base energy shield|Has base energy shield]]
[[Property:Has energy shield range minimum|Has energy shield range minimum]]

[[Property:Has energy shield range average|Has energy shield range average]]

[[Property:Has energy shield range maximum|Has energy shield range maximum]]
| [[Energy Shield]] of the armour
|-
| evasion
| int
| {{no}}
| {{yes}}
| [[Property:Has base evasion|Has base evasion]]
[[Property:Has evasion range minimum|Has evasion range minimum]]

[[Property:Has evasion range average|Has evasion range average]]

[[Property:Has evasion range maximum|Has evasion range maximum]]
| [[Evasion Rating]] of the armour
|}

=== Gems ===

'''Eligible item classes''':

'Active Skill Gems', 'Support Skill Gems'

They also inherit all parameters from the [[Template:Skill|Skill]] template.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| gem_tags
| list[str] 
| {{no}}
| {{yes}}
| [[Property:Has gem tags|Has gem tags]]
[[Property:Has gem tags difference|Has gem tags difference]]
| 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
| {{no}}
| {{yes}}
| [[Property:Has dexterity percentage|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
| {{no}}
| {{yes}}
| [[Property:Has strength percentage|Has strength percentage]]
| [[Strength]] portion of the gem stat distribution.
|-
| intelligence_percent
| int
| {{no}}
| {{yes}}
| [[Property:Has intelligence percentage|Has intelligence percentage]]
| [[Intelligence]] portion of the gem stat distribution.
|}

With all arguments supplied, these properties will also be set:
{| class="wikitable sortable"
! Property
! Description
|-
| [[Property:Has primary attribute|Has primary attribute]]
| Will be set to the primary attribute (highest percentage)
|}

=== Stackables ===

'''Eligible item classes''':

'Currency', 'Stackable Currency', 'Hideout Doodads', 'Microtransactions', 'Divination Card'

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| stack_size
| int
| {{no}}
| {{yes}}
| [[Property:Has stack size|Has stack size]]
| Maximum stack size of the item
|}

==Parameters specific to a single item class==

Parameters specific to item classes

{| class="wikitable sortable"
! Class
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| Life Flasks
Hybrid Flasks
| flask_life
| int
| {{no}}
| {{yes}}
| [[Property:Has base flask life recovery|Has base flask life recovery]]
[[Property:Has flask life recovery range minimum|Has flask life recovery range minimum]]

[[Property:Has flask life recovery range average|Has flask life recovery range average]]

[[Property:Has flask life recovery range maximum|Has flask life recovery range maximum]]
| How much [[Life]] the flask recovers
|-
| Mana Flasks
Hybrid Flasks
| flask_mana
| int
| {{no}}
| {{yes}}
| [[Property:Has base flask mana recovery|Has base flask mana recovery]]
[[Property:Has flask mana recovery range minimum|Has flask mana recovery range minimum]]

[[Property:Has flask mana recovery range average|Has flask mana recovery range average]]

[[Property:Has flask mana recovery range maximum|Has flask mana recovery range maximum]]
| How much [[Mana]] the flask recovers
<!--
|-
| Active Skill Gems
| skill_screenshot
|
| {{no}}
|
|-
| Active Skill Gems
| gem_icon
|
| {{no}}
|
-->
|-
| Shields
| block
| int
| {{no}}
| {{yes}}
| [[Property:Has base block|Has base block]]
[[Property:Has block range minimum|Has block range minimum]]

[[Property:Has block range average|Has block range average]]

[[Property:Has block range maximum|Has block range maximum]]
| The base chance to block on shields
|-
| Amulets
| is_talisman
| bool
| {{no}}
| {{yes}}
| [[Property:Is talisman|Is talisman]]
| Whether the amulet is a talisman (defaults to no)
|}

===Hideout Doodads===

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| is_master_doodad
| bool
| {{no}}
| {{yes}}
| [[Property:Is master doodad|Is master doodad]]
| Whether this doodad is a doodad that can be bought from a master
|-
| master
| str
| {{no}}
| {{yes}}
| [[Property:Is sold by master|Is sold by master]]
| Name of the [[forsaken master]] who sells this doodad, if any
|-
| master_level_requirement
| int
| {{no}}
| {{yes}}
| [[Property:Has master level requirement|Has master level requirement]]
| Which master level the [[forsaken master]] sell the doodad at, if any
|-
| master_favour_cost
| int
| {{no}}
| {{yes}}
| [[Property:Has master favour cost|Has master favour cost]]
| How [[master favour]] the doodad costs, if any
|-
| variation_count
| int
| {{no}}
| {{yes}}
| [[Property:Has variation count|Has variation count]]
| Number of available variations for this doodad
|}

===Maps===

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| map_tier
| int
| {{no}}
| {{yes}}
| [[Property:Has map tier|Has map tier]]
| Tier of the map
|-
| map_guild_character
| str
| {{no}}
| {{yes}}
| [[Property:Has map guild character|Has map guild character]]
| Character used when using the map for creating a guild
|-
| map_area_id
| int
| {{no}}
| {{yes}}
| [[Property:Has map area id|Has map area id]]
| Area id of the map
|-
| map_area_level
| int
| {{no}}
| {{yes}}
| [[Property:Has map area level|Has map area level]]
| Area level of the map
|-
| unique_map_guild_character
| str
| {{no}}
| {{yes}}
| [[Property:Has unique map guild character|Has unique map guild character]]
| Character used when using the unique version of the map for creating a guild
|-
| unique_map_area_id
| int
| {{no}}
| {{yes}}
| [[Property:Has unique map area id|Has unique map area id]]
| Area id of the unique version of the map
|-
| unique_map_area_level
| int
| {{no}}
| {{yes}}
| [[Property:Has unique map area level|Has unique map area level]]
| Area level of the map
|}

===Stackable Currency===

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| is_essence
| bool
| {{no}}
| {{yes}}
| [[Property:Is essence|Is essence]]
| Whether the currency item is an essence
|-
| essence_level_restriction
| int
| {{no}}
| {{yes}}
| [[Property:Has essence level restriction|Has essence level restriction]]
| Up to which item level the essence can be used
|-
| essence_tier
| int
| {{no}}
| {{yes}}
| [[Property:Has essence tier|Has essence tier]]
| Tier of the essence
|}

==See also==

* [[Template:Item link]]
* [[Template:Skill]]

<includeonly>
[[Category:Data templates]]
[[Category:Item templates]]
</includeonly>