Template:Equipment page: Difference between revisions
m blank the template example code, since all parameter documentation can already be found on this page. |
No edit summary |
||
Line 1: | Line 1: | ||
<includeonly> | <includeonly>{{PageSeo | ||
| image = {{{image}}} | |||
| description = {{EquipmentPage/Description | | description = {{EquipmentPage/Description | ||
| type = {{{type}}} | | type = {{{type}}} | ||
Line 6: | Line 6: | ||
}} | }} | ||
}} | }} | ||
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-{{#if: {{{rarity|}}} | |||
| {{#replace: {{{rarity}}} | <nowiki> </nowiki> | }} | |||
| common | |||
}}"> | |||
[[File:{{{image}}}|frameless|right]] | |||
{{{description}}} <!-- No support for auto-generated equipment descriptions for now. --> | {{{description}}} <!-- No support for auto-generated equipment descriptions for now. --> | ||
{{quote|{{{quote|Missing quote ... imagine some nice flavor text here.}}}}} | {{quote|{{{quote|Missing quote ... imagine some nice flavor text here.}}}}} | ||
== Properties == | == Properties == | ||
Line 39: | Line 42: | ||
* {{Enchantment | {{{enchantment|}}} }} }} | * {{Enchantment | {{{enchantment|}}} }} }} | ||
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }} | * {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }} | ||
* {{Price | {{{price}}} }} | * {{Price | {{{price}}} }} {{#if: {{{special|}}} | {{blank}} | ||
{{#if: {{{special|}}} | | |||
=== Special === | === Special === | ||
The wearer of this item gains: | The wearer of this item gains: | ||
{{{special}}} | {{{special}}} | ||
}}</div> {{#if: {{{where to find|}}} | {{blank}} | |||
== Where to Find == | |||
<div class="bg3wiki-tooltip-box"> | |||
{{{where to find}}} | |||
</div> | |||
}} | }} | ||
Line 61: | Line 71: | ||
<pre> | <pre> | ||
{{EquipmentPage | {{EquipmentPage | ||
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage --> | |||
| image = | | image = | ||
| description = | | description = | ||
Line 77: | Line 87: | ||
| special = <!-- List of special features, bonuses, or abilities granted by the item. --> | | special = <!-- List of special features, bonuses, or abilities granted by the item. --> | ||
| where to find = | | where to find = | ||
| this is an example = yes | |||
}} | }} | ||
</pre> | </pre> | ||
Example follows. | |||
= Cool Armour = | |||
{{EquipmentPage | |||
| name = Cool Armour | |||
| 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 --> | |||
| <!-- Following are Armour- and Shield-related properties --> | |||
| armour class = 12 <!-- Leave EMPTY for non-Armour, 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 --> | |||
| <!-- Following are general properties, which should be filled in for ALL types of equipment. --> | |||
| 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. | |||
| this is an example = yes | |||
}} | |||
---- | |||
[[Category:Page Generating Templates]] [[Category:Equipment Page Templates]] | [[Category:Page Generating Templates]] [[Category:Equipment Page Templates]] | ||
Line 106: | Line 146: | ||
| yes = | | yes = | ||
| #default = {{#cargo_store: _table = equipment | | #default = {{#cargo_store: _table = equipment | ||
| name = {{#titleparts: {{PAGENAME}} }} | | name = {{{name | {{#titleparts: {{PAGENAME}} }} }}} | ||
| stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}} | | stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}} | ||
| rarity = {{IfEmpty | {{{rarity|}}} | common}} | | rarity = {{IfEmpty | {{{rarity|}}} | common}} | ||
Line 125: | Line 165: | ||
{ | { | ||
"params": { | "params": { | ||
"name": { | |||
"description": "Name of the item; can be left empty to automatically use the page name.", | |||
"example": "Amulet of Misty Step", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"image": { | "image": { | ||
"description": "The filename of the image/icon associated with this item.", | "description": "The filename of the image/icon associated with this item.", |
Revision as of 15:05, 6 August 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 <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage --> | image = | description = | quote = The in-game flavor text in the item's tooltip. | type = | proficiency = | armour class = | armour class bonus = | stealth disadvantage = | enchantment = | rarity = | weight kg = | weight lb = | price = | special = <!-- List of special features, bonuses, or abilities granted by the item. --> | where to find = | this is an example = yes }}
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
- Required Proficiency:
- Armour Class: 12 + Dexterity Modifier
- Uncommon Rarity:
- Weight: 4.5 kg / 9 lb
- Price: 600 gp
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 |
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 |