View source for Template:Item/doc

{{Documentation subpage}}

{{High-risk|8000+}}
{{Lua|Module:Item2}}

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

__TOC__

==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 invalid recipe parts‎]]
| recipe&lt;i&gt;_part&lt;j&gt;_item_id or
recipe&lt;i&gt;_part&lt;j&gt;_item_page or

recipe&lt;i&gt;_part&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.
|- 
| [[:Category:Items with duplicate recipes]]
| recipe&lt;i&gt;_part&lt;j&gt;_item_id or
recipe&lt;i&gt;_part&lt;j&gt;_item_page or

recipe&lt;i&gt;_part&lt;j&gt;_item_name
| Items that have a recipe manually entered on their page which is already added by the automatically populated recipes.

Those pages should have the duplicate sets removed, as they are not necessary. 

For cases where the automatic system is incorrect, please comment on the [[Module_talk:Item2|Item2 talk page]].  
|}

==Base parameters==

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| class_id
| str
| {{yes}}
| {{yes}}
| {{no}}
| items.class_id
| A valid internal [[item class]] id. This is used to determine further properties of the item and thus is required in all cases.
|-
| rarity_id
| str
| {{yes}}
| {{yes}}
| {{no}}
| items.rarity_id
| [[rarity]] of the item, one of:
* normal
* magic
* rare
* unique
|-
| name
| str
| {{yes}}
| {{yes}}
| {{no}}
| items.name
| Name of the item
|-
| name_list
| str
| {{no}}
| {{no}}
| {{no}}
| items.name_list
| 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}}
| {{no}}
| items.size_x
| x-size in inventory units, i.e. the width
|-
| size_y
| int
| {{no}}
| {{yes}}
| {{no}}
| items.size_y
| y-size in inventory units, i.e. the height
|-
| is_in_game
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_in_game
| Whether the item actually exists in the game. Default: true.

This is primarily used to differentiate between items that are [[drop disabled]] but exist in the game from items that no longer exist in the game but are still retained on the wiki for historical purposes.
|-
| drop_enabled
| bool
| {{no}}
| <center>{{abbr|*|some edge cases are automatically added, however it is advisable to set it manually}}</center>
| {{no}}
| items.drop_enabled
| Whether the item can drop at all from any content. Default: false if <code>is_in_game=false</code>, otherwise true.

Set to false for items that are [[drop disabled]].
|-
| drop_level
| int
| {{no}}
| {{yes}}
| {{no}}
| items.drop_level
| At which level the item starts dropping at (may differ from required_level)
|-
| drop_level_maximum
| int
| {{no}}
| {{yes}}
| {{no}}
| items.drop_level_maximum
| Up to which level the item drops
|-
| drop_areas
| list[str]
| {{no}}
| {{no}}
| {{no}}
| items.drop_areas
item.drop_areas_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}}
| {{no}}
| item.drop_areas_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_monsters
| list[str]
| {{no}}
| {{no}}
| {{no}}
| items.drop_monsters
| A comma-separated list of monster ids the item can drop from.

The field should be specified for items that can only drop from specific monsters, but '''not''' in combination with drop_areas. Because the drop restriction is related to the monster, not the area.

See [[{{FULLPAGENAME}}#Finding monsters|Finding monsters]] section on this page for more details.
|-
| drop_text
| str
| {{no}}
| {{no}}
| {{no}}
| items.drop_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}}
| {{yes}}
| items.required_level
| Which level is required to use the item (may differ from drop_level)
|-
| required_dexterity
| int
| {{no}}
| {{yes}}
| {{yes}}
| items.required_dexterity
| The [[dexterity]] requirement of the item if any
|-
| required_intelligence
| int
| {{no}}
| {{yes}}
| {{yes}}
| items.required_intelligence
| The [[intelligence]] requirement of the item if any
|-
| required_strength
| int
| {{no}}
| {{yes}}
| {{yes}}
| items.required_strength
| The [[strength]] requirement of the item if any
|-
| flavour_text
| str
| {{no}}
| {{yes}}
| {{no}}
| items.flavour_text
| Flavour text if any (i.e. for unique items, vaal fragments, divination cards, etc)
|-
| help_text
| str
| {{no}}
| {{yes}}
| {{no}}
| items.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}}
| {{no}}
| items.tags
| List of internal tags
|-
| metadata_id
| str
| {{no}}
| {{yes}}
| {{no}}
| items.metadata_id
| Internal metadata id of the item
|-
| influences
| list[str]
| {{no}}
| {{no}}
| {{no}}
| items.influences
| Comma-separated list of the item's [[Influenced item|influences]]. Valid options are:
* shaper
* elder
* crusader
* redeemer
* hunter
* warlord
|-
| is_fractured
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_fractured
| Set to true if the item is [[fractured]].
|-
| is_synthesised
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_synthesised
| Set to true if the item is [[synthesised]].
|-
| is_searing_exarch_item
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_searing_exarch_item
| Set to true if the item has a [[Searing Exarch implicit modifier]].
|-
| is_eater_of_worlds_item
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_eater_of_worlds_item
| Set to true if the item has an [[Eater of Worlds implicit modifier]].
|-
| is_veiled
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_veiled
| Set to true if the item has [[veiled modifier]]s.
|-
| is_replica
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_replica
| Set to true if the item is a [[replica unique item]].
|-
| is_corrupted
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_corrupted
| Set to true if the item is always corrupted (i.e. drops in a corrupted state).
|-
| is_mirrored
| bool
| {{no}}
| {{no}}
| {{no}}
| {{n/a}}
| Whether to display "Mirrored" in the item box. Default: false
|-
| is_unmodifiable
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_unmodifiable
| Whether the item is unmodifiable. Default: false

Although this parameter can be used for individual items, it is usually set as default for certain item classes, such as [[sentinel]]s.
|-
| is_relic
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_relic
| Set to true if the item is a relic. Rarity of the item must be "Unique" for this to work.
|-
| is_drop_restricted
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_drop_restricted
| Whether the item is [[Drop-restricted item|drop restricted]], meaning it has restrictions on where or how it can drop.

