Template:Item/Effects

Documentation The documentation below is transcluded from Template:Item/Effects/doc.

purge

Description

This is used for parsing for the Effects field in Template:Item.

If you want the syntax for other pages, it is:

{{Item/Effects|effect name|potency on the api|duration in ticks}}

The rest of this doc will help guide you to help add new entries onto the list.

Use the data on the API.

Syntax

If the potion is +xx% <effect name> or -xx% <effect name>, such as Speed:

|<effect name lowercase>|<effect name on the API>={{+%|{{{2}}}}} <Effect Name Uppercase> {{TickConverter|{{{3}}}}} [[Category:Consumable Items with <Effect Name Uppercase>]]

Example:

|speed={{+%|{{{2}}}}} Speed {{TickConverter|{{{3}}}}} [[Category:Consumable Items with Speed]]

If the potion is xx% <effect name> or -xx% <effect name>, such as Instant Health:

|<effect name lowercase>|<effect name on the API>={{%|{{{2}}}}} <Effect Name Uppercase> [[Category:Consumable Items with <Effect Name Uppercase>]]

Example:

|instant health|InstantHealthPercent={{%|{{{2}}}}} Instant Health [[Category:Consumable Items with Instant Health]]

If the potion is <effect name> xx, such as Regeneration:

|<effect name lowercase>|<effect name on the API>=<Effect Name Uppercase> {{{2}}} {{TickConverter|{{{3}}}}} [[Category:Consumable Items with <Effect Name Uppercase>]]

Example:

|regeneration=Regeneration {{{2}}} {{TickConverter|{{{3}}}}} [[Category:Consumable Items with Regeneration]]

If the potion is a negative version of a positive one, and appears as the positive one, such as MeleeVulnerability:

|<effect name on the API>={{#expr: -{{{2|}}} * 100}}% <Opposite Effect Name Uppercase> {{TickConverter|{{{3}}}}} [[Category:Consumable Items with <Effect Name Uppercase>]]

Example:

|MeleeVulnerability={{#expr: -{{{2|}}} * 100}}% Melee Resistance {{TickConverter|{{{3}}}}} [[Category:Consumable Items with Melee Resistance]]

The important change here is:

{{#expr: -{{{2|}}} * 100}}

It is needed in order to display potion potency accurately.

Notes

• When adding new entries, please keep them all above this entry:

|{{{2}}}}} {{{1}}} ({{{3}}}) [[Category:Consumable Items with Effect Template Errors]]

• For certain effects like Water Breathing, where the potency does not show up, you may omit the {{{2}}}. Beware that other potions may have a higher potency, in which it must be left in to ensure compatibility. In these situations, leave the potency blank on the individual page, like so:

{{Item/Effects|effect name||duration}}