View source for Template:Item/doc

{{documentation subpage}}

{{lua|Module:Item2|Module:Mod}}

{{high-risk}}

'''Item''' is a template that creates an infobox on the page, then [[smw:Help:Parser_functions|sets]] [[smw:Help:Categories|categories]] and [[smw:Help:Properties and types|semantic properties]] to the page. This allows the items to be [[smw:Help:Semantic_search|searched]] for and [[smw:Help:Displaying information|displayed]] in advanced item tables that stays up-to-date, which can be difficult in a game that is constantly evolving.  

==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'''.

===Maintenance categories===

Maintenance categories will be set when the template is incorrectly used or some parameters should be filled out.

{| class="wikitable"
! Category
! Variable
! Description
|-
| [[:Category:Items without a release version]]
| release_version
| Items that do not have a release version set.  
|-
| [[:Category:Items with improper modifiers]]
| implicit&lt;i&gt;_text or
explicit&lt;i&gt;_text 
| Items that use explicit text instead of proper references to modifiers.
|- 
| [[:Category:Items with broken item references in upgraded from parameters‎]]
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_id or
upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_page or

upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_name
| Items that have a broken item reference in one of the ingredient groups; i.e. either no matches or too many matches.
|}

==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
|-
| drop_leagues
| list[str]
| {{no}}
| {{no}}
| [[Property:Has league drop restrictions‎|Has league drop restrictions‎]]
| A comma-separated list of leagues the item can drop it. 

Generally this should specified for items that are only obtainable as long the league flag is active (i.e. through the league itself, though zana mods, or other conditions). 
|-
| drop_areas
| list[str]
| {{no}}
| {{no}}
| [[Property:Has no area drop restriction|Has no area drop restriction]] 
[[Property:Has area drop restriction ids|Has area drop restriction ids]] 

[[Property:Has area drop restriction names|Has area drop restriction names]] 

[[Property:Has area drop restriction HTML|Has area drop restriction HTML]] 
| A comma-separated list of area ids the item can drop in.

The field should be specified for items that can only drop in specific areas, but '''not''' for instances where specific monsters drop this item (even if the monster only appears in the specific area - this is because the drop restriction is related to the monster, not the area in those cases).

See [[{{FULLPAGENAME}}#Finding areas|Finding areas]] section on this page for more details.
|-
| drop_areas_html
| list[str]
| {{no}}
| {{no}}
| [[Property:Has area drop restriction HTML|Has area drop restriction HTML]] 
| Overrides the automatically generated text form the drop_areas parameter. This should only be specified in cases where a lot of areas are specified and it would reduce visibility.
|-
| drop_text
| str
| {{no}}
| {{no}}
| [[Property:Has drop restriction text]]
| Parameter to handle any restrictions to obtaining an item that are not covered by more specific parameters.
'''Always use a specific parameter if possible'''
|-
| 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
|-
| is_corrupted
| bool
| {{no}}
| {{no}}
| [[Property:Is corrupted]]
| Set to true if the item is always corrupted (i.e. drops in a corrupted state). 
|-
| is_relic
| bool
| {{no}}
| {{no}}
| [[Property:Is relic]]
| Set to true if the item is a relic. Rarity of the item must be "Unique" for this to work.
|-
| 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.

Items that have no release version set will also be added to the category [[:Category:Items without a release version|Items without a release version]].
|-
| removal_version
| str
| {{no}}
| {{no}}
| [[Property:Has removal version|Has removal version]]
[[Property:Has removal date|Has removal date]]
| The version number of when this item was removed. The version must a be a valid version number and there must be a version page or the template will return an error.
The removal date property is automatically added when the version is specified - it holds the date of when the version was removed.  
|-
| inventory_icon
| str
| {{no}}
| {{no}}
| [[Property:Has inventory icon|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|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
|-
| quality
| int
| {{no}}
| {{no}}
| [[Property:Has quality|Has quality]]
| Quality of the item. This arguments only works for item classes that can have quality (i.e. Maps, all Flasks, all Weapons and all armour pieces)

For unique weapons and armours this defaults to Q20.
|-
| cannot_be_traded_or_modified
| boolean
| {{no}}
| {{no}}
| [[Property:Cannot be traded or modified|Cannot be traded or modified]]
| Whether the item can be traded or modified.
Defaults to true.
|}

===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.
|}

===Purchase costs===

Items of '''Normal''' [[rarity]] support setting purchase costs at NPC vendors for each of the rarities. 

In the following table replace these parameters accordingly:
* <code><nowiki><rarity></nowiki></code>- replace with the current [[rarity]], i.e. <code>normal</code>, <code>magic</code>, <code>rare</code> or <code>unique</code>
* <code><nowiki><i></nowiki></code> - replace with the order of the mod starting at 1.

Please note that multiple entries will all be assumed to be necessary for the purchase.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| purchase_cost_<nowiki><rarity><i></nowiki>_name
| str
| {{yes}}
| {{yes}}
| [[Property:Has purchase cost item name]]
| The item name which is used for purchasing this item of the specified rarity
|-
| purchase_cost_<nowiki><rarity><i></nowiki>_amount
| int
| {{yes}}
| {{yes}}
| [[Property:Has purchase cost amount]]
| How many of the specified item name are required for purchasing this item of the specified rarity
|}

For example, to set the purchase cost of an item to 5x {{il|Scroll of Wisdom}} and 1x {{il|Orb of Alteration}} you'll need to specify the following in the parameters:
    purchase_cost_normal1_name = Scroll of Wisdom
    purchase_cost_normal1_amount = 5
    purchase_cost_normal2_name = Orb of Alteration
    purchase_cost_normal2_amount = 1

==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
If used without setting implicit, this will simply set a line in the item box.

If implicit at the same index is also specified, this can be used as override to the text. If set to any false value, the text from the mod will not be shown. 
|-
| 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
If used without setting explicit, this will simply set a line in the item box.

If explicit at the same index is also specified, this can be used as override to the text. If set to any false value, the text from the mod will not be shown. 
|}

===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 
  {{c|mod|(50 to 75)% increased Physical Damage}} 
can be done through a query like this:
{|- style="width:80em"
|<pre>{{#ask: 
 [[Has stat text::~*Physical Damage*]]
 [[Has subobject::<q>
  [[Has minimum stat value::50]]
  [[Has maximum stat value::75]]
 </q>]]
 [[Has mod generation type::3]]
 [[Is mod::+]]
 |limit=1000
 |sort=Has stat text
 |format=template
  |template=SMW mod table with items
  |introtemplate=SMW mod table with items/intro
  |outrotemplate=SMW mod table with items/outro
  |?Is mod
  |?Has stat text
  |?Is used in item
}}</pre>
| <pre><-- Query function
<-- Condition 1: The stat text must match these keywords. (Edit this condition)
<-- Condition 2: Check the subobjects for:
              2.1: The minimum value this stat has.       (Edit this condition)
              2.2: The maximum value this stat has.       (Edit this condition)

<-- Condition 3: Restrict to only unique mods.
<-- Condition 4: Mod id must be defined.
<-- Limit the results to 1000.
<-- Sort the results by a property.
<-- Use a custom template to display the results. The 
indented parameters are required for the template. 
The template checks if the mod is already used in an 
item. It's not necessary but it helps when ruling 
out mods with similar stats.



</pre>
|}

This may yield multiple possible mods:
{{#ask: 
 [[Has stat text::~*Physical Damage*]]
 [[Has mod generation type::3]]
 [[Is mod::+]]
 [[Has subobject::<q>
  [[Has minimum stat value::50]]
  [[Has maximum stat value::75]]
 </q>]]
 |limit=1000
 |sort=Has stat text
 |format=template
  |template=SMW mod table with items
  |introtemplate=SMW mod table with items/intro
  |outrotemplate=SMW mod table with items/outro
  |?Is mod
  |?Has stat text
  |?Is used in item
}}

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


If several mods have the same stat text: 
* Avoid having multiple items with the same mod.
** If that's the case try to assign the highest numbered mod id to the newest released item. The {{tlx|SMW mod table with items}} result template helps with this.
* Consider the internal id of the mod ([[Property:Is mod]]).
** '''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 may be named in a similar fashion (they should refer to a UniqueOneHandMace1 in this case).


