Template:Misc item page: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<includeonly>{{#if: {{{image|}}} | [[File:{{{image}}}|frameless|right]] }}
<includeonly>{{PageSeo
{{#seo:
| type = article
| image = {{{image|}}}
| image = {{{image|}}}
| description = {{MiscItemPage/Description
| description = {{MiscItemPage/Description
Line 8: Line 6:
   }}
   }}
}}
}}
{{{description}}}
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-{{#if: {{{rarity|}}}
{{#if:{{{quote|}}}|
| {{#replace: {{{rarity}}} | <nowiki> </nowiki> | }}
| common
}}"> {{#if: {{{image|}}} | [[File:{{{image}}}|frameless|right]] }}
 
{{{description}}} {{#if: {{{quote|}}} | {{blank}}
 
{{quote|{{{quote|Missing quote ... imagine some nice flavour text here.}}}}}
{{quote|{{{quote|Missing quote ... imagine some nice flavour text here.}}}}}
}}
}}
{{#if:{{{where to find|}}}|
 
== Where to Find ==
{{{where to find}}}
}}
{{#if:{{{book text|}}}|
== Text ==
{{quote|size=100%|noitalics=yes|{{{book text}}}}}
}}
== Properties ==
== Properties ==
* {{#switch: {{{type|}}}
* {{#switch: {{{type|}}}
| Ammunition = {{SmallIcon|Ammunition Icon.png}} [[Ammunition]]
| Ammunition = {{SmallIcon|Ammunition Icon.png}} [[Ammunition]]
Line 37: Line 35:
* {{Rarity | {{{rarity|common}}} }}
* {{Rarity | {{{rarity|common}}} }}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Price | {{{price}}} }}
* {{Price | {{{price}}} }} {{#if: {{{effect|}}} | {{blank}}
{{#if: {{{effect|}}} |
 
=== Effect ===
=== Effect ===
{{#switch: {{{usage cost|}}}
{{#switch: {{{usage cost|}}}
| action = {{InfoBlob|{{action}}}}
| action = {{InfoBlob|{{action}}}}
Line 46: Line 45:
}}
}}
{{{effect}}}
{{{effect}}}
}}</div> {{#if: {{{where to find|}}} | {{blank}}
== Where to Find ==
<div class="bg3wiki-tooltip-box">
{{{where to find}}}
</div>
}} {{#if: {{{book text|}}} | {{blank}}
== Text ==
<div class="bg3wiki-tooltip-box">
{{quote | size = 100% | noitalics = yes | {{{book text}}} }}
</div>
}}
}}



Revision as of 15:12, 6 August 2023

This template generates entire pages for individual items of the following types: Ammunition, Books, Camp Supplies#Food, Camp Supplies#Drinks, Potions, Scrolls, Consumables, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.

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

{{MiscItemPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = 
| description = 
| quote = The in-game flavour text in the item's tooltip.
| book text = 
| type = 
| camp supplies = 
| single use = 
| rarity = 
| weight kg = 
| weight lb = 
| price = 
| usage cost = 
| effect = 
| where to find = 
}}

Examples of template usage for various types of items: Template:MiscItemPage/Example, Template:MiscItemPage/AmmunitionExample, Template:MiscItemPage/BooksExample, Template:MiscItemPage/FoodExample, Template:MiscItemPage/ScrollsExample

TemplateData documentation follows from this point on.


This template generates entire pages for individual items of the following types: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
imageimage

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

Example
Potion of Fire Resistance Icon.png
Filesuggested
descriptiondescription

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

Example
{{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff.
Contentrequired
quotequote

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

Contentsuggested
book textbook text

The text within the book. Leave EMPTY for non-books - use "quote" parameter for tooltip flavour text.

Contentsuggested
where to findwhere to find

Describe where and how to obtain the item.

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

Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc

Suggested values
Ammunition Books Food Drinks Potions Scrolls Consumables Misc
Stringrequired
camp suppliescamp supplies

Number of Camp Supplies. Leave EMPTY for all except Food and Drinks.

Numbersuggested
rarityrarity

Rarity of the item. Choose from: common, uncommon, rare, very rare, legendary, story

Suggested values
common uncommon rare very rare legendary story
Default
common
Auto value
common
Stringrequired
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
effecteffect

The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items.

Example
* Grants +1 to [[Stuff]] until next [[Long Rest]]
Contentsuggested
usage costusage cost

The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items.

Suggested values
action bonus action
Stringsuggested
single usesingle use

"yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.

Suggested values
yes
Stringsuggested