Template:Item table/doc

From Path of Exile 2 Wiki
Revision as of 00:29, 1 August 2018 by >Illviljan (→‎Parameters: added quest_name, quest_act and quest parameters.)
Jump to navigation Jump to search

This subpage provides documentation for Template:Item table.

Lua logo

This template uses the following modules:

Overview

This template creates an advanced list for modifiers based on performing an cargo query.

Specialized Templates

There are also specialized sub templates for the following item types available:

Query Templates

There are also several query templates based on this template in order to reduce query duplication:

Parameters

Main Parameters

Parameter Value Description Required
conditions str The ask query string to use. Only the query string is required here, the properties that will be selected and well as any other parameters normally found on an ask query are added by the item module.

For info on how to write queries, consult Semantic MediaWiki, in particular Help:Selecting pages.

Yes
default str If specified, the value of this will be returned of there are no results for the specified query. No
large bool Whether to show large inventory icons

Default: No

No
q_<param> It is possible to add any parameters of the cargo query (field names) by prefixing them with q_.

Specifying at least q_where and q_limit is highly recommended. q_limit is restricted to a maximum of 300.

Additional tables can be specified using q_tables.

No

Display control parameters

All these parameters are binary, so as long you specify something like icon=1 it will show up. If something is not available on the item you're fetching it will show up as "N/A"

Parameter Description Local
no_html Don't show HTML infoboxes on hover.

Advisable to enable this on very large lists, as it makes the resulting table much smaller. In particular if the page hits the wiki limits for size.

No
base_item Shows the base item (i.e. of an unique item) No
class Show the item class No
essence Shows the essence tier No
drop_level Shows the drop level of the item No
stack_size Show the maximum stack size (not in currency tab) No
stack_size_currency_tab Show the maximum stack size in the currency tab No
level the level requirement of the item Yes
str the strength requirement of the item Yes
int the intelligence requirement of the item Yes
dex the dexterity requirement of the item Yes
ar Shows how much armour the item provides Yes
ev Shows how much evasion the item provides Yes
es Shows how much energy shield the item provides Yes
block Shows how much block the item provides Yes
damage Shows the damage values of a weapon. This includes any added elemental or chaos damage in the appropriate colour(s). Yes
aps Shows the attacks per second value of a weapon. Yes
crit Shows the local critical strike chance of a weapon. Yes
flask_life Shows how much life the flask recovers per use Yes
flask_mana Shows how much mana the flask recovers per use Yes
flask Shows various generic flask properties:
  • Duration of the flask
  • How many flask charges are consumed per single use
  • Maximum number of flask charges held
Yes
buff Shows the effect of the buffs granted by the item (generally applicable to Utility Flasks) No
physical_dps Shows physical damage per second Yes
fire_dps Shows fire damage per second Yes
cold_dps Shows cold damage per second Yes
lightning_dps Shows lightning damage per second Yes
chaos_dps Shows chaos damage per second Yes
elemental_dps Shows the combined elemental damage per second (i.e. fire damage, cold damage and lightning damage) Yes
poison_dps Shows the combined damage that can apply to poison (i.e. physical damage and chaos damage) Yes
dps Shows the total combined damage per second (i.e. physical damage, fire damage, cold damage, lightning damage and chaos damage) Yes
stat the complete stat text of the item (both implicit and explicit stats derived from mods) in a single column No
item_limit Shows the item limit of an item No
jewel_radius Show the radius of a jewel Yes
map_tier Show the map tier Yes
map_level Show the map level Yes
map_guild_character Show the character a map produces for a guild tag No
master_level_requirement Shows the required level of the forsaken master in order to purchase the doodad No
master Shows the forsaken master name where the doodad can be purchased at No
master_favour_cost Shows the how much favour the doodad costs when purchased at a forsaken master No
variations Shows the number of possible variations of the doodad No
description Shows the description text of the item No
flavour_text Shows the flavour text of the item No
help_text Shows the help_text of the item No
objective Shows the objective section from a prophecy page crated with {{Prophecy description}} No
reward Shows the reward section from a prophecy page crated with {{Prophecy description}} No
seal_cost Shows the seal cost of a prophecy No
prediction_text Shows the prediction text of a prophecy No
buff_icon Shows the buff icon associated with the item's buff No
drop_enabled Shows whether the item is considered drop_enabled and can be normally obtained No
drop_leagues Shows which leagues the item can be obtained in No
drop_areas Shows which areas the item can be obtained in No
drop_text Shows drop restriction information that doesn't fit into other categories No
quest_name Shows quest names that the item can be obtained from. No
quest_act Shows which act the quest can be found in. No

Multi-option parameters

These parameters will active multiple options at once. They should be used for "default" lists, as additional variables may be added over time:

Parameter Description Parameters activated
weapon Show weapon information.
  • damage
  • aps
  • crit
prophecy Show prophecy information.
  • prediction_text
  • seal_cost
drop Show information related on how an item is obtained.
  • drop_level
  • drop_enabled
  • drop_leagues
  • drop_areas
  • drop_text
doodad Enables all options relevant to hideout doodads.
  • master_level_requirement
  • master
  • master_favour_cost
  • variation_count
quest Enables all options relevant to quests.
  • quest_name
  • quest_act

Stat parameters

It is possible to directly query any stats on the item. The stats are an aggregate from all modifiers on the item (this means it will include implicit values).

Queried stats are sorted into columns, and a column can hold any arbitrary number of stats (but at least one) and there can be any number of columns.

The columns will be sorted by the average value of the stat. If multiple stats are specified for a single column, this is the average of all individual stat averages.

The following prefixes are used:

  • Columns: stat_column<i>_
  • Stat: stat<j>_

<i> and <j> need to be replaced with the number starting at 1.

Parameter Value Description Required
stat_column<i>_header str Header to use in table for the stat.

If left empty, the id of stat will be used

No
stat_column<i>_format str Lua string.format specifier. Note that the number of formatter must match the number of stats for the specific column or an error will be raised.

If left empty, all result will simply be shown in a comma-separated list.

No
stat_column<i>_stat_format str Acceptable values:
  • separate - separate entries using comma separation for the specified format
  • add - add up all the acceptable stats into a single value; uses 0 if not available
No
stat_column<i>_order int Ordering priority for showing this column.

Defaults to a very high value.

No
stat_column<i>_stat<j>_id str Identifier of the stat.

If you are not sure what this is, consider checking the sub objects created on items - it will be stored in Property:Has stat id

Yes

Examples

Show item limit

{{Item table
|q_where=items._pageName="Self-Flagellation"
|large=1
|stat=1
|item_limit=1
}}

Yields:

ItemStats

Show possible "Maximum Life" rolls on unique items with at least +100 life

{{Item table
|q_tables=item_stats
|q_join=items._pageID=item_stats._pageID
|q_where=items.rarity="Unique" AND item_stats.id="base_maximum_life" AND item_stats.min > 100
|large=1
|level=1
|stat=1
|stat_column1_header=Life
|stat_column1_format=+%s to maximum Life
|stat_column1_stat1_id=base_maximum_life
}}

Yields:

ItemRequired levelStatsLife