Let's say only {{c|mod|66% increased Physical Damage}} is known, then the maximum and minimum values are not known but the properties can still be used by replacing that subobject with:
<pre>
 [[Has subobject::<q>
  [[Has minimum stat value::<66]]
  [[Has maximum stat value::>66]]
 </q>]]
</pre>


'''Notes''':
* SMW can only search the first 72 characters of a string.
* Stat text can include '''linked words'''. The <code><nowiki>[[linked page|linked word]]</nowiki></code> will be included and since the linked word sometimes differ to the linked page it's not to easy figure out the correct stat text.
* Stat text may change between updates of the game, so searching for the values and not the text might be a good idea.
* Using [[smw:Help:Selecting_pages#Like.2C_not_like|wildcards]] can make your life easier.
* The page name and mod id aren't always the same. Use [[Property:Is mod]] when adding to the item.

'''Notes about specific stats''':
{| class="wikitable"
! Type
! Description
! Values
|-
| '''"per second" values'''
| These are generally handled by minute. So <code>2% Life regenerated per second</code> equals a stat value of <code>120</code>
| x*60
|-
| '''duration values'''
| These are generally handled in milliseconds. So <code>Gain Onslaught for 3 seconds</code> equals a stat value of <code>3000</code>
| x*1000
|-
| '''reduced/less''' 
| These are generally negated values. So <code>30% reduced life</code> equals a stat value of <code>-30</code> 
| x*-1
|-
| '''x-y'''
| These are generally two separate stats, you want to search for min/max for x or min/max for y.
 So for <code>Adds (1-2) to (3-4) Physical Damage</code> values <code>Has minimum stat value::1 Has maximum stat value::2</code> or <code>Has minimum stat value::3 Has maximum stat value::4</code> are appropriate. Mixing these will yield no results.
| x or y<br>
not both
|}

====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
|}

==Vendor recipes and upgrade paths==

Vendor recipes and upgrade paths can be represented by using the upgraded_from parameters. Any item can have an arbitrary number of sets that produce the item with each set containing a number of groups that represent a single or multiple items of the same type with a specific condition.

===Set parameters===

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

{| class="wikitable sortable"
! Parameter
! Type
! Description
|-
| upgraded_from_set&lt;i&gt;_text
| str
| A descriptive text that applies to the entire set. 
For example, this could be used in vendor recipes to mention that all items need to be quality 20 in order for the set to work.
|}

===Group parameters===

Replace the <code><nowiki><i></nowiki></code> with the order of the set starting at 1.
Replace the <code><nowiki><j></nowiki></code> with the order of the group starting at 1.

The <code>item_</code> parameters used to look up the item in the wiki database, if no item is found, the set will be considered invalid. An exact error message is output to the log which can be shown under Lua logs when hitting the preview button upon saving the page and the page will be added to [[:Category:Items with broken item references in upgraded from parameters]].

{| class="wikitable sortable"
! Parameter
! Type
! Description
! Required
|-
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_id
| str
| Metadata id of the ingredient item. 
Use this if possible.
| {{yes}}
|-
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_page
| str
| Page of the ingredient item.
Use this to avoid ambiguous item names. Please note as the page name changes the reference here will be invalid, so it isn't as robust as using ids.
| {{yes}}
|-
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_item_name
| str
| Exact, case-sensitive name of the item consumed.
Item names can be used for multiple items which can cause this option to fail.
| {{yes}}
|-
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_amount
| int
| Amount of items of this type used/consumed in the recipe.
| {{yes}}
|-
| upgraded_from_set&lt;i&gt;_group&lt;j&gt;_notes
| str
| Extra notes about the item types.
For example, the rarity required of the item could be described here.
| {{no}}
|}

==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
|}

