Template:Equipment page: Difference between revisions
m Removed protection from "Template:EquipmentPage" |
m remove Belts; add Camp Clothes, Camp Shoes, and Undergarments |
||
Line 55: | Line 55: | ||
--> | --> | ||
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 | 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]]. | ||
Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties. | Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties. | ||
Line 67: | Line 67: | ||
| description = '''Cool Armour''' is an uncommon [[Armour#Light Armour|Light Armour]] that increases [[Strength]] [[Saving Throw]]s and allows the wearer to cast a neat spell. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. --> | | description = '''Cool Armour''' is an uncommon [[Armour#Light Armour|Light Armour]] that increases [[Strength]] [[Saving Throw]]s and allows the wearer to cast a neat spell. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. --> | ||
| quote = The in-game flavor text in the item's tooltip. | | quote = The in-game flavor text in the item's tooltip. | ||
| type = Light Armour <!-- | | type = Light Armour <!-- Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments --> | ||
| proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields --> | | proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields --> | ||
| armour class = 12 <!-- Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. --> | | armour class = 12 <!-- Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. --> | ||
Line 156: | Line 156: | ||
}, | }, | ||
"type": { | "type": { | ||
"description": " | "description": "Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments", | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
Line 167: | Line 167: | ||
"Shields", | "Shields", | ||
"Amulets", | "Amulets", | ||
"Boots", | "Boots", | ||
"Cloaks", | "Cloaks", | ||
"Gloves", | "Gloves", | ||
"Helmets", | "Helmets", | ||
"Rings" | "Rings", | ||
"Camp Clothes", | |||
"Camp Shoes", | |||
"Undergarments" | |||
] | ] | ||
}, | }, | ||
Line 251: | Line 253: | ||
} | } | ||
}, | }, | ||
"description": "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 | "description": "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.)\n\nCopy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.", | ||
"format": "block" | "format": "block" | ||
} | } | ||
</templatedata></noinclude> | </templatedata></noinclude> |
Revision as of 03:16, 23 July 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.
Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties.
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.
{{EquipmentPage | <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage --> | image = Leather Armour PlusOne Icon.png | description = '''Cool Armour''' is an uncommon [[Armour#Light Armour|Light Armour]] that increases [[Strength]] [[Saving Throw]]s and allows the wearer to cast a neat spell. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. --> | quote = The in-game flavor text in the item's tooltip. | type = Light Armour <!-- Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments --> | proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields --> | armour class = 12 <!-- Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. --> | armour class bonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 --> | stealth disadvantage = <!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! --> | enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 --> | rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story --> | weight kg = 4.5 | weight lb = 9.9 | price = 600 | special = <!-- List of special features, bonuses, or abilities granted by the item. --> * '''[[Strength]] [[Saving Throw]]s:''' +1 * '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item. | where to find = <!-- Describe where and how to obtain the item. --> This is a made-up piece of equipment. You cannot obtain it anywhere in the game. }}
See here for the result of the above: Template:EquipmentPage/Example
This template defines the table "equipment". View table.
Auto-generated TemplateData 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 | |
---|---|---|---|---|
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 |