Template:Equipment page: Difference between revisions

From Baldur's Gate 3 Wiki
Jump to navigation Jump to search
m (remove WIP disclaimer; remove unnecessary comments)
(british spelling)
Line 13: Line 13:


* {{#switch: {{{type|}}}
* {{#switch: {{{type|}}}
| Light Armor = {{LightArmor}}
| Light Armour = {{LightArmour}}
| Medium Armor = {{MediumArmor}}
| Medium Armour = {{MediumArmour}}
| Heavy Armor = {{HeavyArmor}}
| Heavy Armour = {{HeavyArmour}}
| Shields = {{Shields}}
| Shields = {{Shields}}
| #default = [[{{{type}}}]] }} {{#if: {{{armorclass|}}} |
| #default = [[{{{type}}}]] }} {{#if: {{{Armourclass|}}} |
* {{ArmorClass}}: {{#switch: {{{type|}}}
* {{ArmourClass}}: {{#switch: {{{type|}}}
| Clothing = ''(Clothing grants no inherent AC bonus)''
| Clothing = ''(Clothing grants no inherent AC bonus)''
| Light Armor = {{{armorclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]]
| Light Armour = {{{Armourclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]]
| Medium Armor = {{{armorclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]] ''(AC bonus from Dexterity limited to +2)''
| Medium Armour = {{{Armourclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]] ''(AC bonus from Dexterity limited to +2)''
| Heavy Armor = {{{armorclass}}}
| Heavy Armour = {{{Armourclass}}}
| #default = }} }} {{#if: {{{armorclassbonus|}}} |
| #default = }} }} {{#if: {{{Armourclassbonus|}}} |
* {{ArmorClass}}: {{{armorclassbonus}}} }}
* {{ArmourClass}}: {{{Armourclassbonus}}} }}
* Required Proficiency: {{#switch: {{{proficiency|}}}
* Required Proficiency: {{#switch: {{{proficiency|}}}
| Light Armor = {{LightArmor}}
| Light Armour = {{LightArmour}}
| Medium Armor = {{MediumArmor}}
| Medium Armour = {{MediumArmour}}
| Heavy Armor = {{HeavyArmor}}
| Heavy Armour = {{HeavyArmour}}
| Shields = {{Shields}}
| Shields = {{Shields}}
| #default = None}}
| #default = None}}
Line 50: Line 50:


-->
-->
This template generates entire pages for individual pieces of equipment in the game, such as [[Studded Leather Armor +1]] or [[Amulet of Misty Step]].
This template generates entire pages for individual pieces of equipment in the game, such as [[Studded Leather Armour +1]] or [[Amulet of Misty Step]].


Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armor 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.


'''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.'''
'''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.'''
Line 59: Line 59:
{{EquipmentPage
{{EquipmentPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage -->
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage -->
| image = Leather Armor PlusOne Icon.png
| image = Leather Armour PlusOne Icon.png
| description = '''Cool Armor''' is an uncommon [[Armor#Light Armor|Light Armor]] 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 Armor <!-- Item type. Choose one of: Clothing, Light Armor, Medium Armor, Heavy Armor, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| 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 Armor <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armor, Medium Armor, Heavy Armor, Shields -->
| proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields -->
| armorclass = 12 <!-- Leave EMPTY for non-Armor, otherwise: the Armor Class value displayed on the armor's tooltip. -->
| Armourclass = 12 <!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the Armour's tooltip. -->
| armorclassbonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| Armourclassbonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->

Revision as of 03:27, 13 February 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.

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, 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 -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| 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

Note that the template even adds the page to the correct categories. And for the same reason, it shouldn't be invoked here for the purpose of showing how the results look; that would result in this template page being added to the categories to which equipment pages are added.