Template:Misc item page: Difference between revisions
No edit summary |
m (blank the template example code, since all parameter documentation can already be found on this page.) |
||
Line 58: | Line 58: | ||
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|Miscellaneous Items]]. For Weapons, see [[:Template:WeaponPage]]. For Equipment, see [[:Template:EquipmentPage]]. | 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|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).''' | |||
<pre> | <pre> | ||
{{MiscItemPage | {{MiscItemPage | ||
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage --> | | <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage --> | ||
| image = | | image = | ||
| description = | | description = | ||
| quote = The in-game flavour text in the item's tooltip. | | quote = The in-game flavour text in the item's tooltip. | ||
| book text = | | book text = | ||
| type = | | type = | ||
| camp supplies = | | camp supplies = | ||
| single use = | | single use = | ||
| rarity = | | rarity = | ||
| weight kg = | | weight kg = | ||
| weight lb = | | weight lb = | ||
| price = | | price = | ||
| usage cost = | | usage cost = | ||
| effect = | | effect = | ||
| where to find = | |||
| where to find = | |||
}} | }} | ||
</pre> | </pre> | ||
Examples of template usage for various types of items: [[Template:MiscItemPage/Example]], [[Template:MiscItemPage/AmmunitionExample]], [[Template:MiscItemPage/BooksExample]], [[Template:MiscItemPage/FoodExample]], [[Template:MiscItemPage/ScrollsExample]] | |||
[[Category:Page Generating Templates]] [[Category:Item Page Templates]] | [[Category:Page Generating Templates]] [[Category:Item Page Templates]] | ||
TemplateData documentation follows from this point on. | |||
---- | ---- |
Revision as of 21:37, 2 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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
image | image | The filename of the image/icon associated with this item.
| File | suggested |
description | description | This is 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 |
book text | book text | The text within the book. Leave EMPTY for non-books - use "quote" parameter for tooltip flavour text. | Content | suggested |
where to find | where to find | Describe where and how to obtain the item.
| Content | suggested |
type | type | Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc
| String | required |
camp supplies | camp supplies | Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. | Number | suggested |
rarity | rarity | Rarity of the item. Choose from: common, uncommon, rare, very rare, legendary, story
| String | required |
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 |
effect | effect | The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items.
| Content | suggested |
usage cost | usage cost | The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items.
| String | suggested |
single use | single use | "yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.
| String | suggested |