Template:Gem table/doc: Difference between revisions
>Illviljan mNo edit summary |
No edit summary |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Documentation subpage}} | ||
{{Lua|Module:Item table}} | |||
This template | This template performs a [[mw:Extension:Cargo/Querying data|Cargo query]] for [[gem]]s and returns the results as a formatted table. | ||
===Query | ==Parameters== | ||
===Query parameters=== | |||
These parameters are used to construct the Cargo query. For more information about how these parameters should be used, see [[mw:Extension:Cargo/Querying data|Extension:Cargo/Querying data]]. | |||
{| class="wikitable sortable" | |||
! Parameter | |||
! Value | |||
! Description | |||
! Required | |||
|- | |||
| where | |||
| str | |||
| The conditions that must be met for items to appear in the table. This is the main portion of the WHERE clause in the query. | |||
| {{yes}} | |||
|- | |||
| tables | |||
| list[str] | |||
| A comma-separated list of any additional Cargo tables to select from, apart from those that are required based on the {{section link||Column display parameters}}. This corresponds to the FROM clause in the query. | |||
| {{no}} | |||
|- | |||
| join | |||
| list[str] | |||
| Specifies how the rows are combined from any additional Cargo tables given by <code><nowiki>|tables=</nowiki></code>. This corresponds to JOIN clauses in the query. | |||
| {{no}} | |||
|- | |||
| orderBy | |||
| list[str] | |||
| Fields to sort the results by, and in which order. This corresponds to the ORDER BY clause in the query. | |||
| {{no}} | |||
|- | |||
| limit | |||
| int | |||
| The maximum number of rows to return. This corresponds to the LIMIT clause in the query. | |||
| {{no}} | |||
|- | |||
| groupBy | |||
| list[str] | |||
| Additional fields to group rows by, secondary to <code>items._pageID</code>. This corresponds to the GROUP BY clause in the query. | |||
| {{no}} | |||
|- | |||
| having | |||
| list[str] | |||
| The conditions that must be met when grouping rows. This corresponds to the HAVING clause in the query. | |||
| {{no}} | |||
|} | |||
== | ===Table display parameters=== | ||
{| class="wikitable sortable" | |||
{{ | ! Parameter | ||
! Value | |||
! Description | |||
! Required | |||
|- | |||
| 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}} | |||
|- | |||
| responsive | |||
| bool | |||
| Whether to collapse the table so that it takes up less space. Individual users have the option to turn this behavior off in their user preferences. | |||
Default: No | |||
| {{no}} | |||
|- | |||
| no_html | |||
| bool | |||
| 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}} | |||
|} | |||
===Column display 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" | 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" | ||
Line 109: | Line 173: | ||
|} | |} | ||
==See also== | |||
<!-- | {{Item table templates}} | ||
{{Documentation categories| | |||
<!-- Categories and interwikis go here. --> | |||
[[Category:Item table templates]] | |||
[[Category:Query templates]] | [[Category:Query templates]] | ||
{{Sister|poewiki}} | |||
}} |
Latest revision as of 02:54, 27 October 2024
This subpage provides documentation for Template:Gem table.
This template performs a Cargo query for gems and returns the results as a formatted table.
Parameters
Query parameters
These parameters are used to construct the Cargo query. For more information about how these parameters should be used, see Extension:Cargo/Querying data.
Parameter | Value | Description | Required |
---|---|---|---|
where | str | The conditions that must be met for items to appear in the table. This is the main portion of the WHERE clause in the query. | |
tables | list[str] | A comma-separated list of any additional Cargo tables to select from, apart from those that are required based on the § Column display parameters. This corresponds to the FROM clause in the query. | |
join | list[str] | Specifies how the rows are combined from any additional Cargo tables given by |tables= . This corresponds to JOIN clauses in the query.
|
|
orderBy | list[str] | Fields to sort the results by, and in which order. This corresponds to the ORDER BY clause in the query. | |
limit | int | The maximum number of rows to return. This corresponds to the LIMIT clause in the query. | |
groupBy | list[str] | Additional fields to group rows by, secondary to items._pageID . This corresponds to the GROUP BY clause in the query.
|
|
having | list[str] | The conditions that must be met when grouping rows. This corresponds to the HAVING clause in the query. |
Table display parameters
Parameter | Value | Description | Required |
---|---|---|---|
default | str | If specified, the value of this will be returned of there are no results for the specified query. | |
large | bool | Whether to show large inventory icons
Default: No |
|
responsive | bool | Whether to collapse the table so that it takes up less space. Individual users have the option to turn this behavior off in their user preferences.
Default: No |
|
no_html | bool | 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. |
Column display 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 | Corresponding Properties |
Description |
---|---|---|
icon | skill_gems.support_gem_letter_html | Support gem icon/letter shown when support gem is linked to an active skill |
skill_icon | skill.skill_icon | Skill icon of an active skill (the icon in the skill bar, not the inventory icon) |
stat_text | skill.stat_text | Stat text of the skill |
quality_stat_text | skill.quality_stat_text | Quality stat text of the skill (stats per 1% quality) |
description | skill.description | Description text of the skill |
level | items.required_level | the level requirement of the item |
str | skill_gems.strength_percent | the strength requirement of the item |
int | skill_gems.intelligence_percent | the intelligence requirement of the item |
dex | skill_gems.dexterity_percent | the dexterity requirement of the item |
crit | skill_levels.critical_strike_chance | Critical strike chance |
cast_time | skill.cast_time | Cast time in seconds |
aspd, attack_speed, attack_speed_multiplier | skill_levels.attack_speed_multiplier | Attack speed multiplier of the gem |
dmgeff | skill_levels.damage_effectiveness | Damage effectiveness in percent |
mcm | skill_levels.mana_multiplier | mana cost multiplier in percent |
mana | skill_levels.mana_cost
skill.has_percentage_mana_cost skill.has_reservation_mana_cost |
Mana cost of the skill.
Will also show whether the skill reserves mana or uses a percentage rather then just flat mana costs. |
vaal | skill_levels.vaal_souls_requirement
skill_levels.vaal_stored_uses |
The base number of vaal souls required and how many skill uses can be stored for a vaal skill |
radius | skill.radius
skill.radius_description skill.radius_secondary skill.radius_secondary_description skill.radius_tertiary skill.radius_tertiary_description |
Radius information for primary/secondary/tertiary radius and description of what that radius applies to as hovertext |
See also