Template:Misc item page: Difference between revisions

<includeonly>[[File:{{{image}}}|frameless|right]]

{{#seo: | image = {{{image}}}

| description = {{MiscItemPage/Description

   }}

== Properties ==

| Ammunition = {{SmallIcon|Ammunition Icon.png}} [[Ammunition]]

| Potions = {{Potions}}

| Misc = Miscellaneous Items

| #default = [[{{{type}}}]] }} {{#if: {{{camp supplies|}}}|

}} {{#if: {{{single use|}}}|

}}

* {{Rarity | {{{rarity|common}}} }}

* {{Price | {{{price}}} }}

=== Effect ===

| action = {{InfoBlob|{{action}}}}

| bonus action = {{InfoBlob|{{action|bonus}}}}

| #default = [[Category:{{{type}}}{{#ifeq: {{{type}}} | Misc | Items | }}]] [[Category:{{{rarity|common}}} Items]]

-->

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

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.

| <!-- 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 -->

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

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

| where to find = <!-- Describe where and how to obtain the item. -->

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.

[[Category:Item Page Templates]]<templatedata>

{

"params": {

"image": {

"description": {

"example": "{{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff.",

"type": "content",

"required": true,

"quote": {

"type": "content",

},

"book text": {

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

"type": "content",

"suggested": true

"where to find": {

"description": "Describe where and how to obtain the item.",

"example": "Looted from [[NPC]] in [[Location]].",

"type": "content",

},

"type": {

"type": "string",

"suggestedvalues": [

"required": true,

},

"camp supplies": {

},

"rarity": {

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

},

"weight kg": {

"description": "Weight of the item in kilograms",

"description": "Weight of the item in pounds",

"type": "number",

},

"description": "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.",

"type": "number",

},

"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]]",

"type": "content",

},

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

"type": "string",

"action",

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

}

</templatedata></noinclude>