Template:Item table/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>OmegaK2
No edit summary
>OmegaK2
(Updated with all the new options and to reflect the changes to the underlying module)
Line 5: Line 5:
==Overview==
==Overview==


This template creates an advanced list for [[item]]s and is intended to be used in SMW queries.
This template creates an advanced list for [[item]]s based on performing an [[smw:Semantic MediaWiki]] query.  


===Specialized Templates===
===Specialized Templates===
Line 12: Line 12:
* [[skill gems]] - [[Template:SMW item table/skill gem]]
* [[skill gems]] - [[Template:SMW item table/skill gem]]


==Usage==
==Parameters==


In SMW ask queries, specify the following:
===Main Parameters===
<pre>
|?Has name
|?Has inventory icon
|?Has infobox HTML
|link=none
|format=template
|introtemplate=SMW item table/intro
|template=SMW item table
|outrotemplate=SMW item table/outro
|named args=yes
</pre>


Each of the name, inventory icon or HTML parameters can be omitted to build a shorted listed. For instance:
{| class="wikitable sortable"
! Parameter
! Value
! Description
! Required
|-
| conditions
| str
| The ask query string to use
| {{yes}}
|-
| large
| bool
| Whether to show large inventory icons
Default: No
| {{no}}
|}


<pre>
It is possible to add any parameters of the ask query by prefixing them with <code>q_</code>.
|?Has name
|link=none
|format=template
|template=SMW item table
|named args=yes
</pre>


Will only produce a link against the pages without the infobox and icon.
Please note that those may be overridden internally, since this is required for the template to function.


==Parameters==
For example, if you want the results to be sorted by [[Property:Has name]] and [[Property:Has level requirement]] you could append
{{userparam info}}
<pre>q_sort=Has name, Has level requirement</pre>


All these parameters are binary, so as long you specify something like <code>icon=yes</code> it will show up.
===Display control parameters===


It is also '''required''' to specify the applicable properties in the query or it will show up as <code>N/A</code>
All these parameters are binary, so as long you specify something like <code>icon=1</code> it will show up. If something is not available on the item you're fetching it will show up as "N/A"


{| class="wikitable sortable"
{| class="wikitable sortable"
! Parameter  
! Parameter  
! Corresponding<br>Properties
! Description
! Description
! {{abbr|Local|This means this option will only consider 'local' increases}}
|-
| 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
| level
| [[Property:Has level requirement]]
| the level requirement of the item
| the level requirement of the item
| {{yes}}
|-
|-
| str
| str
| [[Property:Has strength percentage]]
| the [[strength]] requirement of the item
| the [[strength]] requirement of the item
| {{yes}}
|-  
|-  
| int
| int
| [[Property:Has intelligence percentage]]
| the [[intelligence]] requirement of the item
| the [[intelligence]] requirement of the item
| {{yes}}
|-  
|-  
| dex
| dex
| [[Property:Has dexterity percentage]]
| the [[dexterity]] requirement of the item
| 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
| stat
| [[Property:Has stat text]]
| the complete stat text of the item (both implicit and explicit [[stat]]s derived from [[mod]]s) in a single column
| the complete stat text of the item (both implicit and explicit [[stat]]s derived from [[mod]]s) in a single column
| {{no}}
|-
| description
| Shows the {{c|mod|description text}} of the item
| {{no}}
|-
| flavour_text
| Shows the {{c|flavour|flavour text}} of the item
| {{no}}
|-
| help_text
| Shows the {{c|help|help_text}} of the item
| {{no}}
|-
| buff_icon
| Shows the buff icon associated with the item's buff
| {{no}}
|}
|}


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


* [[Template:SMW currency query]]
* [[Template:Query base item]]
* [[Template:SMW base weapon query]]
* [[Template:Query base armour]]
* [[Template:SMW base armour query]]
* [[Template:Query unique items]]
* [[Template:Query unique armours]]


<includeonly>
<includeonly>

Revision as of 06:47, 29 September 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 Yes
large bool Whether to show large inventory icons

Default: No

No

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

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

Query Templates

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