Template:Equipment page: Difference between revisions
No edit summary |
No edit summary |
||
Line 86: | Line 86: | ||
See here for the result of the above: [[Template:EquipmentPage/Example]] | See here for the result of the above: [[Template:EquipmentPage/Example]] | ||
[[Category:Equipment Page Templates]] | |||
{{#cargo_declare: | |||
_table = equipment | |||
| name = String (unique; mandatory) | |||
| image = File | |||
| description = Wikitext | |||
| quote = Wikitext | |||
| where_to_find = Wikitext | |||
| type = Page | |||
| proficiency = String (allowed values = Light Armour, Medium Armour, Heavy Armour, Shields) | |||
| armour_class = Integer | |||
| armour_class_bonus = String | |||
| stealth_disadvantage = Boolean | |||
| rarity = String (allowed values = common, uncommon, rare, very rare, legendary, story) | |||
| rarity_order = Integer | |||
| enchantment = String | |||
| weight_kg = Float | |||
| weight_lb = Float | |||
| price = Integer | |||
| special = Wikitext | |||
}} | |||
</noinclude><includeonly>{{#switch: {{{this is an example|}}} | |||
| yes = | |||
| #default = {{#cargo_store: _table = equipment | |||
| name = {{PAGENAME}} | |||
| stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}} | |||
| rarity = {{IfEmpty | {{{rarity|}}} | common}} | |||
| rarity_order = {{#switch: {{{rarity|}}} | |||
| | common = 0 | |||
| uncommon = 1 | |||
| rare = 2 | |||
| very rare = 3 | |||
| legendary = 4 | |||
| story = 5 | |||
}} | |||
}} | |||
}}</includeonly><noinclude> | |||
Auto-generated TemplateData follows from this point on. | Auto-generated TemplateData follows from this point on. | ||
---- | ---- | ||
<templatedata> | <templatedata> | ||
{ | { |
Revision as of 15:43, 15 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, Belts, Boots, Cloaks, Gloves, Helmets, Rings. 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 <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings --> | proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields --> | armourclass = 12 <!-- Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip. --> | armourclassbonus = <!-- 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, Belts, Boots, Cloaks, Gloves, Helmets, Rings. (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 | Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings
| String | required |
proficiency | proficiency | Leave EMPTY if no proficiency required, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields
| String | suggested |
armourclass | armourclass | Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip.
| Number | suggested |
armourclassbonus | armourclassbonus | 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 |