Ad placeholder

Template:Misc item page: Difference between revisions

Jump to navigation Jump to search

Template:Misc item page (view source)

Revision as of 14:03, 22 October 2023

16,175 bytes removed ,  22 October 2023
move docs out
m (fix display)
(move docs out)
Line 100: Line 100:
|image={{{image|}}}
|image={{{image|}}}
|rarity={{#if:{{{rarity|}}}|{{{rarity}}}|common}}
|rarity={{#if:{{{rarity|}}}|{{{rarity}}}|common}}
}}</includeonly><noinclude>
}}</includeonly><noinclude>{{/doc}}</noinclude>
 
<!--
 
    ==== Documentation follows ====
 
-->
This template generates entire pages for individual items of the following types: [[Arrows]], [[Books]], [[Coatings]], [[Elixirs]], [[Camp Supplies#Food|Food]], [[Camp Supplies#Drinks|Drinks]], [[Grenades]], [[Potions]], [[Scrolls]], [[Consumables]], [[Alchemy|Alchemical Ingredients]], [[Alchemy|Alchemical Extracts]], [[Dyes]], 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>
{{MiscItemPage
 
<!-- High-res image of the item. -->
| image =
 
<!-- Low-res, small image of the item. Used with the ItemIcon template. -->
| icon =
 
<!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| description =
 
<!-- In-game tooltip quote. -->
| quote =
 
<!-- Set this to "yes" if this is a book whose text contains spoiler, otherwise leave it empty.  DON'T set it to "no". -->
| book spoiler =
 
<!-- Book text body.  Leave empty if this is not a book. -->
| book text =
 
<!-- Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Misc, Alchemical Ingredients, Alchemical Extracts, Dyes -->
| type =
 
<!-- Number of Camp Supplies. Leave EMPTY for all except Food and Drinks. -->
| camp supplies =
 
<!-- Set to "yes" if this is a single-use item like a potion or special arrow, otherwise leave EMPTY. -->
| single use =
 
<!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| rarity =
 
<!-- Weight in kg and in lb. -->
| weight kg =
| weight lb =
 
<!-- Price in gp as shown in the tooltip (NOT while buying or selling). -->
| price =
 
<!-- The UID of the item. Is a string similar to OBJ_ItemName_OtherSubName. -->
| uid =
<!-- The UUID or Root Template of the item. Is a string in format like "3d99b0ae-4e96-438a-8029-cce11109f415" -->
| uuid =
 
<!-- The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items. -->
| usage cost =
 
<!-- The effect(s) of the item when used or consumed. Leave EMPTY for non-consumable items. -->
| effect =
 
<!-- Where to find / how to obtain this item in the game. -->
| where to find =
 
<!-- Any additional notes.  Could be a single line or a list in wiki syntax. -->
| notes =
 
}}
</pre>
 
Copy-ready template:
<pre>
{{MiscItemPage
| image =
| icon =
| description =
| quote =
| book spoiler =
| book text =
<!-- Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Misc, Alchemical Ingredients, Alchemical Extracts, Dyes -->
| type =
| camp supplies =
| single use =
<!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| rarity =
| weight kg =
| weight lb =
| price =
| uid =
<!-- The cost to use the item. Choose from: action, bonus action - or leave EMPTY for non-consumable items. -->
| usage cost =
| effect =
| where to find =
| notes =
}}
</pre>
 
[[Category:Page generating templates]] [[Category:Item Page Templates]]
 
Examples follow.
 
= Arrow =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Ammunition Arrow Icon.png
| description = {{legendary|Arrow of Shootythings}} is a legendary piece of [[Ammunition]] that does shooty-type things.
| quote = The in-game flavour text in the item's tooltip.
| type = Arrows
| camp supplies =
| single use = yes
| rarity = legendary
| weight kg = 0.3
| weight lb = 0.7
| price = 36
| usage cost = action
| uid = OBJ_Arrow_Shooty_Legendary
| uuid = 3d99b0ae-4e96-438a-8029-cce11109f415
| effect =
* Deal an additional {{DamageText|1d4|Piercing}} damage to all creatures within the area of effect
* {{AOE|m=2|ft=6|Radius}}
* Create an [[Awesome Surface]]
* Target creature also takes normal {{code|Weapon Damage}} if the attack hits
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game.
| notes =
* Interesting additional fact.
* Another interesting additional fact.
| this is an example = yes
}}
 
