Template:Item table/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>OmegaK2
>OmegaK2
Line 192: Line 192:
It is possible to directly query any [[stat]]s on the item. The stats are an aggregate from all modifiers on the item (this means it will include implicit values).  
It is possible to directly query any [[stat]]s 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.
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:
The following prefixes are used:

Revision as of 00:27, 4 October 2016

This subpage provides documentation for Template:Item table.

Lua logo

This template uses the following modules:

Overview

This template creates an advanced list for items based on performing an smw:Semantic MediaWiki query.

Specialized Templates

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

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
large bool Whether to show large inventory icons

Default: No

No
q_<param> It is possible to add any parameters of the ask query by prefixing them with q_.

Please note that those may be overridden internally, since this is required for the template to function.

For example, if you want the results to be sorted by Property:Has name and Property:Has level requirement you could append

q_sort=Has name, Has level requirement
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
base_item Shows the base item (i.e. of an unique item) 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
weapon Shows various weapon base stats:
  • damage dealt by the weapon (including local added elemental/chaos damage)
  • attack speed
  • critical strike chance
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
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
buff_icon Shows the buff icon associated with the item's buff No
jewel_radius Show the radius of a jewel Yes

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>_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

Query Templates

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