Template:Equipment page: Difference between revisions
No edit summary |
No edit summary |
||
Line 11: | Line 11: | ||
}}"> | }}"> | ||
[[File:{{{image}}}|frameless|right]] | {{#if:{{{image|}}} | [[File:{{{image}}}|frameless|right]] | [[Category:Equipment pages without images]]}} | ||
{{{description}}} <!-- No support for auto-generated equipment descriptions for now. --> | {{{description}}} <!-- No support for auto-generated equipment descriptions for now. --> |
Revision as of 01:54, 7 August 2023
This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armour +1 or Amulet of Misty Step. 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.
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 <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage --> | image = | description = | quote = The in-game flavor text in the item's tooltip. | type = | proficiency = | armour class = | armour class bonus = | stealth disadvantage = | enchantment = | rarity = | weight kg = | weight lb = | price = | special = <!-- List of special features, bonuses, or abilities granted by the item. --> | where to find = | this is an example = yes }}
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
- Light armour
- Required Proficiency: Light armour
- Armour Class: 12 + Dexterity Modifier
- 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.
Where to Find
This is a made-up piece of equipment. You cannot obtain it anywhere in the game.
This template defines the table "equipment". View table.
TemplateData documentation follows from this point on.
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 |
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 |
special | special | List of special features, bonuses, or abilities granted by the item.
| Content | suggested |