= Book =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Book_WizardyGenericG.png
| description = '''Book of Wisdom and Insight and Deep Knowledge''' is a common [[Books|Book]].
| quote = A weighty tome for sure.
| book spoiler = yes
| book text = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Tempor commodo ullamcorper a lacus vestibulum sed arcu non. Lacus laoreet non curabitur gravida arcu ac. Massa sapien faucibus et molestie ac feugiat sed. In dictum non consectetur a. Ultrices neque ornare aenean euismod elementum nisi quis. Non arcu risus quis varius quam quisque. Quis eleifend quam adipiscing vitae proin sagittis nisl rhoncus. Turpis egestas pretium aenean pharetra. Mollis aliquam ut porttitor leo a diam sollicitudin tempor id. Fames ac turpis egestas integer eget aliquet nibh praesent tristique. Proin nibh nisl condimentum id. Tortor id aliquet lectus proin. Nunc consequat interdum varius sit amet mattis vulputate enim nulla.
 
Et ligula ullamcorper malesuada proin libero nunc consequat interdum. Pharetra magna ac placerat vestibulum lectus mauris ultrices eros. Augue neque gravida in fermentum et sollicitudin ac. Ultrices gravida dictum fusce ut placerat orci. At tellus at urna condimentum mattis pellentesque. Arcu risus quis varius quam quisque. Tellus cras adipiscing enim eu. Lacinia at quis risus sed vulputate odio ut enim. Orci a scelerisque purus semper eget duis at tellus at. Elit duis tristique sollicitudin nibh sit amet. Volutpat consequat mauris nunc congue. Aliquam malesuada bibendum arcu vitae elementum curabitur vitae. Aliquet nec ullamcorper sit amet risus nullam.
 
Senectus et netus et malesuada fames ac turpis egestas. Tincidunt id aliquet risus feugiat in ante. Mus mauris vitae ultricies leo integer malesuada. Netus et malesuada fames ac turpis egestas integer eget. Adipiscing elit pellentesque habitant morbi. Feugiat in fermentum posuere urna nec. Sit amet commodo nulla facilisi nullam vehicula ipsum a. Fermentum posuere urna nec tincidunt praesent semper feugiat nibh sed. Sed libero enim sed faucibus turpis in eu mi. Gravida neque convallis a cras semper auctor neque. Vitae aliquet nec ullamcorper sit amet risus nullam eget felis. Sollicitudin nibh sit amet commodo nulla. Sit amet volutpat consequat mauris nunc. Enim ut tellus elementum sagittis. Quam id leo in vitae. Vitae proin sagittis nisl rhoncus mattis.
| type = Books
| camp supplies =
| rarity = common
| weight kg = 0.5
| weight lb = 1.1
| price = 10
| usage cost =
| effect =
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game. If you could, it would probably be on some wizard's bookshelf.
| this is an example = yes
}}
 
= Food =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Food Icon.png
| description = '''Delicious Apple''' is a common [[Camp Supplies#Food|Food]] item that grants [[Camp Supplies]] for a [[Long Rest]].
| quote = Super tasty!
| book text =
| type = Food
| camp supplies = 5
| rarity = common
| weight kg = 0.5
| weight lb = 1.1
| price = 5
| usage cost =
| effect =
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game, but food like this is quite common.
| this is an example = yes
}}
 
= Scroll =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Scroll of Revivify.png
| description = {{uncommon|Scroll of Castyspell}} is an uncommon [[Scrolls|Scroll]] that can be consumed to cast [[A Neat Spell]].
| quote = The in-game flavour text in the item's tooltip.
| book text =
| type = Scrolls
| camp supplies =
| single use = yes
| rarity = uncommon
| weight kg = 0.1
| weight lb = 0.2
| price = 100
| usage cost = action
| effect =
* Consume the scroll to cast {{SmallIcon|Magic Missile Icon.png}} [[A Neat Spell]]
* (Refer to the spell's page to determine whether the scroll takes an {{action}} or {{action|bonus}} to use.)
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game.
| this is an example = yes
}}
 
= Potion =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Potion_A_Icon.png
| description = {{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff until the next [[Long Rest]].
| quote = The in-game flavour text in the item's tooltip.
| book text =
| type = Potions
| camp supplies =
| single use = yes
| rarity = uncommon
| weight kg = 0.5
| weight lb = 1.1
| price = 100
| usage cost = bonus action
| effect =
* Stuff +1 until next [[Long Rest]]
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game.
| this is an example = yes
}}
 
= Alchemy Ingredient =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Weavemoss Icon.png
| description = [[Examplemoss]] is a common [[Alchemical Ingredients|Alchemical Ingredient]] that can be used in [[Alchemy]] to create [[Salts of Example]].
| quote = The in-game flavour text in the item's tooltip.
| book text =
| type = Alchemical Ingredients
| camp supplies =
| single use = yes
| rarity = common
| weight kg = 0.1
| weight lb = 0.2
| price = 25
| usage cost =
| effect =
* Using alchemy, combine three {{SmallIcon|Weavemoss Icon.png}} [[Examplemoss]] to create {{SmallIcon|Extract Earth 3 Icon.png}} [[Salts of Example]]
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game.
| this is an example = yes
}}
 
