Template:Misc item page/doc: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Updated doc for area parameters)
mNo edit summary
Line 515: Line 515:
"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 554: Line 559:
"condition2 dc",
"condition2 dc",
"condition2 duration",
"condition2 duration",
        "area",
        "area shape",
        "area range m",
        "area range ft",
        "area duration",
         "special"
         "special"
]
]
}
}
</templatedata>
</templatedata>

Revision as of 15:59, 6 May 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 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 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 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

Misc item page/doc image

Arrow of Shootythings is a legendary piece of Ammunition that does shooty-type things.

Description Icon.png

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_Legendary
    UUID 3d99b0ae-4e96-438a-8029-cce11109f415

Effect

Action

  • Deal an additional 1d4Damage TypesPiercing 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

Misc item page/doc image

Book of Wisdom and Insight and Deep Knowledge is a common Book.

Description Icon.png

A weighty tome for sure.

Properties

  • Books
  • Rarity: Common / UncommonHHonour
  •  Weight: 0.5 kg / 1 lb
  • Price: 10 gp / 100 gpHHonour


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

Books Icon.png 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

Misc item page/doc image

Delicious Apple is a common Food item that grants Camp Supplies for a Long Rest.

Description Icon.png

Super tasty!

Properties


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

Misc item page/doc image

Scroll of Castyspell is an uncommon Scroll that can be consumed to cast A Neat Spell.

Description Icon.png

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

Action

Where to find

This is a made-up item. You cannot obtain it anywhere in the game.

Potion

Misc item page/doc image

Potion of Stuff is an uncommon Potion that grants +1 to Stuff until the next Long Rest.

Description Icon.png

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

Bonus action

Where to find

This is a made-up item. You cannot obtain it anywhere in the game.

Alchemy Ingredient

Misc item page/doc image

Examplemoss is a common Alchemical Ingredient that can be used in Alchemy to create Salts of Example.

Description Icon.png

The in-game flavour text in the item's tooltip.

Properties

Effect

Where to find

This is a made-up item. You cannot obtain it anywhere in the game.

Alchemy Extract

Misc item page/doc image

Salts of Example is a common Alchemical Extract that can be used in Alchemy to create An Example Potion.

Description Icon.png

The in-game flavour text in the item's tooltip.

Properties

Effect

Where to find

This is a made-up item. You cannot obtain it anywhere in the game.

Miscellaneous Item

Misc item page/doc image

Ball is a common Miscellaneous Item.

Description Icon.png

The exterior of this toy ball is rough with tooth marks.

Properties


Where to find

On a pillow in Gales tent at Camp.

Misc item page/doc image

Crate is a common miscellaneous item. It is heavy and has little value and is primarily used for set-dressing.

Description Icon.png

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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename

The name of the item; can be left empty if it's the page's name.

Example
Potion of Fire Resistance
Stringsuggested
imageimage

The filename of the image associated with this item, usually the image seen in tooltips.

Example
Potion of Fire Resistance Faded.png
Filesuggested
controller iconcontroller icon

The unfaded controller icon of this item. Defaults to the value of image= if not provided.

Filesuggested
iconicon

The icon of this item. Defaults to the value of controller icon= if not provided.

Filerequired
descriptiondescription

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

The in-game flavour text in the item's tooltip.

Contentsuggested
book spoilerbook 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".)

Suggested values
yes
Stringoptional
book textbook text

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

Contentsuggested
where to findwhere to find

Describe where and how to obtain the item.

Example
Looted from [[NPC]] in [[Location]].
Contentsuggested
typetype

Item type. Choose one of: Arrows, Books, Coatings, Elixirs, Food, Drinks, Grenades, Potions, Scrolls, Consumables, Misc, Instruments, Container, Alchemical Ingredients, Alchemical Extracts, Dyes

Suggested values
Arrows Books Coatings Elixirs Food Grenades Drinks Potions Scrolls Consumables Instruments Containers Misc Alchemical Ingredients Alchemical Extracts Dyes
Stringrequired
camp suppliescamp supplies

Number of Camp Supplies. Leave EMPTY for all except Food and Drinks.

Numbersuggested
rarityrarity

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

Suggested values
common uncommon rare very rare legendary story
Default
common
Auto value
common
Stringrequired
weight kgweight kg

Weight of the item in kilograms

Numberrequired
weight lbweight lb

Weight of the item in pounds

Numberrequired
priceprice

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.

Numberrequired
uiduid

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

Stringoptional
uuiduuid

The uuid or Root Template for the item. In a uuid format such as "3d99b0ae-4e96-438a-8029-cce11109f415".

Stringoptional
effecteffect

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]]
Contentsuggested
usage costusage cost

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

Suggested values
action bonus action
Stringsuggested
single usesingle use

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

Suggested values
yes
Stringsuggested
seo descriptionseo description

no description

Unknownoptional
notesnotes

Any additional notes about this item.

Contentoptional
bugsbugs

Any known bugs about this item.

Contentoptional
this is an examplethis is an example

no description

Unknownoptional
rarity honourrarity honour

The rarity in Honour Mode, if it is different.

Unknownoptional
price honourprice honour

The price in Honour Mode, if it is different.

Unknownoptional
conditioncondition

no description

Unknownoptional
condition savecondition save

no description

Unknownoptional
condition dccondition dc

no description

Unknownoptional
condition durationcondition duration

no description

Unknownoptional
condition2condition2

no description

Unknownoptional
condition2 savecondition2 save

no description

Unknownoptional
condition2 dccondition2 dc

no description

Unknownoptional
condition2 durationcondition2 duration

no description

Unknownoptional
areaarea

no description

Unknownoptional
area shapearea shape

no description

Unknownoptional
area range marea range m

no description

Unknownoptional
area range ftarea range ft

no description

Unknownoptional
area durationarea duration

no description

Unknownoptional
specialspecial

List of special features, bonuses, or abilities granted by the item.

Example
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
Contentsuggested