=== Utility Flasks ===

'''Eligible item classes''':

[[Utility Flasks]], [[Critical Utility Flasks]]

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Properties
! Description
|-
| buff_id
| str
| {{no}}
| {{yes}}
| [[Property:Has buff id|Has buff id]]
| Internal ID of the associated buff (compare to [[Template:Buff]] and Buff namespace)
|-
| buff_stat_text
| str
| {{no}}
| {{yes}}
| [[Property:Has buff stat text|Has buff stat text]]
| Buff [[stat]] text as it would appear on the flask
|-
| buff_value<i>
| int
| {{no}}
| {{yes}}
| Subobjects with 
[[Property:Is number|Is number]]

[[Property:Has buff value|Has buff value]]
| Values to use for the buff. Order matters; replace <code><nowiki><i></nowiki></code> with the ordinal number starting at 1.
|}

=== 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
|}

===Jewel===

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| item_limit
| int
| {{no}}
| {{no}}
| [[Property:Has item limit]]
| Maximum amount of jewels that can be equipped at once.
|}

==Other specific parameters==
===Prophecies===

Prophecies are a special case which require the <code>base_item</code> to be set to "Prophecy" with <code>rarity</code> "Normal" and <code>class</code> "Stackable Currency":
<pre>{{Item
|rarity                           = Normal
|class                            = Stackable Currency
|base_item                        = Prophecy
...
}}</pre>

In addition, the following parameters are exclusive to [[prophecies]]:

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Property
! Description
|-
| prophecy_id
| str
| {{no}}
| {{yes}}
| [[Property:Has prophecy id]]
| Internal (unique) identifier of the prophecy.
|-
| prediction_text
| str
| {{no}}
| {{yes}}
| [[Property:Has prophecy prediction text]]
| The prediction text of the prophecy (i.e. the white text that tells you what will happen).
|-
| seal_cost
| int
| {{no}}
| {{yes}}
| [[Property:Has prophecy seal cost]]
| How many {{il|Silver Coin|name=Silver Coins}} are required to seal the prophecy.
|}

==Examples==

===Finding areas===

For the <code>drop_areas</code> parameter you'll need to specify the area ids; the id is required instead of the name of the area, because multiple areas can share the same name. If you go to the page of the inappropriate area it will show it's id in the infobox.



You can also use SMW to find ids using a simple query, for example:

:<syntaxhighlight>{{#ask:
  [[Has name::The Twilight Strand]]
  |?Is area id
  |?Has name
  |?Has main page
}}</syntaxhighlight>
Yields:
: {{#ask:
  [[Has name::The Twilight Strand]]
  |?Is area id
  |?Has name
  |?Has act
  |?Has main page
}}

So if you meant the act 1 area you'd use <code>drop_areas = 1_1_1</code>, if you meant the act 6 area, you'd use <code>drop_areas = 2_6_1</code> or if you actually want both you can just use them both <code>drop_areas = 1_1_1, 2_6_1</code>.

==See also==

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

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