Template:Equipment page

From bg3.wiki
Revision as of 09:19, 1 December 2023 by Nattern (talk | contribs) (Added Condition documentation to <templatedata>)
Jump to navigation Jump to search

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 =

<!-- Conditions given by this piece of equipment. -->
| condition = Dazed
| condition duration = 10
| condition save = WIS
| condition dc = 13
| condition2 = Prone
| condition2 duration = 1
| condition2 save =
| condition2 dc = 

<!-- 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 =
| condition =
| condition duration = 
| condition save =
| condition dc = 
| condition2 =
| condition2 duration = 
| condition2 save =
| condition2 dc =
| where to find =
}}

Example follows.

Cool Armour

Equipment page image

Cool Armour is an uncommon Light Armour that increases Strength Saving Throws and allows the wearer to cast a neat spell.

Description Icon.png

The in-game flavor text in the item's tooltip.

Properties

  • Light Armour Light Armour
  • Proficiency Icon.png Required Proficiency: Light Armour Light Armour
  • Rarity: Uncommon
  •  Weight: 4.5 kg / 9 lb
  • Price: 600 gp
  • UID MAG_Cool_LeatherArmour_1
    UUID 13776348-0101-446e-a9f8-c95efb3763ca

Special

The wearer of this item gains:

Where to find

This is a made-up piece of equipment. You cannot obtain it anywhere in the game.


Cool Shield

Equipment page image

Cool shield is an uncommon Shield that allows the wearer to cast a ton of spells.

Description Icon.png

The in-game flavor text in the item's tooltip.

Properties

  • Shields Shields
  • Proficiency Icon.png Required Proficiency: Shields Shields
  • Rarity: Uncommon
  •  Weight: 4.5 kg / 9 lb
  • Price: 600 gp

Special

The wearer of this item gains:

Condition: Wet

Wet Wet

Duration: 2 turns

Condition: Prone

Prone Prone

Duration: Until Long rest

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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

Name of the item; can be left empty to automatically use the page name.

Example
Amulet of Misty Step
Stringsuggested
imageimage

The filename of the image/icon associated with this item.

Example
Amulet of Misty Step Icon.png
Filesuggested
iconicon

The icon for the item. Falls back to "image" if not specified.

Unknownoptional
descriptiondescription

The first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.

Example
{{uncommon|Amulet of Misty Step}} is an uncommon [[Amulets|Amulet]] that allows the wearer to cast [[Misty Step]].
Contentrequired
quotequote

The in-game flavour text in the item's tooltip.

Contentsuggested
where to findwhere to find

Describe where and how to obtain the item.

Example
Looted from [[NPC Name]] in [[Location]].
Contentsuggested
typetype

Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments

Suggested values
Clothing Light Armour Medium Armour Heavy Armour Shields Amulets Boots Cloaks Gloves Helmets Rings Camp Clothes Camp Shoes Undergarments
Stringrequired
proficiencyproficiency

Leave EMPTY if no proficiency required, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields

Suggested values
Light Armour Medium Armour Heavy Armour Shields
Stringsuggested
armour classarmour class

Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip.

Example
12
Numbersuggested
armour class bonusarmour class bonus

Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4

Example
+2
Stringsuggested
stealth disadvantagestealth disadvantage

Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no!

Suggested values
yes
Stringsuggested
rarityrarity

Choose from: common, uncommon, rare, very rare, legendary, story

Suggested values
common uncommon rare very rare legendary story
Stringrequired
enchantmentenchantment

The enchantment value on the item. Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5

Example
+1
Stringsuggested
weight kgweight kg

Weight of the item in kilograms

Numberrequired
weight lbweight lb

Weight of the item in pounds

Numberrequired
priceprice

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.

Numberrequired
uiduid

The uid for the item. In format OBJ_Someitem_Whatever.

Stringoptional
uuiduuid

The uuid or Root Template of the item. In format 13776348-0101-446e-a9f8-c95efb3763ca

Stringoptional
specialspecial

List of special features, bonuses, or abilities granted by the item.

Example
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
Contentsuggested
conditioncondition

The full name of the condition (if any) that this action applies to its target/s. Leave blank if there is no condition.

Example
Hastened
Stringoptional
condition durationcondition duration

The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.

Example
5
Numberoptional
condition savecondition save

The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition dccondition dc

The optional fixed DC of the condition that targets have to pass to apply it

Example
12
Numberoptional
condition2condition2

The full name of the condition (if any) that is applied if there is a second condition.

Example
Hastened
Stringoptional
condition2 durationcondition2 duration

The duration in turns of the action's second condition. Leave blank if the duration is unlimited.

Example
5
Numberoptional
condition2 savecondition2 save

The save that the action's target must roll to avoid or reduce the effects of the second condition. Can use short or long name, e.g: "STR" or "Strength"

Suggested values
Strength Dexterity Constitution Intelligence Wisdom Charisma
Example
WIS
Stringoptional
condition2 dccondition2 dc

The optional fixed DC of the second condition that targets have to pass to apply it

Example
12
Numberoptional