Template:Misc item page: Difference between revisions
m (convert action/bonus action to new InfoBlob template) |
(add new "single use" parameter to clarify which items are consumable) |
||
Line 26: | Line 26: | ||
| #default = [[{{{type}}}]] }} {{#if: {{{camp supplies|}}}| | | #default = [[{{{type}}}]] }} {{#if: {{{camp supplies|}}}| | ||
* {{Camp Supplies}}: {{{camp supplies}}} | * {{Camp Supplies}}: {{{camp supplies}}} | ||
}} {{#if: {{{single use|}}}| | |||
* {{SmallIcon|Consumables Icon.png}} Single Use | |||
}} | }} | ||
* {{Rarity | {{{rarity|common}}} }} | * {{Rarity | {{{rarity|common}}} }} | ||
Line 63: | Line 65: | ||
| type = Potions <!-- Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc --> | | type = Potions <!-- Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc --> | ||
| camp supplies = <!-- Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. --> | | camp supplies = <!-- Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. --> | ||
| single use = <!-- "yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK. --> | |||
| rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story --> | | rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story --> | ||
| weight kg = 0.5 | | weight kg = 0.5 | ||
Line 178: | Line 181: | ||
"action", | "action", | ||
"bonus action" | "bonus action" | ||
], | |||
"suggested": true | |||
}, | |||
"single use": { | |||
"type": "string", | |||
"description": "\"yes\" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.", | |||
"suggestedvalues": [ | |||
"yes" | |||
], | ], | ||
"suggested": true | "suggested": true |
Revision as of 11:34, 18 February 2023
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.
Following is an example of usage with all possible template parameters shown. This describes a completely made-up potion.
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.
{{MiscItemPage | <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage --> | image = Potion of Poison Resistance Icon.png | description = {{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff until the next [[Long Rest]]. <!-- 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 flavour text in the item's tooltip. | book text = <!-- The text of the book. Leave EMPTY for non-books - use "quote" parameter for all other item types. --> | type = Potions <!-- Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc --> | camp supplies = <!-- Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. --> | single use = <!-- "yes" if item is consumed on use (Ammunition, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK. --> | rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story --> | weight kg = 0.5 | weight lb = 1.1 | price = 100 | usage cost = bonus action <!-- The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items. --> | effect = <!-- The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items. --> * Stuff +1 until next [[Long Rest]] | where to find = <!-- Describe where and how to obtain the item. --> This is a made-up item. You cannot obtain it anywhere in the game. }}
See here for the result of the above: Template:MiscItemPage/Example
Additional examples for other items types: Template:MiscItemPage/AmmunitionExample, Template:MiscItemPage/BooksExample, Template:MiscItemPage/FoodExample, Template:MiscItemPage/ScrollsExample
Auto-generated TemplateData 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 |