Template:Item table/doc: Difference between revisions
>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 | 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]] | ||
== | ==Parameters== | ||
===Main Parameters=== | |||
{| 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}} | |||
|} | |||
< | It is possible to add any parameters of the ask query by prefixing them with <code>q_</code>. | ||
</ | |||
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 | ||
<pre>q_sort=Has name, Has level requirement</pre> | |||
===Display control parameters=== | |||
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 | ||
! 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 | ||
| the level requirement of the item | | the level requirement of the item | ||
| {{yes}} | |||
|- | |- | ||
| str | | str | ||
| the [[strength]] requirement of the item | | the [[strength]] requirement of the item | ||
| {{yes}} | |||
|- | |- | ||
| int | | int | ||
| the [[intelligence]] requirement of the item | | the [[intelligence]] requirement of the item | ||
| {{yes}} | |||
|- | |- | ||
| dex | | dex | ||
| 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 | ||
| 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: | * [[Template:Query base item]] | ||
* [[Template: | * [[Template:Query base armour]] | ||
* [[Template: | * [[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.
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 | |
large | bool | Whether to show large inventory icons
Default: 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 | |
drop_level | Shows the drop level of the item | |
stack_size | Show the maximum stack size (not in currency tab) | |
stack_size_currency_tab | Show the maximum stack size in the currency tab | |
level | the level requirement of the item | |
str | the strength requirement of the item | |
int | the intelligence requirement of the item | |
dex | the dexterity requirement of the item | |
ar | Shows how much armour the item provides | |
ev | Shows how much evasion the item provides | |
es | Shows how much energy shield the item provides | |
block | Shows how much block the item provides | |
weapon | Shows various weapon base stats:
|
|
flask_life | Shows how much life the flask recovers per use | |
flask_mana | Shows how much mana the flask recovers per use | |
flask | Shows various generic flask properties:
|
|
buff | Shows the effect of the buffs granted by the item (generally applicable to Utility Flasks) | |
physical_dps | Shows physical damage per second | |
fire_dps | Shows fire damage per second | |
cold_dps | Shows cold damage per second | |
lightning_dps | Shows lightning damage per second | |
chaos_dps | Shows chaos damage per second | |
elemental_dps | Shows the combined elemental damage per second (i.e. fire damage, cold damage and lightning damage) | |
poison_dps | Shows the combined damage that can apply to poison (i.e. physical damage and chaos damage) | |
dps | Shows the total combined damage per second (i.e. physical damage, fire damage, cold damage, lightning damage and chaos damage) | |
stat | the complete stat text of the item (both implicit and explicit stats derived from mods) in a single column | |
description | Shows the description text of the item | |
flavour_text | Shows the flavour text of the item | |
help_text | Shows the help_text of the item | |
buff_icon | Shows the buff icon associated with the item's buff |
Query Templates
There are also several query templates based on this template in order to use query duplication:
- Template:Query base item
- Template:Query base armour
- Template:Query unique items
- Template:Query unique armours