Template:Item/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
m (category)
No edit summary
Line 3: Line 3:
{{intricate template}}
{{intricate template}}


{{tlx|Item}} is used on item pages to show the item's infobox. This setup also allows an item pages' data to be transcluded on other pages and formatted in various ways such as in a table. See [[Template:Item/testcases|testcases]] for examples.
The '''item''' template is used on item pages to show the item's infobox. This setup also allows an item pages' data to be transcluded on other pages and formatted in various ways such as in a table. See [[Template:Item/testcases|testcases]] for examples.


==Parameters==
==Parameters==
All parameters except for <code>Name</code> are optional. They can be excluded or left blank.
All parameters except for '''Name''' are optional. They can be excluded or left blank.


{| class="wikitable"
{| class="wikitable"
! Parameter !! Description
! Parameter !! Description
|-
|-
| <code>Name</code> || Name of the item
| '''Name''' || Name of the item
|-
|-
| <code>PageName</code> || Name of the item's wiki page, if different than <code>Name</code>
| '''PageName''' || Name of the item's wiki page&nbsp;– Defaults to <code>'''Name'''</code>
|-
|-
| <code>Image</code> || File name of the item graphic&nbsp;– Defaults to <code>{{{Name}}}.png</code>
| '''Image''' || File name of the item graphic&nbsp;– Defaults to <code>'''PageName'''.png</code>
|-
|-
| <code>Size</code> || Size of the item in grid units&nbsp;– Possible values are, but not limited to: <code>1x1</code>, <code>2x2</code>, and <code>2x4</code>. Defaults to a "best guess" based on the item's type, subtype, and requirements.
| '''Size''' || Size of the item in grid units&nbsp;– Possible values are, but not limited to: <code>1x1</code>, <code>2x2</code>, and <code>2x4</code>. Defaults to a "best guess" based on the item's type, subtype, and requirements.
|-
|-
| <code>Rarity</code> || Rarity of the item&nbsp;– This only applies to weapons, armour, accessories, flasks, and maps. Possible values are: <code>Normal</code>, <code>Magic</code>, <code>Rare</code>, and <code>Unique</code>. Defaults to <code>Normal</code>.
| '''Rarity''' || Rarity of the item&nbsp;– This only applies to weapons, armour, accessories, flasks, and maps. Possible values are: <code>Normal</code>, <code>Magic</code>, <code>Rare</code>, and <code>Unique</code>. Defaults to <code>Normal</code>.
|-
|-
| <code>Type</code> || Type of the item, for formatting purposes&nbsp;– Possible values are: <code>Weapon</code>, <code>Armour</code>, <code>Accessory</code>, <code>Flask</code>, <code>Map</code>, <code>Currency</code>, and <code>Quest</code>.
| '''Type''' || Type of the item, for formatting purposes&nbsp;– Possible values are: <code>Weapon</code>, <code>Armour</code>, <code>Accessory</code>, <code>Flask</code>, <code>Map</code>, <code>Currency</code>, and <code>Quest</code>.
|-
|-
| <code>Subtype</code> || Subtype of the item&nbsp;– Possible values are, but not limited to: <code>Axe</code>, <code>Staff</code>, <code>Gloves</code>, <code>Body Armour</code>, and <code>Ring</code>.
| '''Subtype''' || Subtype of the item&nbsp;– Possible values are, but not limited to: <code>Axe</code>, <code>Staff</code>, <code>Gloves</code>, <code>Body Armour</code>, and <code>Ring</code>.
|-
|-
| <code>BaseItem</code> || Base item page name, for rares and uniques
| '''BaseItem''' || Base item page name, for rares and uniques
|-
|-
| <code>RequiredLevel</code> || Level requirement of the item
| '''RequiredLevel''' || Level requirement of the item
|-
|-
| <code>RequiredStrength</code> || Strength requirement of the item
| '''RequiredStrength''' || Strength requirement of the item
|-
|-
| <code>RequiredDexterity</code> || Dexterity requirement of the item
| '''RequiredDexterity''' || Dexterity requirement of the item
|-
|-
| <code>RequiredIntelligence</code> || Intelligence requirement of the item
| '''RequiredIntelligence''' || Intelligence requirement of the item
|-
|-
| <code>PhysicalDamage</code> || Physical damage of the weapon
| '''PhysicalDamage''' || Physical damage of the weapon
|-
|-
| <code>FireDamage</code> || Fire damage of the weapon
| '''FireDamage''' || Fire damage of the weapon
|-
|-
| <code>ColdDamage</code> || Cold damage of the weapon
| '''ColdDamage''' || Cold damage of the weapon
|-
|-
| <code>LightningDamage</code> || Lightning damage of the weapon
| '''LightningDamage''' || Lightning damage of the weapon
|-
|-
| <code>ChaosDamage</code> || Chaos damage of the weapon
| '''ChaosDamage''' || Chaos damage of the weapon
|-
|-
| <code>CriticalStrikeChance</code> || Critical strike chance of the weapon
| '''AverageDamage''' || Override for normal average damage calculation; used for weapons such as [[Dyadus]]
|-
|-
| <code>AttacksPerSecond</code> || Attacks per second of the weapon
| '''CriticalStrikeChance''' || Critical strike chance of the weapon
|-
|-
| <code>Armour</code> || Armour rating of the armour item
| '''AttacksPerSecond''' || Attacks per second of the weapon
|-
|-
| <code>Evasion</code> || Evasion rating of the armour item
| '''Armour''' || Armour rating of the armour item
|-
|-
| <code>EnergyShield</code> || Energy shield of the armour item
| '''Evasion''' || Evasion rating of the armour item
|-
|-
| <code>Block</code> || Block chance of the shield
| '''EnergyShield''' || Energy shield of the armour item
|-
|-
| <code>MapLevel</code> || Map level of the map item
| '''Block''' || Block chance of the shield
|-
|-
| <code>ItemQuantity</code> || Item quantity modifier of the map item
| '''MapLevel''' || Map level of the map item
|-
|-
| <code>StackSize</code> || Maximum stack size of the currency item
| '''ItemQuantity''' || Item quantity modifier of the map item
|-
|-
| <code>CurrencyEffect</code> || Effect of the usable currency item
| '''StackSize''' || Maximum stack size of the currency item
|-
|-
| <code>FlaskLife</code> || Life restoration on use of the flask
| '''Effect''' || Effect of the usable utility flask, currency item, or microtransaction item
|-
|-
| <code>FlaskLifeDuration</code> || Life restoration duration of the flask
| '''FlaskLife''' || Life restoration on use of the flask
|-
|-
| <code>FlaskMana</code> || Mana restoration on use of the flask
| '''FlaskMana''' || Mana restoration on use of the flask
|-
|-
| <code>FlaskManaDuration</code> || Mana restoration duration of the flask
| '''FlaskDuration''' || Life or mana restoration time or utility effect duration of the flask
|-
|-
| <code>FlaskEffect</code> || Effect of the utility flask
| '''FlaskCharges''' || Total "charge" capacity of the flask
|-
|-
| <code>FlaskEffectDuration</code> || Effect duration of the utility flask
| '''FlaskChargesUsed''' || "Charges" consumed on use of the flask
|-
|-
| <code>FlaskCharges</code> || Total "charge" capacity of the flask
| '''ImplicitMods''' || Implicit mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
|-
| <code>FlaskChargesUsed</code> || "Charges" consumed on use of the flask
| '''RandomMods''' || Random mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
|-
| <code>ImplicitMods</code> || Implicit mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
| '''Cosmetic''' || Cosmetic mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
|-
| <code>RandomMods</code> || Random mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
| '''FlavourText''' || Flavour text of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
|-
| <code>Cosmetic</code> || Cosmetic mods of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
| '''HelpText''' || Help text of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
| <code>FlavourText</code> || Flavour text of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
| <code>HelpText</code> || Help text of the item&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|}
|}


==={{anchor|ranges}}Numerical ranges===
===Numerical ranges {{anchor|ranges}}===
There are two types of numerical ranges for items: ''damage ranges'' and ''random value ranges''. See the [[Path_of_Exile_Wiki_talk:Community_portal/Archive_2#Formatting_numerical_ranges_displayed_on_item_data|discussion]] about distinguishing between ranges.
There are two types of numerical ranges for items: ''damage ranges'' and ''random value ranges''. See the [[Path_of_Exile_Wiki_talk:Community_portal/Archive_2#Formatting_numerical_ranges_displayed_on_item_data|discussion]] about distinguishing between ranges.


Line 109: Line 105:


===Weapon===
===Weapon===
<pre><nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
<nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                  = Driftwood Wand
| Name                  = Driftwood Wand
| Size                  = 1x3
| Rarity                = Normal
| Rarity                = Normal
| Type                  = Weapon
| Type                  = Weapon
Line 122: Line 119:
| AttacksPerSecond      = 1.3
| AttacksPerSecond      = 1.3
| ImplicitMods          = (8-12)% increased Spell Damage
| ImplicitMods          = (8-12)% increased Spell Damage
}}&lt;/onlyinclude&gt;
}}&lt;/onlyinclude&gt;</nowiki>
 
 
 
</nowiki></pre>


===Armour===
===Armour===
<pre><nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
<nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                  = Scholar's Robe
| Name                  = Scholar's Robe
| Size                  = 2x4
| Rarity                = Normal
| Rarity                = Normal
| Type                  = Armour
| Type                  = Armour
Line 142: Line 136:
| EnergyShield          = 41
| EnergyShield          = 41
| ImplicitMods          =  
| ImplicitMods          =  
}}&lt;/onlyinclude&gt;
}}&lt;/onlyinclude&gt;</nowiki>
 
 


</nowiki></pre>
===Unique amulet===
 
<nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
===Unique Amulet===
<pre><nowiki>&lt;onlyinclude&gt;{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                  = Araku Tiki
| Name                  = Araku Tiki
| Size                  = 1x1
| Rarity                = Unique
| Rarity                = Unique
| Type                  = Accessory
| Type                  = Accessory
| Subtype                = Amulet
| Subtype                = Amulet
| RequiredLevel          = 18
| RequiredLevel          = 18
| ImplicitMods          = (2.0-4.0) Life Regenerated per second
| ImplicitMods          = (2.0 to 4.0) Life Regenerated per second
| RandomMods            = You gain 100 Evasion Rating when on Low Life : +(30-50) to maximum Life : +(20-30)% to Fire Resistance : 1.0% of Life Regenerated per Second while on Low Life
| RandomMods            = You gain 100 Evasion Rating when on Low Life <br> +(30 to 50) to maximum Life <br> +(20 to 30)% to Fire Resistance <br> 1.0% of Life Regenerated per Second while on Low Life
| FlavourText            = It is said to make you invisible when the Great : Spirit comes to take you on your final journey.
| FlavourText            = It is said to make you invisible when the Great <br> Spirit comes to take you on your final journey.
}}&lt;/onlyinclude&gt;
}}&lt;/onlyinclude&gt;</nowiki>
 
 
 
{{Navbox Unique Items}}
 
</nowiki></pre>


<includeonly>
<includeonly>

Revision as of 00:00, 2 February 2014

This subpage provides documentation for Template:Item.

This template is used on a large number of pages.

To avoid major disruption and server load, do not make unnecessary edits to this template. Test changes to this template first using its /sandbox and /testcases subpages . All of the changes can then be applied to this template in a single edit.

Consider discussing changes on the talk page or on Discord before implementing them.

Template:Intricate template

The item template is used on item pages to show the item's infobox. This setup also allows an item pages' data to be transcluded on other pages and formatted in various ways such as in a table. See testcases for examples.

Parameters

All parameters except for Name are optional. They can be excluded or left blank.

Parameter Description
Name Name of the item
PageName Name of the item's wiki page – Defaults to Name
Image File name of the item graphic – Defaults to PageName.png
Size Size of the item in grid units – Possible values are, but not limited to: 1x1, 2x2, and 2x4. Defaults to a "best guess" based on the item's type, subtype, and requirements.
Rarity Rarity of the item – This only applies to weapons, armour, accessories, flasks, and maps. Possible values are: Normal, Magic, Rare, and Unique. Defaults to Normal.
Type Type of the item, for formatting purposes – Possible values are: Weapon, Armour, Accessory, Flask, Map, Currency, and Quest.
Subtype Subtype of the item – Possible values are, but not limited to: Axe, Staff, Gloves, Body Armour, and Ring.
BaseItem Base item page name, for rares and uniques
RequiredLevel Level requirement of the item
RequiredStrength Strength requirement of the item
RequiredDexterity Dexterity requirement of the item
RequiredIntelligence Intelligence requirement of the item
PhysicalDamage Physical damage of the weapon
FireDamage Fire damage of the weapon
ColdDamage Cold damage of the weapon
LightningDamage Lightning damage of the weapon
ChaosDamage Chaos damage of the weapon
AverageDamage Override for normal average damage calculation; used for weapons such as Dyadus
CriticalStrikeChance Critical strike chance of the weapon
AttacksPerSecond Attacks per second of the weapon
Armour Armour rating of the armour item
Evasion Evasion rating of the armour item
EnergyShield Energy shield of the armour item
Block Block chance of the shield
MapLevel Map level of the map item
ItemQuantity Item quantity modifier of the map item
StackSize Maximum stack size of the currency item
Effect Effect of the usable utility flask, currency item, or microtransaction item
FlaskLife Life restoration on use of the flask
FlaskMana Mana restoration on use of the flask
FlaskDuration Life or mana restoration time or utility effect duration of the flask
FlaskCharges Total "charge" capacity of the flask
FlaskChargesUsed "Charges" consumed on use of the flask
ImplicitMods Implicit mods of the item – Separate each line with <br>.
RandomMods Random mods of the item – Separate each line with <br>.
Cosmetic Cosmetic mods of the item – Separate each line with <br>.
FlavourText Flavour text of the item – Separate each line with <br>.
HelpText Help text of the item – Separate each line with <br>.

Numerical ranges

There are two types of numerical ranges for items: damage ranges and random value ranges. See the discussion about distinguishing between ranges.

Damage ranges are two numbers separated by an en dash (&ndash;), indicating a range of possible values for damage calculation. These appear on the wiki very similar to how they appear in game.

  • Physical Damage: 15–23
  • Adds 48–72 Fire Damage

Random value ranges are two numbers or damage ranges separated by the word "to" and enclosed in parentheses, indicating a range of possible values for item stat rolls. These do not appear in game at all, but are shown on the wiki for informational purposes.

  • Evasion Rating: (80 to 91)
  • +(60 to 80) to maximum Life
  • (10 to 20)% increased Attack Speed
  • Adds (15–25 to 24–35) Chaos Damage

Code templates

Copy and paste a code template to get started.

Weapon

<onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Driftwood Wand
| Size                   = 1x3
| Rarity                 = Normal
| Type                   = Weapon
| Subtype                = Wand
| RequiredLevel          = 
| RequiredStrength       = 
| RequiredDexterity      = 
| RequiredInteligence    = 
| PhysicalDamage         = 4-7
| CriticalStrikeChance   = 8%
| AttacksPerSecond       = 1.3
| ImplicitMods           = (8-12)% increased Spell Damage
}}</onlyinclude>

Armour

<onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Scholar's Robe
| Size                   = 2x4
| Rarity                 = Normal
| Type                   = Armour
| Subtype                = Body Armour
| RequiredLevel          = 18
| RequiredStrength       = 
| RequiredDexterity      = 
| RequiredIntelligence   = 55
| Armour                 = 
| Evasion                = 
| EnergyShield           = 41
| ImplicitMods           = 
}}</onlyinclude>

Unique amulet

<onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Araku Tiki
| Size                   = 1x1
| Rarity                 = Unique
| Type                   = Accessory
| Subtype                = Amulet
| RequiredLevel          = 18
| ImplicitMods           = (2.0 to 4.0) Life Regenerated per second
| RandomMods             = You gain 100 Evasion Rating when on Low Life <br> +(30 to 50) to maximum Life <br> +(20 to 30)% to Fire Resistance <br> 1.0% of Life Regenerated per Second while on Low Life
| FlavourText            = It is said to make you invisible when the Great <br> Spirit comes to take you on your final journey.
}}</onlyinclude>