= Alchemy Extract =
 
{{MiscItemPage
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:MiscItemPage -->
| image = Extract Earth 3 Icon.png
| description = [[Salts of Example]] is a common [[Alchemical Extracts|Alchemical Extract]] that can be used in [[Alchemy]] to create [[An Example Potion]].
| quote = The in-game flavour text in the item's tooltip.
| book text =
| type = Alchemical Extracts
| camp supplies =
| single use = yes
| rarity = common
| weight kg = 0.3
| weight lb = 0.6
| price = 75
| usage cost =
| effect =
* Using alchemy, combine with any [[Alchemy#Extractions|Suspension]] to create {{SmallIcon|Potion of Healing Icon.png}} [[An Example Potion]]
| where to find =
This is a made-up item. You cannot obtain it anywhere in the game.
| this is an example = yes
}}
 
----
 
TemplateData documentation follows from this point on.
 
----
 
<templatedata>
{
"params": {
"name": {
"description": "The name of the item; can be left empty if it's the page's name.",
"example": "Potion of Fire Resistance",
"type": "string",
"suggested": true
},
"image": {
"description": "The filename of the image associated with this item, usually the image seen in tooltips.",
"example": "Potion of Fire Resistance Faded.png",
"type": "wiki-file-name",
"suggested": true
},
"description": {
"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.",
"type": "content",
"required": true,
"suggested": true
},
"quote": {
"description": "The in-game flavour text in the item's tooltip.",
"type": "content",
"suggested": true
},
"book spoiler": {
"description": "Whether the book text section should be wrapped in a collapsible spoiler box.  Use \"yes\" to enable, leave BLANK to disable.  (Never actually type in \"no\".)",
"type": "string",
"suggestedvalues": [
"yes",
""
]
},
"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",
"suggested": true
},
"type": {
"description": "Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Misc, Alchemical Ingredients, Alchemical Extracts, Dyes",
"type": "string",
"suggestedvalues": [
"Arrows",
"Books",
"Coatings",
"Elixirs",
"Food",
"Grenades",
"Drinks",
"Potions",
"Scrolls",
"Consumables",
"Misc",
"Alchemical Ingredients",
"Alchemical Extracts",
"Dyes"
],
"required": true,
"suggested": true
},
"camp supplies": {
"description": "Number of Camp Supplies. Leave EMPTY for all except Food and Drinks.",
"type": "number",
"suggested": true
},
"rarity": {
"description": "Rarity of the item. Choose from: common, uncommon, rare, very rare, legendary, story",
"type": "string",
"suggestedvalues": [
"common",
"uncommon",
"rare",
"very rare",
"legendary",
"story"
],
"default": "common",
"autovalue": "common",
"required": true
},
"weight kg": {
"description": "Weight of the item in kilograms",
"type": "number",
"required": true
},
"weight lb": {
"description": "Weight of the item in pounds",
"type": "number",
"required": true
},
"price": {
"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",
"required": true
},
"effect": {
"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",
"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
},
"single use": {
"type": "string",
"description": "\"yes\" if item is consumed on use (Arrows, Grenades, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.",
"suggestedvalues": [
"yes"
],
"suggested": true
},
"icon": {
"description": "The image to use as an icon, usually the image used in UI elements such as inventories. If blank, will fall back to image.",
"example": "Potion of Fire Resistance Unfaded Icon.png",
"type": "wiki-file-name",
"suggested": true
},
"seo description": {},
"uid": {
"description": "UID for the item. Is a string in a format similar to \"OBJ_ItemName_SomeSubName\". It is NOT a uuid, in the format \"a3859470-8d1b-40f5-9ca3-8a73fa9a592b\".",
"type": "string"
},
"notes": {},
"this is an example": {},
"uuid": {
"description": "The uuid or Root Template for the item. In a uuid format such as \"3d99b0ae-4e96-438a-8029-cce11109f415\".",
"type": "string"
}
},
"description": "This template generates entire pages for individual items of the following types: Arrows, Books, Coatings, Elixirs, Food, Grenades, Drinks, Potions, Scrolls, Consumables, Alchemical Ingredients, Alchemical Extracts, Dyes, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.",
"format": "block",
"paramOrder": [
"name",
"image",
"icon",
"description",
"quote",
"book spoiler",
"book text",
"where to find",
"type",
"camp supplies",
"rarity",
"weight kg",
"weight lb",
"price",
"uid",
"uuid",
"effect",
"usage cost",
"single use",
"seo description",
"notes",
"this is an example"
]
}
</templatedata></noinclude>
Retrieved from "https://bg3.wiki/wiki/Special:MobileDiff/96555"

Navigation menu