Template documentation

[view] [edit] [history] [purge]

This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armour +1 or Amulet of Misty Step. For Weapons, use Template:WeaponPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.

Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Musical Instruments, Camp Clothes, Camp Shoes, Undergarments.

See the bottom of this page for template parameter explanations. If you're ever unsure what to type, simply leave a parameter empty (don't remove it, as this may confuse other wiki editors).

{{EquipmentPage

<!-- Name of the item as it displays in game, or the page name if not specified. -->
| name = 

<!-- High-res image of the item. -->
| image = 

<!-- Icon for the item. Falls back to the value of "image" if not specified. -->
| controller icon =

<!-- Icon for the item. Falls back to the value of "controller icon" if not specified. -->
| icon =

<!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| description =

<!-- The in-game flavor text in the item's tooltip. -->
| quote =

<!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings, Musical Instruments, Camp Clothes, Camp Shoes, Undergarments -->
| type =

<!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields -->
| proficiency =

<!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the armour's tooltip. -->
| armour class =

<!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| armour class bonus =

<!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! -->
| stealth disadvantage =

<!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| enchantment =

<!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| rarity =

<!-- Weight in kg and in lb. -->
| weight kg =
| weight lb =

<!-- Price in gp as shown in the normal tooltip (NOT while buying or selling). -->
| price =

<!-- The UID for the item in format "OBJ_ItemName_BlaBla" -->
| uid = 
<!-- The uuid or root template for  the item. Often in format 13776348-0101-446e-a9f8-c95efb3763ca -->
| uuid = 

<!-- List of passive features granted by the item. -->
| passives =

<!-- List of special features, bonuses, or abilities granted by the item. -->
| special =

<!-- Conditions given by this piece of equipment. -->
| condition = Dazed
| condition duration = 10
| condition save = WIS
| condition dc = 13
| condition2 = Prone
| condition2 duration = 1
| condition2 save =
| condition2 dc = 

<!-- Describe where and how to obtain the item. -->
| where to find =
| where to find location =
| where to find x =
| where to find y =
| where to find2 =
| where to find2 location =
| where to find2 x =
| where to find2 y =
| where to find3 =
| where to find3 location =
| where to find3 x =
| where to find3 y =
| where to find4 =
| where to find4 location =
| where to find4 x =
| where to find4 y =
| where to find5 =
| where to find5 location =
| where to find5 x =
| where to find5 y =
}}

Copy-ready:

{{EquipmentPage
| name =
| image = 
| icon =
| description =
| quote =
<!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings, Musical Instruments, Camp Clothes, Camp Shoes, Undergarments -->
| type =
| proficiency =
| armour class =
| armour class bonus =
| stealth disadvantage =
| enchantment =
| rarity =
| weight kg =
| weight lb =
| price =
| uid = 
| uuid =
| passives =
| special =
| condition =
| condition duration = 
| condition save =
| condition dc = 
| condition2 =
| condition2 duration = 
| condition2 save =
| condition2 dc =
| where to find =
| where to find location =
| where to find x =
| where to find y =
| where to find2 =
| where to find2 location =
| where to find2 x =
| where to find2 y =
| where to find3 =
| where to find3 location =
| where to find3 x =
| where to find3 y =
| where to find4 =
| where to find4 location =
| where to find4 x =
| where to find4 y =
| where to find5 =
| where to find5 location =
| where to find5 x =
| where to find5 y =
}}

Example follows.

Cool Armour

Where to find

Cool Shield

Condition: Wet

Condition: Prone

Where to find

Template data