Set to true if the item is drop restricted, but not [[drop disabled]]—it does not have <code>drop_enabled=false</code>.

Defaults to true for the following cases:
* [[prophecies]]
* [[talisman]]s
* [[essence]]s
* [[divination card]]s
* [[incubator]]s
* [[replica]] unique items
* [[relic]]s
* [[oil]]s
* items with <code>drop_monsters=</code> set

Otherwise, it defaults to false. Setting this parameter always overrides the default.
|-
| acquisition_tags
| list[str]
| {{no}}
| {{no}}
| {{no}}
| items.acquisition_tags
| A comma-separated list of acquisition tags. This tags items according to their acquisition methods, such as divination cards. Acquisition tags are used by {{tl|item acquisition}} and to query certain lists of items.

In addition to the names of challenge leagues, acquisition tags include the following:
* league-specific
* fishing
* experimented base type
* ritual base type
* runic base type
* corruption transformation
|-
| release_version
| str
| {{no}}
| {{no}}
| {{no}}
| items.release_version
| The version number of when this item was initially released; when an item has legacy variants the date of the original release of the legacy variant should be used. The version must a be a valid version number and there must be a version page or the template will return an error.

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}}
| {{no}}
| items.removal_version
| 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.
|-
| inventory_icon
| str
| {{no}}
| {{no}}
| {{no}}
| items.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
|-
| skill_screenshot
| str
| {{no}}
| {{no}}
| {{no}}
| skill_screenshot
| '''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 "skill screenshot.jpg" suffix.

For example:
  name = Baller
  inventory_icon = Test item (cold and fire)
  -> File:Test item (cold and fire) skill screenshot.jpg
|-
| alternate_art_inventory_icons
| list[str]
| {{no}}
| {{no}}
| {{no}}
| items.alternate_art_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}}
| {{no}}
| item_stats.id = "quality"
item_stats.value = &lt;value&gt;
| 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}}
| {{no}}
| items.cannot_be_traded_or_modified
| Whether the item can be traded or modified.
Defaults to false.
|-
| is_account_bound
| bool
| {{no}}
| {{no}}
| {{no}}
| items.is_account_bound
| Whether the item is account-bound. Default: false

Although this parameter can be used for individual items, it is usually set as default for certain item classes.
|}

===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
! Field
! Field on the base item
! Description
|-
| base_item
| str
| {{no}}
| {{no}}
| items.base_item
| Base item name
|-
| base_item_id
| str
| {{no}}
| {{yes}}
| items.base_item_id
| Base item metadata id.
|-
| base_item_page
| str
| {{no}}
| {{yes}}
| items.base_item_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>, will be added to <code>item_purchase_costs.rarity</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
! Field
! Description
|-
| purchase_cost_<nowiki><rarity><i></nowiki>_name
| str
| {{yes}}
| {{yes}}
| item_purchase_costs.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}}
| item_purchase_costs.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.

===Mod parameters===

Replace the <code>&lt;i&gt;</code> with the order of the mod starting at 1.
Replace the <code>&lt;implicit/explicit&gt;</code> according to whether the modifier is an implicit or explicit. In the data base table, this value will correspond to <code>item_mods.is_implicit</code>.

Note that unique items inherit the implicits of their base items automatically. It is not necessary to specify the implicits for a unique item unless they are different from the implicits of the base item.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Field(s)
! Description
|-
| &lt;implicit/explicit&gt;&lt;i&gt;
| str
| {{no}}
| {{yes}}
| item_mods.id
| Id of the implicit or explicit modifier at index i
|-
| &lt;implicit/explicit&gt;&lt;i&gt;_text
| str
| {{no}}
| {{yes}}
| item_mods.text
| Text of the implicit or explicit modifier at index i
If the mod id at the same index is:
* set: Will override the text of the modifier with the specified one. If set to any false value the text will be hidden entirely.
* not set: Will simply set a line. The page will also be added to [[:Category:Items with improper modifiers]]
|-
| &lt;implicit/explicit&gt;&lt;i&gt;_random_list
| list[str]
| {{no}}
| {{yes}}
| item_mods.id
item_mods.is_random
| Should be a set to a comma-separated list of modifiers that can randomly appear on the item. All the modifiers will be added to the infoboxes and item tables, but they will not be included in the inline infoboxes. Unlike regular modifiers, stats here will not affect the visible item stats in the infoboxes (so for example, a random armour modifier will not increase the armour value shown).

If the text parameter is set for this index, the given text will be shown as a summary instead of the default. 

This parameter should be used for unique items that can choose from a pool of random modifiers.
|}

===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 modifiers for unique items====
Modifiers are exposed with several properties by {{tlx|Mod}}, as a result modifiers can be searched through 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:
<pre>
{{#cargo_query: 
 |tables=mods, mod_stats, spawn_weights, _pageData
 |join on=mods._pageName=mod_stats._pageName, mods._pageName=spawn_weights._pageName, mods._pageName=_pageData._pageName
 |fields=mods._pageName, mods.id, mods.stat_text, _pageData._creationDate, _pageData._modificationDate
 |where= 
       mods.stat_text LIKE "%Physical Damage%"
   AND mods.generation_type=3
   AND mod_stats.min=50
   AND mod_stats.max=75
 |limit=5000
 |order by=mods.stat_text
 |group by=mods._pageName, mod_stats._pageName, spawn_weights._pageName
 |format=template
  |template=Mod table with items
  |intro={{Mod table with items/intro}}
  |outro={{Mod table with items/outro}}
}}
</pre>

This may yield multiple possible modifiers:

{{#cargo_query: 
 |tables=mods, mod_stats, spawn_weights, _pageData
 |join on=mods._pageName=mod_stats._pageName, mods._pageName=spawn_weights._pageName, mods._pageName=_pageData._pageName
 |fields=mods._pageName, mods.id, mods.stat_text, _pageData._creationDate, _pageData._modificationDate
 |where= 
       mods.stat_text LIKE "%Physical Damage%"
   AND mods.generation_type=3
   AND mod_stats.min=50
   AND mod_stats.max=75
 |limit=5000
 |order by=mods.stat_text
 |group by=mods._pageName, mod_stats._pageName, spawn_weights._pageName
 |format=template
  |template=Mod table with items
  |intro={{Mod table with items/intro}}
  |outro={{Mod table with items/outro}}
}}
As you can see there is only 1 acceptable mod id in this case that has a matching stat text. 


'''If several modifiers have the same stat text:''' 
* Avoid having multiple items with the same modifier.
** If that's the case try to assign the highest numbered mod id to the newest released item. The {{tlx|Mod table with items}} result template helps with this.
* Consider the internal id of the modifier (<code>mods.id</code>).
** '''UniqueOneHandMace1''' does fit what we're searching for: a modifier for an unique one hand mace
** In addition once you have found multiple modifiers for the different stat texts, they may be named in a similar fashion (they should refer to a UniqueOneHandMace1 in this case).
* Use [[poe:trade|pathofexile.com/trade]] as a reference because it always uses the correct modifiers.
** Some modifiers can be excluded because their stat value does not match the trade site. For example {{il|The Rat Cage}} has the {{c|mod|10% of Fire Damage from Hits taken as Physical Damage}}. If you filter for this stat it wont be possible to find ''all'' Rat Cages because: 
*** Legacy items uses {{ml|FireDamageTakenConvertedToPhysicalUniqueBodyStrDex5}} which has the stat <code>base_fire_hit_damage_taken_%_as_physical_value_negated = -10</code>.
*** Current versions uses {{ml|FireDamageTakenConvertedToPhysicalUnique__1}} which has the stat <code>base_fire_hit_damage_taken_%_as_physical = 10</code>. 


Let's say only {{c|mod|66% increased Physical Damage}} is known, then the maximum and minimum values are not known but the fields can still be used by replacing that part with:
<pre>
   AND mod_stats.min<=66
   AND mod_stats.max>=66
</pre>


'''Notes''':
* Cargo has similar syntax to SQL.
* 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 wildcards can make your life easier.
* The page name and mod id aren't always the same. Use <code>mods.id</code>] 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>mod_stats.min=1 AND mod_stats.max=2</code> or <code>mod_stats.min=3 AND mod_stats.max=4</code> are appropriate. Mixing these will yield no results.
| x or y<br>
not both
|-
| '''Permyriad'''
| Percentage values are sometimes rewritten as a [[wikipedia:Basis_point|permyriad]] stat value.
| x*100
|}

====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>&lt;implicit/explicit&gt;&lt;i&gt;_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
|}

==Recipes==

A recipe describes a way to obtain a specific item (result) from one or more other items (parts). In game terms, recipes include [[vendor recipes]], [[divination card]] exchanges, and any other ways of transforming one or more items into another item.

Recipes can be specified by using the recipe parameters. Any item can have an arbitrary number of recipes that produce the item with each recipe containing a number of parts that represent a single or multiple items of the same type with a specific condition.

===Automatic system===

The item module has an automatic system that enters recipe data for certain item types. 

The system covers the following cases currently:
* [[Essence]] vendor recipes and corruptions
* [[Oil]] vendor recipes
* Most [[divination card]] exchanges that have more than one possible outcome
* Hatched items from several [[incubator]]s

Those entries do not need to be duplicated in the sections and the module will provide an error in the lua log if erroneously provided. Such pages will also be added to [[:Category:Items with duplicate recipes‎]] in order to find them.

The system is automatically disabled for certain types of items
* Any items that considered disabled (i.e. <code>drop_enabled=false</code>)
* Most items that have <code>is_drop_restricted</code> set
** this will only apply to entries that don't award specific items, generally this will exclude things that can only drop under specific circumstances (see the parameter for more details)
** certain cards can override this behaviour
* Any items with <code>disable_automatic_recipes=true</code> set. This parameter should only be used in extremely rare circumstances where it is impractical to use the automatic system for some reason.

Any recipes automatically entered to the database will also have the <code>acquisition_recipes.automatic</code> field set to ''true'' in the database to differentiate them from manual entries.

Additions or changes to the system should be proposed and discussed on [[Module:Item2]]'s [[Module_talk:Item2|talk page]].

===Recipe parameters===

Replace the <code>&lt;i&gt;</code> with the order of the recipe starting at 1.

{| class="wikitable sortable"
! Parameter
! Type
! Description
|-
| recipe&lt;i&gt;_description
| str
| A description of the recipe
This should describe the recipe. It may also include general notes about the recipe. For example, this could be used in vendor recipes to mention that all items need to be 20% quality in order for the recipe to work.
|}

Replace the <code>&lt;j&gt;</code> with the order of the part starting at 1.

The <code>item_</code> parameters used to look up the item in the wiki database, if no item is found, the recipe 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 invalid recipe parts]].

{| class="wikitable sortable"
! Parameter
! Type
! Description
! Required
|-
| recipe&lt;i&gt;_part&lt;j&gt;_item_id
| str
| Metadata id of the ingredient item. 
Use this if possible.
| {{yes}}
|-
| recipe&lt;i&gt;_part&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}}
|-
| recipe&lt;i&gt;_part&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}}
|-
| recipe&lt;i&gt;_part&lt;j&gt;_amount
| int
| Amount of items of this type used/consumed in the recipe.
| {{yes}}
|-
| recipe&lt;i&gt;_part&lt;j&gt;_notes
| str
| Extra notes about the item types.
For example, the rarity required of the item could be described here.
| {{no}}
|}

==Quest rewards==
Replace the <code><nowiki><i></nowiki></code> with the ordinal of the quest reward set starting at 1.

{| class="wikitable sortable"
! Parameter
! Type
! Required
! Reward type
! Field
! Description
|-
| quest_reward&lt;i&gt;_type
| str
| {{yes}}
| both
| {{n/a}}
| Sets whether this is a quest reward or a vendor reward. Acceptable values are <code>quest</code> or <code>vendor</code>.

Data will be written to the quest_rewards or vendor_rewards accordingly.
|-
| quest_reward&lt;i&gt;_quest
| str
| {{yes}}
| both
| quest_rewards.quest
vendor_rewards.quest
| Name of the quest which rewards this item (in any stage of the quest)
|-
| quest_reward&lt;i&gt;_quest_id
| str
| {{yes}}
| both
| quest_rewards.quest_id
vendor_rewards.quest_id
| ID of the quest which rewards this item (in any stage of the quest)
|-
| quest_reward&lt;i&gt;_act
| int
| {{yes}}
| both
| quest_rewards.act
vendor_rewards.act
| Act in which the quest appears in
|-
| quest_reward&lt;i&gt;_class_ids
| str
| {{no}}
| both
| quest_rewards.class_ids
quest_rewards.classes

vendor_rewards.class_ids

vendor_rewards.classes
| List of class ids which can obtain this reward after completing the quest. If left empty it is assumed the reward can be obtained by all classes.

The class id can either be the English Name or the related attribute id (e.x. StrDex for [[Duelist]])

{{#cargo_query:
tables = character_classes
|fields = character_classes.name, character_classes.str_id
|where = 
      character_classes.name IS NOT NULL
}}
|-
| quest_reward&lt;i&gt;_npc
| str
| {{yes}}
| vendor
| vendor_rewards.npc
| Which vendor sells the item after the quest has been completed
|-
| quest_reward&lt;i&gt;_sockets
| int
| {{no}}
| quest
| quest_rewards.sockets
| Number of sockets (if any)
|-
| quest_reward&lt;i&gt;_item_level
| int
| {{no}}
| quest
| quest_rewards.item_level
| Item level of the reward (if any)
|-
| quest_reward&lt;i&gt;_rarity_id
| str
| {{no}}
| quest
| quest_rewards.rarity_id
quest_rewards.rarity
| Rarity id of the reward (english name of the rarity in lower case)
|-
| quest_reward&lt;i&gt;_notes
| str
| {{no}}
| quest
| quest_rewards.notes
| Any additional notes for the reward
|}

==Item sell price overrides==
In general these parameters should not be set since the item sell price is derived from the modifiers on the item or special vendor recipes. If the sell price is only sightly different from the ingame price (e.x. 2 alchemy shards less then ingame) this indicates that modifiers are missing or wrongfully chosen and should '''NOT''' be fixed with sell prices overrides.

Items that have this set will be added to the maintenance category [[:Category:Items with sell prices overrides]].

===Sell price parameters===

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

{| class="wikitable sortable"
! Parameter
! Type
! Description
|-
| sell_price&lt;i&gt;_name
| str
| Name of the sell price item
|-
| sell_price&lt;i&gt;_amount
| str
| How many of the specified item this item sells for
|}

==Parameters for groups of item classes==

These are parameters that apply to groups of item classes.

=== Flasks ===

[[Flask]]s include the following item classes:
* [[Life flask]]s
* [[Mana flask]]s
* [[Hybrid flask]]s
* [[Utility flask]]s

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Properties
! Description
|-
| flask_duration
| int
| {{no}}
| {{yes}}
| {{yes}}
| flasks.duration
| How long the flask lasts
|-
| charges_max
| int
| {{no}}
| {{yes}}
| {{yes}}
| flasks.charges_max
| Maximum number of charges the flask holds
|-
| charges_per_use
| int
| {{no}}
| {{yes}}
| {{yes}}
| flasks.charges_per_use
| Charges consumed when the flask is used
|}

=== Weapons ===

[[Weapon]]s include the following item classes:
* [[Claw]]s
* [[Dagger]]s
* [[Wand]]s
* [[One-handed sword]]s
* [[Thrusting one-handed sword]]s
* [[One-handed axe]]s
* [[One-handed mace]]s
* [[Bow]]s
* [[Staff|Staves]]
* [[Two-handed sword]]s
* [[Two-handed axe]]s
* [[Two-handed mace]]s
* [[Sceptre]]s
* [[Fishing rod]]s
* [[Rune dagger]]s
* [[Warstaff|Warstaves]]

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Properties
! Description
|-
| critical_strike_chance
| float
| {{no}}
| {{yes}}
| {{yes}}
| weapons.critical_strike_chance
| Base critical strike chance of the weapon
|-
| attack_speed
| float
| {{no}}
| {{yes}}
| {{yes}}
| weapons.attack_speeed
| Base attack speed of the weapon
|-
| damage_min
| int
| {{no}}
| {{yes}}
| {{yes}}
| weapons.physical_damage_max
| Minimum base physical damage of the weapon
|-
| damage_max
| int
| {{no}}
| {{yes}}
| {{yes}}
| weapons.physical_damage_min
| Maximum base physical damage of the weapon
|-
| weapon_range
| int
| {{no}}
| {{yes}}
| {{yes}}
| weapons.range
| Range in game units of the weapon
|}

Additionally, the following values are set in the data base as long other parameters are specified:

{| class="wikitable sortable"
! Value
! Range
! Properties
! Description
|-
| int
| {{yes}}
| weapons.lightning_damage_min
| Minimum lightning damage of the weapon
|-
| int
| {{yes}}
| weapons.lightning_damage_max
| Maximum lightning damage of the weapon
|-
| int
| {{yes}}
| weapons.cold_damage_min
| Minimum cold damage of the weapon
|-
| int
| {{yes}}
| weapons.cold_damage_max
| Maximum cold damage of the weapon
|-
| int
| {{yes}}
| weapons.fire_damage_min
| Minimum fire damage of the weapon
|-
| int
| {{yes}}
| weapons.fire_damage_max
| Maximum fire damage of the weapon
|-
| int
| {{yes}}
| weapons.chaos_damage_min
| Minimum chaos damage of the weapon
|-
| int
| {{yes}}
| weapons.chaos_damage_max
| Maximum chaos damage of the weapon
|-
| float
| {{yes}}
| weapons.physical_dps
| Damage per second based on physical damage and attack speed
|-
| float
| {{yes}}
| weapons.lightning_dps
| Damage per second based on lightning damage and attack speed
|-
| float
| {{yes}}
| weapons.cold_dps
| Damage per second based on cold damage and attack speed
|-
| float
| {{yes}}
| weapons.fire_dps
| Damage per second based on fire damage and attack speed
|-
| float
| {{yes}}
| weapons.chaos_dps
| Damage per second based on chaos damage and attack speed
|-
| float
| {{yes}}
| weapons.poison_dps
| Damage per second based on physical damage, chaos damage and attack speed
|-
| float
| {{yes}}
| weapons.elemental_dps
| Damage per second based on lightning damage, cold damage, fire damage and attack speed
|-
| float
| {{yes}}
| weapons.physical_dps
| Damage per second based on physical damage, lightning damage, cold damage, fire damage, chaos damage and attack speed
|-
| str
| {{no}}
| weapons.damage_html
| All damage values as HTML
|}

=== Armour ===

[[Armour (equipment)|Armour]] includes the following item classes:
* [[Gloves]]
* [[Boots]]
* [[Body armour]]s
* [[Helmet]]s
* [[Shield]]s

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range{{abbr|*|Min and max values together form a range}}
! Properties
! Description
|-
| armour_min
| int
| {{no}}
| {{yes}}
| rowspan="2" | {{yes}}
| armours.armour_min
| Minimum [[armour]] value
|-
| armour_max
| int
| {{no}}
| {{yes}}
| armours.armour_max
| Maximum armour value
|-
| evasion_min
| int
| {{no}}
| {{yes}}
| rowspan="2" | {{yes}}
| armours.evasion_min
| Minimum [[evasion rating]] value
|-
| evasion_max
| int
| {{no}}
| {{yes}}
| armours.evasion_max
| Maximum evasion rating value
|-
| energy_shield_min
| int
| {{no}}
| {{yes}}
| rowspan="2" | {{yes}}
| armours.energy_shield_min
| Minimum [[energy shield]] value
|-
| energy_shield_max
| int
| {{no}}
| {{yes}}
| armours.energy_shield_max
| Maximum energy shield value
|-
| ward_min
| int
| {{no}}
| {{yes}}
| rowspan="2" | {{yes}}
| armours.ward_min
| Minimum [[ward]] value
|-
| ward_max
| int
| {{no}}
| {{yes}}
| armours.ward_max
| Maximum ward value
|}

=== Gems ===

[[Gem]]s include the following item classes:
* [[Skill gem]]s
* [[Support gem]]s

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

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| gem_tags
| list[str] 
| {{no}}
| {{yes}}
| {{no}}
| skill_gems.gem_tags
| List of gem tags. 
|-
| dexterity_percent
| int
| {{no}}
| {{yes}}
| {{no}}
| skill_gems.dexterity_percent
| [[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}}
| {{no}}
| skill_gems.strength_percent
| [[Strength]] portion of the gem stat distribution.
|-
| intelligence_percent
| int
| {{no}}
| {{yes}}
| {{no}}
| skill_gems.intelligence_percent
| [[Intelligence]] portion of the gem stat distribution.
|}

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

=== Stackables ===

Stackables include the following item classes:
* [[Currency item]]s
* [[Divination card]]s
* [[Resonator]]s
* [[Incubator]]s
* [[Harvest seed]]s
* [[Harvest plant booster]]s

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| stack_size
| int
| {{no}}
| {{yes}}
| {{no}}
| stackables.stack_size
| Maximum stack size of the item
|}

==Parameters for specific item classes==

These are parameters that apply to specific item classes.

===Amulets===
The following parameters apply to [[amulet]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| is_talisman
| bool
| {{no}}
| {{yes}}
| {{no}}
| amulets.is_talisman
| Whether the amulet is a talisman (defaults to no)
|}

===Life flasks and hybrid flasks===
The following parameters apply to [[life flask]]s and [[hybrid flask]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| flask_life
| int
| {{no}}
| {{yes}}
| {{yes}}
| flasks.life
| How much [[Life]] the flask recovers
|}

===Mana flasks and hybrid flasks===
The following parameters apply to [[mana flask]]s and [[hybrid flask]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| flask_mana
| int
| {{no}}
| {{yes}}
| {{yes}}
| flasks.mana
| How much [[Mana]] the flask recovers
|}

===Utility flasks===
The following parameters apply to [[utility flask]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| buff_id
| str
| {{no}}
| {{yes}}
| {{no}}
| item_buffs.id
| Internal ID of the associated buff
|-
| buff_stat_text
| str
| {{no}}
| {{yes}}
| {{no}}
| item_buffs.stat_text
| Buff [[stat]] text as it would appear on the flask
|-
| buff_value<i>
| int
| {{no}}
| {{yes}}
| {{no}}
| item_buffs.values
| Values to use for the buff. Order matters; replace <code><nowiki><i></nowiki></code> with the ordinal number starting at 1.
|-
| buff_icon
| str
| {{no}}
| {{no}}
| {{no}}
| item_buffs.icon
| Icon of the buff effect
|}

===Shields===
The following parameters apply to [[shield]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| block
| int
| {{no}}
| {{yes}}
| {{yes}}
| shields.block
| The base chance to block on shields
|}

===Divination cards===
The following parameters apply to [[divination card]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| card_art
| str
| {{no}}
| {{no}}
| {{no}}
| divination_cards.card_art
| Can be used to define alternate name for the divination card background art.
By default, the name of the card is used.
|-
| card_background
| list[int]
| {{no}}
| {{no}}
| {{no}}
| divination_cards.card_background
| Specifies the animated background for certain divination cards.
|}

===Hideout decorations===
The following parameters apply to [[hideout decoration]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| is_master_doodad
| bool
| {{no}}
| {{yes}}
| {{no}}
| hideout_doodads.is_master_doodad
| Whether it is always available to use in unlimited quantities
|-
| variation_count
| int
| {{no}}
| {{yes}}
| {{no}}
| hideout_doodads.variation_count
| Number of variations
|}

===Maps===
The following parameters apply to [[map]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| map_tier
| int
| {{no}}
| {{yes}}
| {{no}}
| maps.tier
| Tier of the map
|-
| map_guild_character
| str
| {{no}}
| {{yes}}
| {{no}}
| maps.guild_character
| Character used when using the map for creating a guild
|-
| map_area_id
| int
| {{no}}
| {{yes}}
| {{no}}
| maps.area_id
| Area id of the map
|-
| map_area_level
| int
| {{no}}
| {{yes}}
| {{no}}
| maps.area_level
| Area level of the map
|-
| unique_map_guild_character
| str
| {{no}}
| {{yes}}
| {{no}}
| maps.unique_guild_character
| Character used when using the unique version of the map for creating a guild
|-
| unique_map_area_id
| int
| {{no}}
| {{yes}}
| {{no}}
| maps.unique_area_id
| Area id of the unique version of the map
|-
| unique_map_area_level
| int
| {{no}}
| {{yes}}
| {{no}}
| maps.unique_area_level
| Area level of the map
|}

====Current map series / atlas maps====
This set of parameter is intended only for the current map series featured on the atlas and only contains parameters relevant to the atlas.

The placeholder <code>&lt;i&gt;</code> is used in some places for the upgrade tier of the relevant region. Valid tiers are between 0 and 4.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| atlas_region_id
| str
| {{no}}
| {{yes}}
| {{no}}
| atlas_maps.region_id
| Internal ID of the Region this map is located in. 
|-
| atlas_region_minimum
| int
| {{no}}
| {{yes}}
| {{no}}
| atlas_maps.region_minimum
| Lowest region upgrade tier at which the map can appear on the region map
|-
| atlas_x&lt;i&gt;
| float
| {{no}}
| {{yes}}
| {{no}}
| atlas_maps.x&lt;i&gt;
| X-coordinate on the atlas of worlds for the given region upgrade tier &lti&gt;
|-
| atlas_y&lt;i&gt;
| float
| {{no}}
| {{yes}}
| {{no}}
| atlas_maps.x&lt;i&gt;
| Y-coordinate on the atlas of worlds for the given region upgrade tier &lti&gt;
|-
| atlas_map_tier&lt;i&gt;
| int
| {{no}}
| {{yes}}
| {{no}}
| atlas_maps.map_tier&lt;i&gt;
| Tier of the map for the given region upgrade tier &lti&gt;

If the map is not present at the specified tier this this value should be 0
|}

=====Connections=====
Connections are placed here starting at the index <code>&lt;i&gt;</code> 1 incrementing by one for each connection. Any amount of connections can be specified, however no integers can be skipped. The order of the connections does not matter.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| atlas_connection&lt;i&gt;_target
| page
| {{yes}}
| {{yes}}
| {{no}}
| atlas_connections.map2
| The '''page''' name of the connected map. Map page names strictly follow the syntax of <code>Map name (league)</code>, for example [[Port Map (Metamorph)]].
|-
| atlas_connection&lt;i&gt;_tier
| bool
| {{yes}}
| {{yes}}
| {{no}}
| 
atlas_connections.region0<br>
atlas_connections.region1<br>
atlas_connections.region2<br>
atlas_connections.region3<br>
atlas_connections.region4
| A list representing for which region upgrade levels this connection is present. The list always have 5 boolean (true/false) entries representing tiers 0 though 4.

For example:
<pre>atlas_connections1_tier = False, True, False, True, False</pre>
means that the connection is present on Tier 1 & 3, but not any of the others.
|}

===Jewels===
The following parameters apply to [[jewel]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| jewel_limit
| str
| {{no}}
| {{no}}
| {{no}}
| jewels.jewel_limit
| Maximum amount of jewels that can be equipped at once
|-
| {{n/a}}
| str
| {{no}}
| {{no}}
| {{no}}
| jewels.radius_html
| HTML text of the jewels radius, if any specified via mods
|}

===Sentinels===
The following parameters apply to [[sentinel]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| sentinel_duration
| int
| {{no}}
| {{no}}
| {{yes}}
| sentinels.duration
| How long in seconds the sentinel remains active
|-
| sentinel_empowers
| int
| {{no}}
| {{no}}
| {{yes}}
| sentinels.empowers
| Number of monsters the sentinel can empower
|-
| sentinel_empowerment
| int
| {{no}}
| {{no}}
| {{yes}}
| sentinels.empowerment
| Value representing the increase in power monsters get when empowered
|-
| sentinel_monster
| int
| {{no}}
| {{no}}
| {{no}}
| sentinels.monster
| Name of the boss monster that this sentinel can empower. Used together with <code>sentinel_monster_level</code> for unique sentinels that are only used on a single boss monster.
|-
| sentinel_monster_level
| int
| {{no}}
| {{no}}
| {{no}}
| sentinels.monster_level
| Level of the boss monster that this sentinel can empower. Used together with <code>sentinel_monster</code> for unique sentinels that are only used on a single boss monster.
|-
| sentinel_charge
| int
| {{no}}
| {{no}}
| {{yes}}
| sentinels.charge
| Maximum number of uses
|}

===Harvest seeds===
The following parameters apply to [[harvest seed]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| seed_effect
| str
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.effect
| The description of what the seed does
|-
| seed_type_id
| str
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.type
harvest_seeds.type_id
| The ID of the seed type. 
Valid values are primal, vivid and wild
|-
| seed_tier
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.tier
| The tier of the seed
|-
| seed_growth_cycles
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.growth_cycles
| How many cycles it takes to grow the seed
|-
| seed_required_nearby_seed_amount
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.required_nearby_seed_amount
| How many nearby seeds are required to grow this type of seed. If empty, 0 is assumed.
|-
| seed_required_nearby_seed_tier
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.required_nearby_seed_tier
| The type id of nearby seeds to grow this type of seed. Valid types are primal, vivid and wild. If the seed amount is not specified, this can be left out.
|-
| seed_consumed_wild_lifeforce_percentage
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.consumed_wild_lifeforce_percentage
| How much of the life force is granted as {{c|wild|wild}} lifeforce. 

Since the lifeforce is level based, this used to show the distribution. If this item doesn't grant life force of a particular type 0 can be used.
|-
| seed_consumed_primal_lifeforce_percentage
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.consumed_primal_lifeforce_percentage
| How much of the life force is granted as {{c|primal|primal}} lifeforce. 

Since the lifeforce is level based, this used to show the distribution. If this item doesn't grant life force of a particular type 0 can be used.
|-
| seed_consumed_vivid_lifeforce_percentage
| int
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.consumed_vivid_lifeforce_percentage
| How much of the life force is granted as {{c|vivid|vidid}} lifeforce. 

Since the lifeforce is level based, this used to show the distribution. If this item doesn't grant life force of a particular type 0 can be used.
|-
| seed_granted_craft_option_ids
| list[str]
| {{no}}
| {{yes}}
| {{no}}
| harvest_seeds.granted_craft_option_ids
| List of comma separated crafting options by their ID. Generally this should be covered by the export with no adjustments needed - see [[Module:Harvest/harvest craft options]] for the craft option data.
|}

==Parameters for narrower classifications of items==
Certain types of items have additional parameters.

===Essences===
The following parameters apply to [[essence]]s.

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| is_essence
| bool
| {{yes}}
| {{yes}}
| {{no}}
| {{n/a}}
| Whether the currency item is an essence
|-
| essence_level_restriction
| int
| {{no}}
| {{yes}}
| {{no}}
| essences.level_restriction
| Up to which item level the essence can be used
|-
| essence_level
| int
| {{no}}
| {{yes}}
| {{no}}
| essence.level
| Essence tier
|-
| essence_type
| int
| {{no}}
| {{yes}}
| {{no}}
| essence.type
| 
|-
| essence_category
| str
| {{no}}
| {{yes}}
| {{no}}
| essence.category
| 
|}

===Prophecies===
The following parameters apply to [[Prophecy|prophecies]].

{| class="wikitable sortable"
! Parameter
! Value
! Required
! PyPoE<br>Export
! Range
! Field
! Description
|-
| prophecy_id
| str
| {{yes}}
| {{no}}
| {{no}}
| prophecies.prophecy_id
| Internal (unique) identifier of the prophecy.
|-
| prediction_text
| str
| {{no}}
| {{no}}
| {{no}}
| prophecies.prediction_text
| The prediction text of the prophecy (i.e. the white text that tells you what will happen).
|-
| seal_cost
| int
| {{no}}
| {{no}}
| {{no}}
| prophecies.seal_cost
| How many {{il|page=Silver Coin (Prophecy)|name=Silver Coins}} are required to seal the prophecy.
|-
| objective
| str
| {{no}}
| {{no}}
| {{no}}
| prophecies.objective
| Text detailing what is required to successfully complete the prophecy
|-
| reward
| str
| {{no}}
| {{no}}
| {{no}}
| prophecies.reward
| Text detailing what the prophecy rewards (please also specify recipe if it upgrades an item)
|}

==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. There are a couple of ways to find area ids:
# In the '''main area page''' there is a infobox that shows the id.
# You can also use #cargo_query to find ids using a simple query such as:
<pre>{{#cargo_query:
|tables=areas
|fields=areas._pageName, areas.id, areas.name, areas.act, areas.main_page
|where=areas.name="The Twilight Strand"
|group by=areas._pageID
}}</pre>
Yields:
{{#cargo_query:
|tables=areas
|fields=areas._pageName, areas.id, areas.name, areas.act, areas.main_page
|where=areas.name="The Twilight Strand"
|group by=areas._pageID
}}
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>.

===Finding monsters===
For the <code>drop_monsters</code> parameter you'll need to specify the monster ids; the id is required instead of the name of the monster, because multiple monsters can share the same name. There are a couple of ways to find monsters' ids:
# In the '''main monster page''' there is a infobox that shows the id.
# You can also use #cargo_query to find ids using a simple query such as:
<pre>{{#cargo_query:
|tables=monsters
|fields=monsters._pageName, monsters.metadata_id, monsters.name, 
|where=monsters.name = "Atziri, Queen of the Vaal"
}}</pre>
Yields:
{{#cargo_query:
|tables=monsters
|fields=monsters._pageName, monsters.metadata_id, monsters.name, 
|where=monsters.name = "Atziri, Queen of the Vaal"
}}
So if you meant the normal boss you'd use <code>drop_monsters = Metadata/Monsters/Atziri/Atziri</code>, if you meant Uber Atziri, you'd use <code>drop_monsters = Metadata/Monsters/Atziri/Atziri2</code> or if you actually want both you can just use them both <code>drop_areas = Metadata/Monsters/Atziri/Atziri, Metadata/Monsters/Atziri/Atziri2</code>. But as we see here there are a few other as well, but by the name we can tell that those seem to be related to the different phases. So study the differences and try to choose the most straightforward one, being consistent by using the same metadata_id makes it easier to show on all the relevant pages.

==Cargo==
{| class="wikitable"
! Table !! Declared by !! Attached by
|-
| [[Special:CargoTables/acquisition_recipe_parts|acquisition_recipe_parts]]
| {{tl|Item/cargo/acquisition recipe parts/declare}}
| {{tl|Item/cargo/acquisition recipe parts/attach}}
|-
| [[Special:CargoTables/acquisition_recipes|acquisition_recipes]]
| {{tl|Item/cargo/acquisition recipes/declare}}
| {{tl|Item/cargo/acquisition recipes/attach}}
|-
| [[Special:CargoTables/amulets|amulets]]
| {{tl|Item/cargo/amulets/declare}}
| {{tl|Item/cargo/amulets/attach}}
|-
| [[Special:CargoTables/armours|armours]]
| {{tl|Item/cargo/armours/declare}}
| {{tl|Item/cargo/armours/attach}}
|-
| [[Special:CargoTables/atlas_connections|atlas_connections]]
| {{tl|Item/cargo/atlas connections/declare}}
| {{tl|Item/cargo/atlas connections/attach}}
|-
| [[Special:CargoTables/atlas_maps|atlas_maps]]
| {{tl|Item/cargo/atlas maps/declare}}
| {{tl|Item/cargo/atlas maps/attach}}
|-
| [[Special:CargoTables/blight_items|blight_items]]
| {{tl|Item/cargo/blight items/declare}}
| {{tl|Item/cargo/blight items/attach}}
|-
| [[Special:CargoTables/cosmetic_items|cosmetic_items]]
| {{tl|Item/cargo/cosmetic items/declare}}
| {{tl|Item/cargo/cosmetic items/attach}}
|-
| [[Special:CargoTables/divination_cards|divination_cards]]
| {{tl|Item/cargo/divination cards/declare}}
| {{tl|Item/cargo/divination cards/attach}}
|-
| [[Special:CargoTables/essences|essences]]
| {{tl|Item/cargo/essences/declare}}
| {{tl|Item/cargo/essences/attach}}
|-
| [[Special:CargoTables/flasks|flasks]]
| {{tl|Item/cargo/flasks/declare}}
| {{tl|Item/cargo/flasks/attach}}
|-
| [[Special:CargoTables/harvest_plant_boosters|harvest_plant_boosters]]
| {{tl|Item/cargo/harvest plant boosters/declare}}
| {{tl|Item/cargo/harvest plant boosters/attach}}
|-
| [[Special:CargoTables/harvest_seeds|harvest_seeds]]
| {{tl|Item/cargo/harvest seeds/declare}}
| {{tl|Item/cargo/harvest seeds/attach}}
|-
| [[Special:CargoTables/heist_equipment|heist_equipment]]
| {{tl|Item/cargo/heist equipment/declare}}
| {{tl|Item/cargo/heist equipment/attach}}
|-
| [[Special:CargoTables/hideout_doodads|hideout_doodads]]
| {{tl|Item/cargo/hideout doodads/declare}}
| {{tl|Item/cargo/hideout doodads/attach}}
|-
| [[Special:CargoTables/item_buffs|item_buffs]]
| {{tl|Item/cargo/item buffs/declare}}
| {{tl|Item/cargo/item buffs/attach}}
|-
| [[Special:CargoTables/item_mods|item_mods]]
| {{tl|Item/cargo/item mods/declare}}
| {{tl|Item/cargo/item mods/attach}}
|-
| [[Special:CargoTables/item_purchase_costs|item_purchase_costs]]
| {{tl|Item/cargo/item purchase costs/declare}}
| {{tl|Item/cargo/item purchase costs/attach}}
|-
| [[Special:CargoTables/item_sell_prices|item_sell_prices]]
| {{tl|Item/cargo/item sell prices/declare}}
| {{tl|Item/cargo/item sell prices/attach}}
|-
| [[Special:CargoTables/item_stats|item_stats]]
| {{tl|Item/cargo/item stats/declare}}
| {{tl|Item/cargo/item stats/attach}}
|-
| [[Special:CargoTables/items|items]]
| {{tl|Item/cargo/items/declare}}
| {{tl|Item/cargo/items/attach}}
|-
| [[Special:CargoTables/jewels|jewels]]
| {{tl|Item/cargo/jewels/declare}}
| {{tl|Item/cargo/jewels/attach}}
|-
| [[Special:CargoTables/maps|maps]]
| {{tl|Item/cargo/maps/declare}}
| {{tl|Item/cargo/maps/attach}}
|-
| [[Special:CargoTables/prophecies|prophecies]]
| {{tl|Item/cargo/prophecies/declare}}
| {{tl|Item/cargo/prophecies/attach}}
|-
| [[Special:CargoTables/quest_rewards|quest_rewards]]
| {{tl|Item/cargo/quest rewards/declare}}
| {{tl|Item/cargo/quest rewards/attach}}
|-
| [[Special:CargoTables/sentinels|sentinels]]
| {{tl|Item/cargo/sentinels/declare}}
| {{tl|Item/cargo/sentinels/attach}}
|-
| [[Special:CargoTables/shields|shields]]
| {{tl|Item/cargo/shields/declare}}
| {{tl|Item/cargo/shields/attach}}
|-
| [[Special:CargoTables/skill_gems|skill_gems]]
| {{tl|Item/cargo/skill gems/declare}}
| {{tl|Item/cargo/skill gems/attach}}
|-
| [[Special:CargoTables/stackables|stackables]]
| {{tl|Item/cargo/stackables/declare}}
| {{tl|Item/cargo/stackables/attach}}
|-
| [[Special:CargoTables/tattoos|tattoos]]
| {{tl|Item/cargo/tattoos/declare}}
| {{tl|Item/cargo/tattoos/attach}}
|-
| [[Special:CargoTables/vendor_rewards|vendor_rewards]]
| {{tl|Item/cargo/vendor rewards/declare}}
| {{tl|Item/cargo/vendor rewards/attach}}
|-
| [[Special:CargoTables/weapons|weapons]]
| {{tl|Item/cargo/weapons/declare}}
| {{tl|Item/cargo/weapons/attach}}
|}

==See also==
* [[Template:Item link]]
* [[Template:Skill]]

{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Data templates]]
[[Category:Item templates]]
[[de:Vorlage:Item]]
}}