Template:Misc item page/doc: Difference between revisions
(Add 'bugs' parameter.) |
HiddenDragon (talk | contribs) mNo edit summary |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
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]], [[Instruments]], [[Containers]], 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: [[Arrows]], [[Books]], [[Coatings]], [[Elixirs]], [[Camp Supplies#Food|Food]], [[Camp Supplies#Drinks|Drinks]], [[Grenades]], [[Potions]], [[Scrolls]], [[Consumables]], [[Alchemy|Alchemical Ingredients]], [[Alchemy#Extractions|Alchemical Extracts]], [[Dyes]], [[Instruments]], [[Containers]], 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).''' | '''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).''' | ||
Line 23: | Line 23: | ||
<!-- Set this to "yes" if this is a book whose text contains spoiler, otherwise leave it empty. DON'T set it to "no". --> | <!-- 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 spoiler = | ||
<!-- Book or Note author. Leave empty if this is not a book or note. --> | |||
| book author = | |||
<!-- Book text body. Leave empty if this is not a book. --> | <!-- Book text body. Leave empty if this is not a book. --> | ||
Line 71: | Line 74: | ||
<!-- The fixed dc for this condition, if applicable --> | <!-- The fixed dc for this condition, if applicable --> | ||
| condition dc = | | condition dc = | ||
<!-- The radius to apply this condition in meters, if applicable --> | |||
| condition radius m = | |||
<!-- The area that is created when this item is destroyed or thrown. --> | |||
| area = | |||
<!-- The shape of the area (usually 'Radius') --> | |||
| area shape = | |||
<!-- The range of the area in meters --> | |||
| area range m = | |||
<!-- The range of the area in feet --> | |||
| area range ft = | |||
<!-- How long the created area lasts, in turns --> | |||
| area duration = | |||
<!-- Where to find / how to obtain this item in the game. --> | <!-- Where to find / how to obtain this item in the game. --> | ||
Line 93: | Line 114: | ||
| quote = | | quote = | ||
| book spoiler = | | book spoiler = | ||
| book author = | |||
| book text = | | book text = | ||
<!-- Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Instruments, Containers, Misc, Alchemical Ingredients, Alchemical Extracts, Dyes --> | <!-- Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Instruments, Containers, Misc, Alchemical Ingredients, Alchemical Extracts, Dyes --> | ||
Line 154: | Line 176: | ||
{{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 = Book Tome M Image.png | ||
| description = '''Book of Wisdom and Insight and Deep Knowledge''' is a common [[Books|Book]]. | | description = '''Book of Wisdom and Insight and Deep Knowledge''' is a common [[Books|Book]]. | ||
| quote = A weighty tome for sure. | | quote = A weighty tome for sure. | ||
| book spoiler = yes | | book spoiler = yes | ||
| book author = Volo | |||
| 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. | | 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. | ||
Line 274: | Line 297: | ||
<!-- 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 = Extract Earth 3 Icon.png | | image = Extract Earth 3 Icon.png | ||
| description = [[Salts of Example]] is a common [[ | | description = [[Salts of Example]] is a common [[Alchemy#Extractions|Alchemical Extract]] that can be used in [[Alchemy]] to create [[An Example Potion]]. | ||
| 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 = | ||
Line 370: | Line 393: | ||
] | ] | ||
}, | }, | ||
"book text": { | "book author": { | ||
"description": "The author of the book or note. Leave EMPTY for non-books - use \"quote\" parameter for tooltip flavour text.", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"book text": { | |||
"description": "The text within the book. Leave EMPTY for non-books - use \"quote\" parameter for tooltip flavour text.", | "description": "The text within the book. Leave EMPTY for non-books - use \"quote\" parameter for tooltip flavour text.", | ||
"type": "content", | "type": "content", | ||
Line 500: | Line 528: | ||
"condition2 save": {}, | "condition2 save": {}, | ||
"condition2 dc": {}, | "condition2 dc": {}, | ||
"condition2 duration": {} | "condition2 duration": {}, | ||
"area": {}, | |||
"area shape": {}, | |||
"area range m": {}, | |||
"area range ft": {}, | |||
"area duration": {} | |||
}, | }, | ||
"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, Instruments, Containers, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.", | "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, Instruments, Containers, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.", | ||
Line 512: | Line 545: | ||
"quote", | "quote", | ||
"book spoiler", | "book spoiler", | ||
"book author", | |||
"book text", | "book text", | ||
"where to find", | "where to find", | ||
Line 539: | Line 573: | ||
"condition2 dc", | "condition2 dc", | ||
"condition2 duration", | "condition2 duration", | ||
"area", | |||
"area shape", | |||
"area range m", | |||
"area range ft", | |||
"area duration", | |||
"special" | "special" | ||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> |
Latest revision as of 21:13, 10 September 2024
This template generates entire pages for individual items of the following types: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Alchemical Ingredients, Alchemical Extracts, Dyes, Instruments, Containers, 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 <!-- High-res image of the item. --> | image = <!-- A smaller, unfaded image of the item, used for the controller interface. Falls back to the value of "image" if not provided --> | controller icon = Longsword Unfaded.png <!-- An even smaller image of the item, to be used as an icon. Falls back to the value of "controller icon" if not provided --> | icon = Longsword Unfaded Icon.png <!-- 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 or Note author. Leave empty if this is not a book or note. --> | book author = <!-- 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, Instruments, Containers, 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 = <!-- List of special features, bonuses, or abilities granted by the item. --> | special = <!-- The condition applied by this consumable. Leave EMPTY for non-consumable items. --> | condition = <!-- The number of turns to apply this condition, can also use 'Long Rest' or 'Short Rest' --> | condition duration = <!-- The saving throw for this condition, if applicable --> | condition save = <!-- The fixed dc for this condition, if applicable --> | condition dc = <!-- The radius to apply this condition in meters, if applicable --> | condition radius m = <!-- The area that is created when this item is destroyed or thrown. --> | area = <!-- The shape of the area (usually 'Radius') --> | area shape = <!-- The range of the area in meters --> | area range m = <!-- The range of the area in feet --> | area range ft = <!-- How long the created area lasts, in turns --> | area duration = <!-- 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 = <!-- Any known bugs. Could be a single line or a list in wiki syntax. --> | bugs = }}
Copy-ready template:
{{MiscItemPage | image = | controller icon = | icon = | description = | quote = | book spoiler = | book author = | book text = <!-- Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Instruments, Containers, 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 = | uuid = <!-- 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 = | bugs = }}
Examples follow.
Arrow
Arrow of Shootythings is a legendary piece of Ammunition that does shooty-type things.
The in-game flavour text in the item's tooltip.
Properties
- Arrows
- Single Use
- Rarity: Legendary
- Weight: 0.3 kg / 0.6 lb
- Price: 36 gp
-
UID
OBJ_Arrow_Shooty_LegendaryUUID
3d99b0ae-4e96-438a-8029-cce11109f415
Effect
- Deal an additional 1d4Piercing damage to all creatures within the area of effect
- AoE: 2 m / 6 ft (Radius)
- Create an Awesome Surface
- Target creature also takes normal
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.
Bugs
- Totally broken on the latest patch. Yikes!
Book
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.
Text
Spoiler warning! This text might contain spoilers about the story of Baldur's Gate 3.
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.
Food
Delicious Apple is a common Food item that grants Camp Supplies for a Long Rest.
Super tasty!
Properties
- Food
- Camp Supplies: 5
- Rarity: Common
- Weight: 0.5 kg / 1 lb
- Price: 5 gp
Where to find
This is a made-up item. You cannot obtain it anywhere in the game, but food like this is quite common.
Scroll
Scroll of Castyspell is an uncommon Scroll that can be consumed to cast A Neat Spell.
The in-game flavour text in the item's tooltip.
Properties
- Scrolls
- Single Use
- Rarity: Uncommon
- Weight: 0.1 kg / 0.2 lb
- Price: 100 gp
Effect
- Consume the scroll to cast A Neat Spell
- (Refer to the spell's page to determine whether the scroll takes an Action or Bonus action to use.)
Where to find
This is a made-up item. You cannot obtain it anywhere in the game.
Potion
Potion of Stuff is an uncommon Potion that grants +1 to Stuff until the next Long Rest.
The in-game flavour text in the item's tooltip.
Properties
- Potions
- Single Use
- Rarity: Uncommon
- Weight: 0.5 kg / 1 lb
- Price: 100 gp
Effect
- Stuff +1 until next Long Rest
Where to find
This is a made-up item. You cannot obtain it anywhere in the game.
Alchemy Ingredient
Examplemoss is a common Alchemical Ingredient that can be used in Alchemy to create Salts of Example.
The in-game flavour text in the item's tooltip.
Properties
- Alchemical Ingredients
- Single Use
- Rarity: Common
- Weight: 0.1 kg / 0.2 lb
- Price: 25 gp
Effect
- Using alchemy, combine three Examplemoss to create Salts of Example
Where to find
This is a made-up item. You cannot obtain it anywhere in the game.
Alchemy Extract
Salts of Example is a common Alchemical Extract that can be used in Alchemy to create An Example Potion.
The in-game flavour text in the item's tooltip.
Properties
- Alchemical Extracts
- Single Use
- Rarity: Common
- Weight: 0.3 kg / 0.6 lb
- Price: 75 gp
Effect
- Using alchemy, combine with any Suspension to create An Example Potion
Where to find
This is a made-up item. You cannot obtain it anywhere in the game.
Miscellaneous Item
Ball is a common Miscellaneous Item.
The exterior of this toy ball is rough with tooth marks.
Properties
- Miscellaneous Items
- Rarity: Common
- Weight: 0.15 kg / 0.3 lb
- Price: 1 gp
Where to find
Crate is a common miscellaneous item. It is heavy and has little value and is primarily used for set-dressing.
Often hauled about by merchants and mongers.
Properties
- Containers
- Rarity: Common
- Weight: 10 kg / 20 lb
- Price: 1 gp
Where to find
Found throughout the game as set-dressing.
TemplateData documentation follows from this point on.
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, Instruments, Containers, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name | The name of the item; can be left empty if it's the page's name.
| String | suggested |
image | image | The filename of the image associated with this item, usually the image seen in tooltips.
| File | suggested |
controller icon | controller icon | The unfaded controller icon of this item. Defaults to the value of image= if not provided. | File | suggested |
icon | icon | The icon of this item. Defaults to the value of controller icon= if not provided. | File | required |
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 spoiler | book spoiler | 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".)
| String | optional |
book author | book author | The author of the book or note. Leave EMPTY for non-books - use "quote" parameter for tooltip flavour text. | 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: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Misc, Instruments, Container, Alchemical Ingredients, Alchemical Extracts, Dyes
| 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 |
uid | uid | 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". | String | optional |
uuid | uuid | The uuid or Root Template for the item. In a uuid format such as "3d99b0ae-4e96-438a-8029-cce11109f415". | String | optional |
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 (Arrows, Grenades, Consumables, Potions, Scrolls, some Drinks, and some Misc Items); otherwise leave BLANK.
| String | suggested |
seo description | seo description | no description | Unknown | optional |
notes | notes | Any additional notes about this item. | Content | optional |
bugs | bugs | Any known bugs about this item. | Content | optional |
this is an example | this is an example | no description | Unknown | optional |
rarity honour | rarity honour | The rarity in Honour Mode, if it is different. | Unknown | optional |
price honour | price honour | The price in Honour Mode, if it is different. | Unknown | optional |
condition | condition | no description | Unknown | optional |
condition save | condition save | no description | Unknown | optional |
condition dc | condition dc | no description | Unknown | optional |
condition duration | condition duration | no description | Unknown | optional |
condition2 | condition2 | no description | Unknown | optional |
condition2 save | condition2 save | no description | Unknown | optional |
condition2 dc | condition2 dc | no description | Unknown | optional |
condition2 duration | condition2 duration | no description | Unknown | optional |
area | area | no description | Unknown | optional |
area shape | area shape | no description | Unknown | optional |
area range m | area range m | no description | Unknown | optional |
area range ft | area range ft | no description | Unknown | optional |
area duration | area duration | no description | Unknown | optional |
special | special | List of special features, bonuses, or abilities granted by the item.
| Content | suggested |