Template:Modifier link/doc

From Path of Exile 2 Wiki
Revision as of 18:36, 20 October 2024 by Vinifera7 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This subpage provides documentation for Template:Modifier link.

Lua logo

This template uses the following modules:

Shortcut

The Modifier link 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 {{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.

Parameter Description Optional
id Modifier id or modid (mods.id). Defaults to first unnamed input, {{{1}}}.

Even though the modifier id is the required input it will search through the following cargo fields:

  1. mods.name
  2. mods.id
  3. mods.stat_text
  4. mods.stat_text_raw

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 mod_stats.id 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 statid to be defined.
  • max - Maximum value for a stat. Requires statid to be defined.
Yes

Examples

Code Result
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
}}
Module Error: No results found.
 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=id
}} 
Module Error: No results found.
 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=verbose
}} 
Module Error: No results found.
 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=stat_text
}} 
Module Error: No results found.
 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=min
 |statid=local_physical_damage_+%
}} 
Module Error: No results found.
 
{{Modifier link
 |LocalIncreasedPhysicalDamagePercentAndAccuracyRating8
 |display=max
 |statid=local_physical_damage_+%
}} 
Module Error: No results found.

Maintenance

When this template returns errors the page will show up in following categories: