Template:Equipment page: Difference between revisions

From Baldur's Gate 3 Wiki
Jump to navigation Jump to search
m (testing - WIP)
m (testing - WIP)
Line 12: Line 12:
== Properties ==
== Properties ==


* {{#switch: {{{armortype}}}
* {{#switch: {{{type|}}}
| Clothing = [[Clothing]]
| Light Armor = {{LightArmor}}
| Light = {{LightArmor}}
| Medium Armor = {{MediumArmor}}
| Medium = {{MediumArmor}}
| Heavy Armor = {{HeavyArmor}}
| Heavy = {{HeavyArmor}}
| Shields = {{Shields}}
| #default = {{{type}}}
| #default = {{{type}}}
}}
}}
{{#if: {{{armorclass|}}} |
* {{ArmorClass}}: {{{armorclass}}} {{#switch: {{{type|}}} |
| Clothing = ''(no inherent AC bonus)''
| Light = {{{armorclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]]
| Medium = {{{armorclass}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]] ''(AC bonus from Dexterity limited to +2)''
| Heavy = {{{armorclass}}}
| #default = }}
}}
{{#if: {{{armorclassbonus|}}} |
* {{ArmorClass}}: {{{armorclassbonus}}} |
}}
{{#switch: {{{proficiency|}}}
| Light Armor: * Required Proficiency: {{LightArmor}}
| Medium Armor: * Required Proficiency: {{MediumArmor}}
| Heavy Armor: * Required Proficiency: {{HeavyArmor}}
| Shields: * Required Proficiency: {{Shields}}
| #default: }}
* {{Rarity | {{{rarity|common}}} }}
* {{Rarity | {{{rarity|common}}} }}
{{#if: {{{enchantment|}}} |
* {{Enchantment | {{{enchantment|}}} }}
* {{Enchantment | {{{enchantment|}}} }}
}}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Price | {{{price}}} }}
* {{Price | {{{price}}} }}
Line 32: Line 51:
{{#switch: {{{nocategories|}}} <!-- Just for examples of use. -->
{{#switch: {{{nocategories|}}} <!-- Just for examples of use. -->
| yes =
| yes =
| #default = [[Category:{{{category}}}]] [[Category:{{{armortype}}}]] [[Category:{{{rarity|common}}} Items]]
| #default = [[Category:{{{type}}}]] [[Category:{{{rarity|common}}} Items]]
}}</includeonly><noinclude>'''WORK IN PROGRESS''' - DO NOT USE.<!--
}}</includeonly><noinclude>'''WORK IN PROGRESS''' - DO NOT USE.<!--


Line 40: Line 59:
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 Armor +1]] or [[Amulet of Misty Step]].


Following is an example of usage with all possible template parameters shown. This describes a made-up uncommon Leather Armor with a +1 enchantment and a special property.
Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armor with a couple special properties.


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.'''


<pre>
<pre>
Line 48: Line 67:
| <!-- 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 Armor PlusOne Icon.png
| description = '''Cool Armor''' is an uncommon [[Armor#Light Armor|Light Armor]]. <!-- This is the first text that will appear on the page. *Briefly* describe what the item is, and what makes it noteworthy. -->
| description = '''Cool Armor''' is an uncommon [[Armor#Light Armor|Light Armor]]. <!-- 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 = Armor <!-- Equipment category. Choose one of: Amulets, Armor, Belts, Boots, Cloaks, Gloves, Helmets, Rings, Shields (use these exact capitalizations and singulars/plurals). -->
| type = Light Armor <!-- Item type. Choose one of: Clothing, Light Armor, Medium Armor, Heavy Armor, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| armortype = Light <!-- Leave EMPTY for all categories except Armor. For Armor, choose from: Clothing, Light, Medium, Heavy -->
| proficiency = Light Armor <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armor, Medium Armor, Heavy Armor, Shields -->
| rarity = <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| <!-- Following are Armor- and Shield-related properties -->
| enchantment = +1 <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| armorclass = 12 <!-- Leave EMPTY for non-Armor, otherwise: the Armor Class value displayed on the armor's tooltip. -->
| <!-- Following are yes/no properties, which MUST BE EMPTY if you mean "no"!  Never actually type "no"! -->
| armorclassbonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to armor class granted by wearing this item. -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| <!-- Following are general properties, which should be filled in for ALL types of equipment. -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| weight kg = 1.35
| weight kg = 1.35
| weight lb = 2.7
| weight lb = 2.7
| price = 75
| price = 75
| special = <!-- List of special features or abilities granted by the item. -->
| special = <!-- List of special features, bonuses, or abilities granted by the item. -->
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this weapon.
* '''[[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. -->
| 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.
This is a made-up piece of equipment.  You cannot obtain it anywhere in the game.

Revision as of 04:14, 11 February 2023

WORK IN PROGRESS - DO NOT USE. This template generates entire pages for individual pieces of equipment in the game, such as Studded Leather Armor +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 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 Armor PlusOne Icon.png
| description = '''Cool Armor''' is an uncommon [[Armor#Light Armor|Light Armor]]. <!-- 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 Armor <!-- Item type. Choose one of: Clothing, Light Armor, Medium Armor, Heavy Armor, 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 -->
| <!-- Following are Armor- and Shield-related properties -->
| armorclass = 12 <!-- Leave EMPTY for non-Armor, otherwise: the Armor Class value displayed on the armor's tooltip. -->
| armorclassbonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to armor class granted by wearing this item. -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| <!-- Following are general properties, which should be filled in for ALL types of equipment. -->
| rarity = uncommon <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| weight kg = 1.35
| weight lb = 2.7
| price = 75
| 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.

Retrieved from "https://bg3.wiki/w/index.php?title=Template:Equipment_page&oldid=11017"