Template:Misc item page: Difference between revisions
mNo edit summary |
m (rework special/effect section and add usage cost parameter) |
||
Line 30: | Line 30: | ||
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }} | * {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }} | ||
* {{Price | {{{price}}} }} | * {{Price | {{{price}}} }} | ||
{{#if: {{{ | {{#if: {{{effect|}}} | | ||
=== | === Effect === {{#switch: {{{usage cost|}}} | ||
| action = {{action}} | |||
{{{ | | bonus action = {{action|bonus}} | ||
| #default = | |||
}}Effect: | |||
{{{effect}}} | |||
}} | }} | ||
Line 63: | Line 66: | ||
| weight lb = 1.1 | | weight lb = 1.1 | ||
| price = 100 | | 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]] | * Stuff +1 until next [[Long Rest]] | ||
| where to find = <!-- Describe where and how to obtain the item. --> | | where to find = <!-- Describe where and how to obtain the item. --> | ||
Line 88: | Line 92: | ||
"description": "This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.", | "description": "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.", | "example": "{{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff.", | ||
"type": " | "type": "content", | ||
"required": true, | "required": true, | ||
"suggested": true | "suggested": true | ||
Line 94: | Line 98: | ||
"quote": { | "quote": { | ||
"description": "The in-game flavour text in the item's tooltip.", | "description": "The in-game flavour text in the item's tooltip.", | ||
"type": " | "type": "content", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
Line 159: | Line 163: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "effect": { | ||
"description": " | "description": "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]]", | "example": "* Grants +1 to [[Stuff]] until next [[Long Rest]]", | ||
"type": "content", | "type": "content", | ||
"suggested": true | |||
}, | |||
"usage cost": { | |||
"description": "The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items.", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"action", | |||
"bonus action" | |||
], | |||
"suggested": true | "suggested": true | ||
} | } |
Revision as of 12:32, 17 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. --> | 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
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 |