This template generates entire pages for individual pieces of equipment in the game. Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments. (For Weapons, use Template:WeaponPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.) Copy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
name	`name`	Name of the item; can be left empty to automatically use the page name. Example Amulet of Misty Step	String	suggested
image	`image`	The filename of the image/icon associated with this item. Example Amulet of Misty Step Icon.png	File	suggested
controller icon	`controller icon`	The unfaded controller icon of this item. Defaults to the value of image= if not provided.	File	suggested
icon	`icon`	The icon of this item. Defaults to the value of controller icon= if not provided.	File	required
description	`description`	The first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. Example {{uncommon\|Amulet of Misty Step}} is an uncommon [[Amulets\|Amulet]] that allows the wearer to cast [[Misty Step]].	Content	required
quote	`quote`	The in-game flavour text in the item's tooltip.	Content	suggested
where to find	`where to find`	Describe where and how to obtain the item. Example Found on a table.	Content	suggested
where to find location	`where to find location`	The map name of the item. Should match a location page. Example Underdark	Content	suggested
where to find x	`where to find x`	The x coordinate of the item in the location. Example 53	Content	suggested
where to find y	`where to find y`	The y coordinate of the item in the location Example Underdark	Content	suggested
where to find2	`where to find2`	no description	Unknown	optional
where to find2 location	`where to find2 location`	no description	Unknown	optional
where to find2 x	`where to find2 x`	no description	Unknown	optional
where to find2 y	`where to find2 y`	no description	Unknown	optional
where to find3	`where to find3`	no description	Unknown	optional
where to find3 location	`where to find3 location`	no description	Unknown	optional
where to find3 x	`where to find3 x`	no description	Unknown	optional
where to find3 y	`where to find3 y`	no description	Unknown	optional
where to find4	`where to find4`	no description	Unknown	optional
where to find4 location	`where to find4 location`	no description	Unknown	optional
where to find4 x	`where to find4 x`	no description	Unknown	optional
where to find4 y	`where to find4 y`	no description	Unknown	optional
where to find5	`where to find5`	no description	Unknown	optional
where to find5 location	`where to find5 location`	no description	Unknown	optional
where to find5 x	`where to find5 x`	no description	Unknown	optional
where to find5 y	`where to find5 y`	no description	Unknown	optional
type	`type`	Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments Suggested values `Clothing` `Light Armour` `Medium Armour` `Heavy Armour` `Shields` `Amulets` `Boots` `Cloaks` `Gloves` `Helmets` `Rings` `Camp Clothes` `Camp Shoes` `Undergarments`	String	required
proficiency	`proficiency`	Leave EMPTY if no proficiency required, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields Suggested values `Light Armour` `Medium Armour` `Heavy Armour` `Shields`	String	suggested
armour class	`armour class`	Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. Example 12	Number	suggested
armour class bonus	`armour class bonus`	Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 Example +2	String	suggested
stealth disadvantage	`stealth disadvantage`	Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! Suggested values `yes`	String	suggested
rarity	`rarity`	Choose from: common, uncommon, rare, very rare, legendary, story Suggested values `common` `uncommon` `rare` `very rare` `legendary` `story`	String	required
enchantment	`enchantment`	The enchantment value on the item. Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 Example +1	String	suggested
weight kg	`weight kg`	Weight of the item in kilograms	Number	required
weight lb	`weight lb`	Weight of the item in pounds	Number	required
price	`price`	Price/value of the item. When two values are listed on the tooltip, use the crossed out "true" value, not the adjusted buy/sell price.	Number	required
uid	`uid`	The uid for the item. In format OBJ_Someitem_Whatever.	String	optional
uuid	`uuid`	The uuid or Root Template of the item. In format 13776348-0101-446e-a9f8-c95efb3763ca	String	optional
special	`special`	List of special features, bonuses, or abilities granted by the item. Example * '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.	Content	suggested
condition	`condition`	The full name of the condition (if any) that this action applies to its target/s. Leave blank if there is no condition. Example Hastened	String	optional
condition duration	`condition duration`	The duration in turns of the action's applied condition. Leave blank if the duration is unlimited. Example 5	Number	optional
condition save	`condition save`	The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength" Suggested values `Strength` `Dexterity` `Constitution` `Intelligence` `Wisdom` `Charisma` Example WIS	String	optional
condition dc	`condition dc`	The optional fixed DC of the condition that targets have to pass to apply it Example 12	Number	optional
condition2	`condition2`	The full name of the condition (if any) that is applied if there is a second condition. Example Hastened	String	optional
condition2 duration	`condition2 duration`	The duration in turns of the action's second condition. Leave blank if the duration is unlimited. Example 5	Number	optional
condition2 save	`condition2 save`	The save that the action's target must roll to avoid or reduce the effects of the second condition. Can use short or long name, e.g: "STR" or "Strength" Suggested values `Strength` `Dexterity` `Constitution` `Intelligence` `Wisdom` `Charisma` Example WIS	String	optional
condition2 dc	`condition2 dc`	The optional fixed DC of the second condition that targets have to pass to apply it Example 12	Number	optional
this is an example	`this is an example`	no description	Unknown	optional
seo description	`seo description`	no description	Unknown	optional
dex override	`dex override`	no description	Unknown	optional
rarity honour	`rarity honour`	The rarity in Honour Mode, if it is different.	Unknown	optional
price honour	`price honour`	The price in Honour Mode, if it is different.	Unknown	optional
notes	`notes`	no description	Unknown	optional
bugs	`bugs`	no description	Unknown	optional
filename	`filename`	no description	Unknown	optional

This template defines the table "equipment". View table.

Template:Equipment page

Cool Armour

Properties

Where to find

Cool Shield

Properties

Condition: Wet

Condition: Prone

Where to find

Template data