View source for Template:Modifier link/doc

{{Documentation subpage}}

{{Lua|Module:Modifier link}}
{{Template shortcut|Ml}}

The '''{{BASEPAGENAME}}''' template is used to show mod names and stat text in short and concise way. Mainly to be used in the main text. 

==Overview==
The template will do the following:
* Query modifier. If results are more than 1, it returns an error that suggests which mod id to use.
* Format the result in a familiar way.

Consider using {{tlx|Modifier table}} instead if you want to create large tables.

==Parameters==
All parameters should be filled in if possible to ensure it's working correctly. 

{| class="wikitable"
! Parameter 
! Description 
! Optional
|-
|'''id'''
| Modifier id or modid (<code>mods.id</code>). Defaults to first unnamed input, <nowiki>{{{1}}}</nowiki>. 
Even though the modifier id is the required input it will search through the following cargo fields:
# <code>mods.name</code>
# <code>mods.id</code>
# <code>mods.stat_text</code>
# <code>mods.stat_text_raw</code>
This simplifies finding the correct modifier considerably, since the lua error will display the mods the query found and the correct modifier id in an easy copy/paste way.
| {{no}}
|-
|'''statid'''
| Stat id. Required when querying for exact values instead of stat text. 
Searches <code>mod_stats.id</code> that are on the same page as the modifier id.
| {{yes}}
|-
|'''display'''
| Display formats. Choose between:
* abbr - Abbreviated stat text. (Default)
* id - Show the modifier id.
* verbose - Show both modifier name and stat text.
* stat_text - Show only stat text.
* min - Minimum value for a stat. Requires <code>statid</code> to be defined.
* max - Maximum value for a stat. Requires <code>statid</code> to be defined.
| {{yes}}
|}

==Examples==
{| class="wikitable sortable"
|-
! Code !! Result 
|-
| <pre>{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
}}</pre> || {{Modifier link|LocalIncreasedPhysicalDamagePercentAndAccuracyRating8}}
|-
| <pre> 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=id
}} 
</pre>|| {{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=id
}}
|-
| <pre> 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=verbose
}} 
</pre>|| {{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=verbose
}}
|-
| <pre> 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=stat_text
}} 
</pre>|| {{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=stat_text
}}
|-
| <pre> 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=min
 |statid=local_physical_damage_+%
}} 
</pre>|| {{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=min
 |statid=local_physical_damage_+%
}}
|-
| <pre> 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=max
 |statid=local_physical_damage_+%
}} 
</pre>|| {{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=max
 |statid=local_physical_damage_+%
}}
|}

==Maintenance==
When this template returns errors the page will show up in following categories:
* [[:Category:Pages with modifier link errors]]
* [[:Category:Pages with script errors]]

{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Link formatting templates]]
[[Category:Query templates]]
{{Sister|poewiki}}
}}