Template:Item/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
(Replaced content with "{{documentation subpage}} {{lua|Module:Item}} This template should not be transcluded. It is being retained for historical purposes. Please refer to Module:Item. <i...")
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{high-risk}}


{{lua|Module:Item}}
{{lua|Module:Item}}


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.
This template should not be transcluded. It is being retained for historical purposes. Please refer to [[Module:Item]].
 
==Parameters==
All parameters except for '''Name''' are optional. They can be excluded or left blank.
 
{| class="wikitable"
! Parameter !! Description
|-
| '''Name''' || Name of the item
|-
| '''SortKey''' || The sort key for sorting the item in categories and tables&nbsp;– Defaults to <code>'''Name'''</code>
|-
| '''PageName''' || Name of the item's wiki page&nbsp;– Defaults to <code>'''Name'''</code>
|-
| '''Image''' || File name of the item graphic&nbsp;– Defaults to <code>'''PageName'''.png</code>
|-
| '''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.
|-
| '''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>.
|-
| '''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>.
|-
| '''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>.
|-
| '''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&nbsp;– Separate each line with <code><nowiki><br></nowiki></code>.
|-
| '''RandomMods''' || Random 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>.
|-
| '''FlavourText''' || Flavour text of the item
|-
| '''HelpText''' || Help text of the item
|}
 
===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.
 
''Damage ranges'' are two numbers separated by an en dash (<code>&amp;ndash;</code>), indicating a range of possible values for damage calculation. These appear on the wiki very similar to how they appear in game.
* {{c|stat|Physical Damage:}} {{c|value|15&ndash;23}}
* {{c|mod|Adds 48&ndash;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.
* {{c|stat|Evasion Rating:}} {{c|value|(80 to 91)}}
* {{c|mod|+(60 to 80) to maximum Life}}
* {{c|mod|(10 to 20)% increased Attack Speed}}
* {{c|mod|Adds (15&ndash;25 to 24&ndash;35) Chaos Damage}}
 
==Code templates==
Copy and paste a code template to get started.
 
===Weapon===
<nowiki>&lt;onlyinclude&gt;{{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
}}&lt;/onlyinclude&gt;</nowiki>
 
===Armour===
<nowiki>&lt;onlyinclude&gt;{{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          =
}}&lt;/onlyinclude&gt;</nowiki>
 
===Unique amulet===
<nowiki>&lt;onlyinclude&gt;{{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.
}}&lt;/onlyinclude&gt;</nowiki>


<includeonly>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Data templates]]
[[Category:Data templates]]
[[Category:Item templates]]
[[Category:Item templates]]
</includeonly>
</includeonly>

Revision as of 21:17, 23 March 2016

This subpage provides documentation for Template:Item.

Lua logo

This template uses the following modules:

This template should not be transcluded. It is being retained for historical purposes. Please refer to Module:Item.


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