The wiki is currently a work in progress. If you'd like to help out, please check the Community Portal and our getting started guide. Also, check out our sister project on poewiki.net.
Template:Item/doc: Difference between revisions
(→Parameters: Updated documentation) |
(Updated documentation with better information about formatting numerical ranges.) |
||
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. | |||
{{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. | |||
==Parameters== | |||
All parameters except for <code>Name</code> are optional. They can be excluded or left blank. | All parameters except for <code>Name</code> are optional. They can be excluded or left blank. | ||
Line 40: | Line 39: | ||
| <code>FireDamage</code> || Fire damage of the weapon | | <code>FireDamage</code> || Fire damage of the weapon | ||
|- | |- | ||
| <code>ColdDamage</code> || | | <code>ColdDamage</code> || Cold damage of the weapon | ||
|- | |- | ||
| <code>LightningDamage</code> || Lightning damage of the weapon | | <code>LightningDamage</code> || Lightning damage of the weapon | ||
Line 93: | Line 92: | ||
|} | |} | ||
=== | ===Numerical 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>&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–23}} | |||
* {{c|mod|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. | |||
* {{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–25 to 24–35) Chaos Damage}} | |||
: | |||
==Code templates== | |||
Copy and paste a code template to get started. | Copy and paste a code template to get started. | ||
===Weapon=== | |||
<pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | <pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | ||
| Name = Driftwood Wand | | Name = Driftwood Wand | ||
Line 129: | Line 129: | ||
</nowiki></pre> | </nowiki></pre> | ||
===Armour=== | |||
<pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | <pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | ||
| Name = Scholar's Robe | | Name = Scholar's Robe | ||
Line 150: | Line 150: | ||
</nowiki></pre> | </nowiki></pre> | ||
===Unique Amulet=== | |||
<pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | <pre><nowiki><onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | ||
| Name = Araku Tiki | | Name = Araku Tiki |
Revision as of 08:47, 20 October 2013

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 or your user space. 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.
{{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 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, if different than Name
|
Image |
File name of the item graphic – Defaults to {{{Name}}}.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 |
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 |
CurrencyEffect |
Effect of the usable currency item |
FlaskLife |
Life restoration on use of the flask |
FlaskLifeDuration |
Life restoration duration of the flask |
FlaskMana |
Mana restoration on use of the flask |
FlaskManaDuration |
Mana restoration duration of the flask |
FlaskEffect |
Effect of the utility flask |
FlaskEffectDuration |
Effect duration of the utility 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 (–
), 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 | 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> [[Category:Wands]]
Armour
<onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | Name = Scholar's Robe | Rarity = Normal | Type = Armour | Subtype = Body Armour | RequiredLevel = 18 | RequiredStrength = | RequiredDexterity = | RequiredIntelligence = 55 | Armour = | Evasion = | EnergyShield = 41 | ImplicitMods = }}</onlyinclude> [[Category:Body armours]]
Unique Amulet
<onlyinclude>{{Item | View={{{View|}}} | Format={{{Format|}}} | Name = Araku Tiki | Rarity = Unique | Type = Accessory | Subtype = Amulet | RequiredLevel = 18 | ImplicitMods = (2.0-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 | FlavourText = It is said to make you invisible when the Great : Spirit comes to take you on your final journey. }}</onlyinclude> {{Navbox Unique Items}} [[Category:Unique amulets]]