Template:Passive skill link/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>Illviljan
mNo edit summary
>Vinifera7
mNo edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{lua|Module:Passive skill}}
 
{{Lua|Module:Passive skill link}}
{{Template shortcut|Psl}}


==Overview==
==Overview==
Line 8: Line 10:


==Parameters==
==Parameters==
===Mutually-exclusive parameters===
===Passive skill selection===
 
One of these is required. Do not specify more than one.
{| class="wikitable sortable"
{| class="wikitable sortable"
! Parameter  
! Parameter  
Line 15: Line 17:
! Description
! Description
|-
|-
| name
| id
| str
| Id of the passive skill
|-
| passive_name
| str
| str
| Name of the passive skill
| Name of the passive skill
|-
|-
| id
| page
| str
| Name of the wiki page to link against
|-
| q_where
| str
| str
| Id of the passive skill
| Id of the passive skill
|}
|}
===Other parameters===
 
===Output overrides===
All of these are optional and can be used to customize the passive skill link.
{| class="wikitable sortable"
{| class="wikitable sortable"
! Parameter  
! Parameter  
! Value
! Value
! Description
! Description
! Required
|-
| name
| str
| This parameter can be used to specify different link text than the passive skill name. This should be used mainly for grammatical purposes. If the link text is significantly different to the passive skill name, consider using a normal wikilink instead of this template.
|-
| large
| boolean
| If set to true, instead of the small icon in front of the name, a large inventory icon will be shown below the passive skill (suitable for tables).
|-
|-
| format
| format
Line 35: Line 54:
* tablerow: returns the image and stat text for use in a wikitable (2 cells). Will not work with HTML tables.
* tablerow: returns the image and stat text for use in a wikitable (2 cells). Will not work with HTML tables.
* nil: default behavior
* nil: default behavior
|{{no}}
|-
| skip_query
| boolean
| Skip querying for the passive skill.
|-
| icon
| str
| File to use for the inline icon link.
|-
| html
| str
| HTML to use for the infobox.
May also be used to hide the infobox entirely.
 
|}
|}


==Example==
==Examples==
<pre>{{passive skill link|name=Acrobatics}}</pre>
===Default===
<pre>{{passive skill link|Acrobatics}}</pre>
yields:
{{passive skill link|Acrobatics}}
 
===tablerow===
<pre>
{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|Acrobatics|format=tablerow}}
|}
</pre>
yields:
yields:
{{passive skill link|name=Acrobatics}}
{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|Acrobatics|format=tablerow}}
|}
 
===Integer Id===
<pre>
{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|q_where = passive_skills.int_id=54307|format=tablerow}}
|}
</pre>
 
yields:
{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|q_where = passive_skills.int_id=54307|format=tablerow}}
|}


<includeonly>
{{Documentation categories|
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<!-- Categories and interwikis go here. -->
[[Category:Query templates]]
[[Category:Query templates]]
[[Category:Passive templates]]
[[Category:Passive templates]]
</includeonly>
}}

Latest revision as of 11:32, 3 December 2020

This subpage provides documentation for Template:Passive skill link.

Lua logo

This template uses the following modules:

Shortcut

Overview

This template creates links to passive skills based on performing an cargo query.

Only one result will be returned at a time and if more then one are found an error will be shown.

Parameters

Passive skill selection

One of these is required. Do not specify more than one.

Parameter Value Description
id str Id of the passive skill
passive_name str Name of the passive skill
page str Name of the wiki page to link against
q_where str Id of the passive skill

Output overrides

All of these are optional and can be used to customize the passive skill link.

Parameter Value Description
name str This parameter can be used to specify different link text than the passive skill name. This should be used mainly for grammatical purposes. If the link text is significantly different to the passive skill name, consider using a normal wikilink instead of this template.
large boolean If set to true, instead of the small icon in front of the name, a large inventory icon will be shown below the passive skill (suitable for tables).
format str Can be any of the following
  • tablerow: returns the image and stat text for use in a wikitable (2 cells). Will not work with HTML tables.
  • nil: default behavior
skip_query boolean Skip querying for the passive skill.
icon str File to use for the inline icon link.
html str HTML to use for the infobox.

May also be used to hide the infobox entirely.

Examples

Default

{{passive skill link|Acrobatics}}

yields: Acrobatics

tablerow

{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|Acrobatics|format=tablerow}}
|}

yields:

Name Stat text
Acrobatics Modifiers to Chance to Suppress Spell Damage instead apply to Chance to Dodge Spell Hits at 50% of their value
Maximum Chance to Dodge Spell Hits is 75%

Integer Id

{| class="wikitable"
|-
! Name
! Stat text
|-
{{passive skill link|q_where = passive_skills.int_id=54307|format=tablerow}}
|}

yields:

Name Stat text
Acrobatics Modifiers to Chance to Suppress Spell Damage instead apply to Chance to Dodge Spell Hits at 50% of their value
Maximum Chance to Dodge Spell Hits is 75%


Retrieved from "https://www.poewiki.net/index.php?title=Template:Passive_skill_link/doc&oldid=436732"