Template:Item/doc

This subpage provides documentation for Template:Item.

This template uses the following modules:

• Module:Item2

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

Parameter	Value	Required	PyPoE Export	Property	Description
class	str	✓	✓	Has item class	A valid item class
rarity	str	✓	✓	Has rarity	rarity of the item, one of: Normal Magic Rare Unique
name	str	✓	✓	Has name	Name of the item
name_list	str	✗	✗	Has 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	✗	✓	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
release_version	str	✗	✗	Has release version 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	✗	✗	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]	✗	✗	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.

Parameter	Value	PyPoE Export	Unique	Property	Property on the base item	Description
base_item	str	✗	✗	Has base item	Has name	Base item name
base_item_id	str	✗	✓	Has base item metadata id	Has metadata id	Base item metadata id.
base_item_page	str	✗	✓	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:

1. setting the mod id
2. 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 <i> with the order of the mod starting at 1.

Mod parameters

Parameter	Value	Required	PyPoE Export	Property	Description
implicit	str	✗	✓	Has implicit mod ids	Id of the implicit mod at index i
implicit_text	str	✗	✓	N/A	Text of the implicit mod at index i
explicit	str	✗	✓	Has explicit mod ids	Id of the explicit mod at index i
explicit_text	str	✗	✓	N/A	Text of the explicit mod at index i

Notes about mod id

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.

Notes about mod text

Generally using mod text should be avoided, since it doesn't handle any automated updating of the values. The case where it should be used if there is no appropriate mod on the wiki yet (for example, for upcoming unique items!)

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

Parameter	Value	Required	PyPoE Export	Properties	Description
flask_duration	int	✗	✓	Has base flask duration Has flask duration range minimum Has flask duration range average Has flask duration range maxiimum	How long the flask lasts
charges_max	int	✗	✓	Has base maximum flask charges Has maximum flask charges range minimum Has maximum flask charges range average Has maximum flask charges range maxiimum	Maximum number of charges the flask holds
charges_per_use	int	✗	✓	Has base flask charges per use Has flask charges per use range minimum Has flask charges per use range average Has flask charges per use range maxiimum	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	PyPoE Export	Properties	Description
critical_strike_chance	int	✗	✓	Has base critical strike chance Has critical strike chance range minimum Has critical strike chance range average Has critical strike chance range maximum	Base critical strike chance of the weapon
attack_speed	int	✗	✓	Has base attack speed Has attack speed range minimum Has attack speed range average Has attack speed range maximum	Base attack speed of the weapon
damage_min	int	✗	✓	Has base minimum physical damage Has minimum physical damage range minimum Has minimum physical damage range average Has minimum physical damage range maximum	Minimum base physical damage of the weapon
damage_max	int	✗	✓	Has base maximum physical damage Has maximum physical damage range minimum Has maximum physical damage range average Has maximum physical damage range maximum	Maximum base physical damage of the weapon
range	int	✗	✓	Has base weapon range Has weapon range range minimum Has weapon range range average Has weapon range range maximum	Range in game units of the weapon

Armour

Eligible item classes:

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

Parameter	Value	Required	PyPoE Export	Properties	Description
armour	int	✗	✓	Has base armour Has armour range minimum Has armour range average Has armour range maximum	Armour of the armour
energy_shield	int	✗	✓	Has base energy shield Has energy shield range minimum Has energy shield range average Has energy shield range maximum	Energy Shield of the armour
evasion	int	✗	✓	Has base evasion Has evasion range minimum Has evasion range average 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 Skill template.

Parameter	Value	Required	PyPoE Export	Property	Description
gem_tags	list[str]	✗	✓	Has gem tags 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	✗	✓	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	PyPoE Export	Property	Description
stack_size	int	✗	✓	Has stack size	Maximum stack size of the item

Parameters specific to a single item class

Parameters specific to item classes

Class	Parameter	Value	Required	PyPoE Export	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)

Hideout Doodads

Parameter	Value	Required	PyPoE Export	Description
is_master_doodad	bool	✗	✓	Whether this doodad is a doodad that can be bought from a master
master	str	✗	✓	Name of the forsaken master who sells this doodad
master_level_requirement	int	✗	✓	Which master level the forsaken master sell the doodad at
master_favour_cost	int	✗	✓	How master favour the doodad costs
variation_count	int	✗	✓	Number of available variations for this doodad

See also

• Template:Item link
• Template:Skill