Template:Weapon page: Difference between revisions

From Baldur's Gate 3 Wiki
Jump to navigation Jump to search
No edit summary
Tag: Manual revert
m (several minor edits to usage notes for clarity/user-friendliness)
Line 11: Line 11:
{{#if: {{{description|}}}
{{#if: {{{description|}}}
| {{{description}}}
| {{{description}}}
| <!-- HERE BE DRAGONS!  The following monstrosity will auto-generate a nice, sensible introduction paragraph for ''any'' combination of parameters.  So, technically, you never have to provide descriptions for weapons, but for those with unique specialties you might want to do so anyway. -->
| <!-- HERE BE DRAGONS!  The following monstrosity will auto-generate a nice, sensible introduction paragraph for ''any'' combination of parameters.  So, technically, you never have to provide descriptions for weapons, but for those with unique special properties you might want to do so anyway. -->
{{#if: {{{enchantment|}}} {{{rarity|}}} {{{special|}}}
{{#if: {{{enchantment|}}} {{{rarity|}}} {{{special|}}}
| {{RarityColor | {{{rarity|}}} | '''{{PAGENAME}}''' }}
| {{RarityColor | {{{rarity|}}} | '''{{PAGENAME}}''' }}
Line 144: Line 144:
This template generates entire pages for individual weapons in the game, such as [[Longsword]] (not to be confused with [[Longswords]]) or [[Worgfang]].
This template generates entire pages for individual weapons in the game, such as [[Longsword]] (not to be confused with [[Longswords]]) or [[Worgfang]].


Following is an example of usage with all possible template parameters shown.  This describes a made up Longsword which for some reason deals an extra 1d4 Fire damage, is heavy (longswords normally aren't), and has the Tenacity attribute which normally Morningstars and Greatclubs have.
Following is an example of usage with all possible template parameters shown.  This describes a made up Longsword which for some reason deals an extra 1d4 Fire damage and is Heavy (longswords normally aren't).  If you're ever unsure what to type, simply leave the parameter empty.


<pre>
<pre>
Line 150: Line 150:
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:WeaponPage -->
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:WeaponPage -->
| image = Longsword Icon.png
| image = Longsword Icon.png
| description = Optional description.  Nonmagical and simple +1/+2/etc. will be auto-generated, so leave empty for those.  Others will also have a sensible default description generated, so strictly speaking you can always leave this empty, but you might still want to provide a short description of what makes the weapon noteworthy.
| description = <!-- Optional description.  Nonmagical and +1/+2/etc. will be auto-generated, so leave empty for those.  Others will also have a sensible default description generated, so strictly speaking you can always leave this empty, but for weapons with special properties, you might want to instead provide a short description of what makes the weapon noteworthy. -->
| quote = The in-game flavor text in the item's tooltip.
| quote = The in-game flavor text in the item's tooltip.
| category = martial <!-- martial or simple -->
| category = martial <!-- martial or simple -->
| melee or ranged = melee <!-- melee or ranged, duh -->
| melee or ranged = melee <!-- melee or ranged, duh -->
| handedness = versatile <!-- one-handed, versatile, two-handed -->
| handedness = versatile <!-- one-handed, versatile, two-handed -->
| type = Longswords <!-- One of [[Category:Weapon Types]]. -->
| type = Longswords <!-- One of [[Category:Weapon Types]]. Always plural. -->
| rarity = <!-- EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| rarity = <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| enchantment = <!-- EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| damage = 1d8 + 1 <!-- Must follow this exact strict format, with the "+ X" being optional. -->
| damage = 1d8 + 1 <!-- Must follow the strict format XdY + Z, with the "+ Z" only needed if the weapon has an enchantment. -->
| damage type = Slashing <!-- Accepts any of [[Damage Types]], but usually: Slashing, Piercing, or Bludgeoning -->
| damage type = Slashing <!-- Accepts any of [[Damage Types]], but usually: Slashing, Piercing, or Bludgeoning -->
| versatile damage = 1d10 + 2 <!-- Same format as regular damage, or EMPTY if this isn't a Versatile weapon. -->
| versatile damage = 1d10 + 2 <!-- Same format as regular damage, or leave EMPTY if this isn't a Versatile weapon. -->
| extra damage = 1d4 Fire <!-- Same format as regular damage but with type directly on the same line. -->
| extra damage = 1d4 Fire <!-- Same format as regular damage, but with damage type directly on the same line. -->
| range m = <!-- EMPTY if melee, otherwise range in metric. -->
| range m = <!-- Leave EMPTY if melee, otherwise range in meters. -->
| range ft = <!-- EMPTY if melee, otherwise range in feet. -->
| range ft = <!-- Leave EMPTY if melee, otherwise range in feet. -->
| <!-- Following are yes/no properties, which MUST BE EMPTY if you mean "no"!  Never actually type "no"! -->
| <!-- Following are yes/no properties, which MUST BE EMPTY if you mean "no"!  Never actually type "no"! -->
| ammunition =
| ammunition =

Revision as of 22:39, 6 February 2023

This template generates entire pages for individual weapons in the game, such as Longsword (not to be confused with Longswords) or Worgfang.

Following is an example of usage with all possible template parameters shown. This describes a made up Longsword which for some reason deals an extra 1d4 Fire damage and is Heavy (longswords normally aren't). If you're ever unsure what to type, simply leave the parameter empty.

{{WeaponPage
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:WeaponPage -->
| image = Longsword Icon.png
| description = <!-- Optional description.  Nonmagical and +1/+2/etc. will be auto-generated, so leave empty for those.  Others will also have a sensible default description generated, so strictly speaking you can always leave this empty, but for weapons with special properties, you might want to instead provide a short description of what makes the weapon noteworthy. -->
| quote = The in-game flavor text in the item's tooltip.
| category = martial <!-- martial or simple -->
| melee or ranged = melee <!-- melee or ranged, duh -->
| handedness = versatile <!-- one-handed, versatile, two-handed -->
| type = Longswords <!-- One of [[Category:Weapon Types]]. Always plural. -->
| rarity = <!-- Leave EMPTY for common, otherwise: uncommon, rare, veryrare, legendary -->
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| damage = 1d8 + 1 <!-- Must follow the strict format XdY + Z, with the "+ Z" only needed if the weapon has an enchantment. -->
| damage type = Slashing <!-- Accepts any of [[Damage Types]], but usually: Slashing, Piercing, or Bludgeoning -->
| versatile damage = 1d10 + 2 <!-- Same format as regular damage, or leave EMPTY if this isn't a Versatile weapon. -->
| extra damage = 1d4 Fire <!-- Same format as regular damage, but with damage type directly on the same line. -->
| range m = <!-- Leave EMPTY if melee, otherwise range in meters. -->
| range ft = <!-- Leave EMPTY if melee, otherwise range in feet. -->
| <!-- Following are yes/no properties, which MUST BE EMPTY if you mean "no"!  Never actually type "no"! -->
| ammunition =
| finesse =
| heavy =
| light =
| loading =
| reach =
| thrown =
| can't dual wield =
| dippable = yes
| weight kg = 1.35
| weight lb = 2.7
| price = 75
| actions = <!-- Common actions you get when you have proficiency and wield the weapon in your main-hand. -->
* {{Pommel Strike}}
* {{Lacerate}}
* {{Rush Attack}}
| special = <!-- List of special features or abilities granted by the weapon. -->
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this weapon.
| where to find = <!-- Describe where and how to obtain the weapon, if it's a special one. -->
This is a made-up weapon.  You cannot obtain it anywhere in the game.
}}

See here for the result of the above: Template:WeaponPage/Example

Note that the template even adds the page to the correct categories. And for the same reason, it shouldn't be invoked here for the purpose of showing how the results look; that would result in this template page being added to the categories to which weapon pages are added.