Template:Equipment page/doc
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, 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 --> | 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 = }}
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 --> | 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 = }}
Example follows.
Cool Armour
Cool Armour is an uncommon Light Armour that increases Strength Saving Throws and allows the wearer to cast a neat spell.
The in-game flavor text in the item's tooltip.
Properties
- Required Proficiency:
- Rarity: Uncommon / RareHHonour
- Weight: 4.5 kg / 9 lb
- Price: 600 gp / 1500 gpHHonour
-
UID
MAG_Cool_LeatherArmour_1UUID
13776348-0101-446e-a9f8-c95efb3763ca
Special
The wearer of this item gains:
- Strength Saving Throws: +1
- Super Cool Ability: Once per Long Rest you can use this awesome ability of this item.
- Disadvantage on Stealth checks.
Where to find
- This is a made-up piece of equipment. You cannot obtain it anywhere in the game.
Cool Shield
Cool shield is an uncommon Shield that allows the wearer to cast a ton of spells.
The in-game flavor text in the item's tooltip.
Properties
- Required Proficiency:
- Rarity: Uncommon
- Weight: 4.5 kg / 9 lb
- Price: 600 gp
Special
The wearer of this item gains:
- Strength Saving Throws: +1
- Super Cool Ability: Once per Long Rest you can use this awesome ability of this item.
Condition: Wet
Condition: Prone
Duration: Until Long rest
- Can't move or take Actions, Bonus actions, or Reactions, and has Disadvantage on Strength and Dexterity saving throws.
- Attacks against a Prone creature have Advantage if they're made within 3 m / 10 ft of the creature.
- A Prone creature must spend half its Movement Speed to stand up.
- A character with the Athlete feat spends only 1.5 m / 5 ft of Movement Speed to stand up.
Where to find
- This is a made-up piece of equipment. You cannot obtain it anywhere in the game.
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | Name of the item; can be left empty to automatically use the page name.
| String | suggested |
image | image | The filename of the image/icon associated with this item.
| 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.
| 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.
| Content | suggested |
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
| String | required |
proficiency | proficiency | Leave EMPTY if no proficiency required, otherwise choose from: 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.
| 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
| String | suggested |
stealth disadvantage | stealth disadvantage | Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no!
| String | suggested |
rarity | rarity | Choose from: 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
| 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.
| 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.
| String | optional |
condition duration | condition duration | The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.
| 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"
| String | optional |
condition dc | condition dc | The optional fixed DC of the condition that targets have to pass to apply it
| Number | optional |
condition2 | condition2 | The full name of the condition (if any) that is applied if there is a second condition.
| String | optional |
condition2 duration | condition2 duration | The duration in turns of the action's second condition. Leave blank if the duration is unlimited.
| 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"
| String | optional |
condition2 dc | condition2 dc | The optional fixed DC of the second condition that targets have to pass to apply it
| 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 |
filename | filename | no description | Unknown | optional |