Template:Equipment page: Difference between revisions
HiddenDragon (talk | contribs) (Tweak spacing of properties a bit to the right) |
HiddenDragon (talk | contribs) No edit summary |
||
Line 24: | Line 24: | ||
{{#if: {{{armour class|}}} | | {{#if: {{{armour class|}}} | | ||
{{Armour class value|{{{armour class}}}|{{#switch: {{{type|}}} | {{Armour class value|{{{armour class}}}|{{#switch: {{{type|}}} | ||
| Clothing = Armour Class ''(Clothing grants no inherent AC bonus)'' | | Clothing = + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] [[Armour Class]] ''(Clothing grants no inherent AC bonus)'' | ||
| Light Armour = + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] Armour Class | | Light Armour = + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] [[Armour Class]] | ||
| Medium Armour = {{#ifeq: {{{dex override}}} | | Medium Armour = {{#ifeq: {{{dex override}}} | ||
| yes | + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] Armour Class | | yes | + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] Armour Class | ||
| + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] Armour Class ''(AC bonus from Dexterity limited to +2)''}} | | + [[Dexterity#Dexterity Modifier Chart|Dexterity Modifier]] [[Armour Class]] ''(AC bonus from Dexterity limited to +2)''}} | ||
| Heavy Armour = Armour Class | | Heavy Armour = [[Armour Class]] | ||
| #default = Armour Class}}}}}} {{#if: {{{armour class bonus|}}} | | | #default = [[Armour Class]]}}}}}} {{#if: {{{armour class bonus|}}} | | ||
{{Armour class value|{{{armour class bonus}}}|Armour Class}}}} | {{Armour class value|{{{armour class bonus}}}|[[Armour Class]]}}}} | ||
<ul class="bg3wiki-property-list" style="margin-left: 7px"> | <ul class="bg3wiki-property-list" style="margin-left: 7px"> | ||
<li> {{WeaponType|{{{type|}}}}} </li> {{#if: {{{proficiency|}}} | | <li> {{WeaponType|{{{type|}}}}} </li> {{#if: {{{proficiency|}}} | | ||
<li> Required Proficiency: {{WeaponType|{{{proficiency}}}}} </li> }} {{#if: {{{stealth disadvantage|}}} | | <li> {{Icon|Proficiency Icon.png|32}} Required Proficiency: {{WeaponType|{{{proficiency}}}}} </li> }} {{#if: {{{stealth disadvantage|}}} | | ||
: {{Disadvantage}} on [[Stealth]] checks }} </li> | : {{Disadvantage}} on [[Stealth]] checks }} </li> | ||
<li> {{Rarity | {{{rarity|common}}} }} </li> {{#if: {{{enchantment|}}} | | <li> {{Rarity | {{{rarity|common}}} }} </li> {{#if: {{{enchantment|}}} | |
Revision as of 21:23, 9 November 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 <!-- High-res image of the item. --> | image = <!-- Icon for the item. Falls back to the value of "image" if not specified. --> | icon = <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. --> | description = <!-- The in-game flavor text in the item's tooltip. --> | quote = <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings --> | type = <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields --> | proficiency = <!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the armour's tooltip. --> | armour class = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 --> | armour class bonus = <!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! --> | stealth disadvantage = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 --> | enchantment = <!-- Choose from: common, uncommon, rare, very rare, legendary, story --> | rarity = <!-- Weight in kg and in lb. --> | weight kg = | weight lb = <!-- Price in gp as shown in the normal tooltip (NOT while buying or selling). --> | price = <!-- The UID for the item in format "OBJ_ItemName_BlaBla" --> | uid = <!-- The uuid or root template for the item. Often in format 13776348-0101-446e-a9f8-c95efb3763ca --> | uuid = <!-- List of special features, bonuses, or abilities granted by the item. --> | special = <!-- Describe where and how to obtain the item. --> | where to find = }}
Copy-ready:
{{EquipmentPage | image = | icon = | description = | quote = <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings --> | type = | proficiency = | armour class = | armour class bonus = | stealth disadvantage = | enchantment = | rarity = | weight kg = | weight lb = | price = | uid = | uuid = | special = | where to find = }}
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
- Rarity: Uncommon
- Weight: 4.5 kg / 9 lb
- Price: 600 gp
UID
MAG_Cool_LeatherArmour_1UUID
13776348-0101-446e-a9f8-c95efb3763ca
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.
Cool Shield
Cool shield is an uncommon Shield that allows the wearer to cast a ton of spells.
The in-game flavor text in the item's tooltip.
Properties
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 |
icon | icon | The icon for the item. Falls back to "image" if not specified. | Unknown | optional |
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 |
uid | uid | The uid for the item. In format OBJ_Someitem_Whatever. | String | optional |
uuid | uuid | The uuid or Root Template of the item. In format 13776348-0101-446e-a9f8-c95efb3763ca | String | optional |
special | special | List of special features, bonuses, or abilities granted by the item.
| Content | suggested |