Template:Weapon page: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
m (Protected "Template:WeaponPage" ([Edit=⧼protect-level-editprotected⧽] (indefinite) [Move=⧼protect-level-editprotected⧽] (indefinite)))
m (Removed protection from "Template:WeaponPage")
(No difference)

Revision as of 23:37, 16 July 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, very rare, legendary, story -->
| 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 = <!-- Leave EMPTY if melee, otherwise this can be "normal", "short" (e.g. Hand Crossbow), or "special" -->
| range m = <!-- Leave EMPTY if "range" is NOT "special", otherwise this is the range in meters. -->
| range ft = <!-- Leave EMPTY if "range" is NOT "special", otherwise this is the 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.

This template defines the table "weapons". View table.

(Auto-generated TemplateData follows.)


This template generates entire pages for individual weapons in the game. (For other Equipment, use Template:EquipmentPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.)

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
imageimage

The filename of the image/icon associated with this item.

Example
Merregon Halberd Icon.png
Filerequired
categorycategory

The weapon's overall proficiency category (martial or simple)

Suggested values
martial simple
Stringrequired
descriptiondescription

Optional, BRIEF description of what is notable about this weapon. If left empty, a basic description will be auto-generated for you based on the other information you've entered in the template.

Example
{{uncommon|Longsword of Slash-Slash}} is an uncommon [[Longsword]] that allows the wielder to slash a lot.
Contentsuggested
quotequote

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

Stringsuggested
where to findwhere to find

Describe where and how to obtain the weapon (can leave empty if it's super commonly obtainable).

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

The weapon's specific type. Always plural.

Suggested values
Battleaxes Clubs Daggers Glaives Greataxes Greatclubs Greatswords Halberds Hand Crossbows Handaxes Heavy Crossbows Javelins Light Crossbows Light Hammers Longbows Longswords Maces Mauls Morningstars Pikes Quarterstaves Rapiers Scimitars Shortbows Shortswords Sickles Spears Tridents War Picks Warhammers
Example
Longswords
Stringrequired
rarityrarity

The rarity level of the weapon (common, uncommon, rare, very rare, legendary, story)

Suggested values
common uncommon rare very rare legendary story
Example
uncommon
Stringrequired
melee or rangedmelee or ranged

no description

Suggested values
melee ranged
Example
melee
Stringrequired
handednesshandedness

no description

Suggested values
one-handed versatile two-handed
Example
one-handed
Stringrequired
damagedamage

The damage of the weapon (the one-handed damage, in the case of Versatile weapons). Must follow the strict format XdY + Z, with the "+ Z" only needed if the weapon has an enchantment.

Example
1d8 + 1
Stringrequired
versatile damageversatile damage

Same format as regular damage. Leave EMPTY if this weapon is not Versatile.

Example
1d10 + 1
Stringsuggested
damage typedamage type

The damage type of the weapon

Suggested values
Slashing Bludgeoning Piercing
Example
Slashing
Stringrequired
extra damageextra damage

Any extra damage granted by this weapon. Leave EMPTY if this weapon does not receive a damage bonus aside from its enchantment. Otherwise, same format as regular damage, but with damage type directly on the same line.

Example
1d4 Fire
Stringsuggested
enchantmentenchantment

The value of the enchantment on the weapon. Leave blank if no enchantment.

Suggested values
+1 +2 +3 +4 +5
Example
+1
Stringsuggested
rangerange

This is for ranged weapons only. Leave EMPTY if melee; otherwise choose one of the suggested values. "short" in this context refers to the shorter range of Hand Crossbows.

Suggested values
normal short special
Stringsuggested
special range mrange m

Leave EMPTY unless range is "special." Special range of the weapon in meters.

Example
18
Numbersuggested
special range ftrange ft

Leave EMPTY unless range is "special." Special range of the weapon in feet.

Example
60
Numbersuggested
ammunitionammunition

Does this weapon have the Ammunition property? (Leave EMPTY if no!)

Suggested values
yes
Example
yes
Stringsuggested
finessefinesse

Does this weapon have the Finesse property? (Leave BLANK if no!)

Suggested values
yes
Stringsuggested
heavyheavy

Does this weapon have the Heavy property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
lightlight

Does this weapon have the Light property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
loadingloading

Does this weapon have the Loading property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
reachreach

Does this weapon have the Extra Reach property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
thrownthrown

Does this weapon have the Thrown property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
can't dual wieldcan't dual wield

Does this weapon have the Can't Dual Wield property? (Leave BLANK if no!)

Suggested values
yes
Example
yes
Stringsuggested
dippabledippable

Does this weapon have the Dippable property? (Leave BLANK if no!)

Suggested values
yes
Default
yes
Example
yes
Stringsuggested
weight kgweight kg

Weight of the weapon in kilograms

Example
1.35
Numberrequired
weight lbweight lb

Weight of the weapon in pounds

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

Example
75
Numberrequired
specialspecial

Any special features granted to the wielder of the weapon. Separate multiple special features with bullets.

Example
* '''Super Cool Ability:''' Cast [[Awesome Spell]] once per [[Long Rest]].
Contentsuggested
actionsactions

List of Weapon Actions gained by wielding this weapon in the main hand. Be sure to separate multiple actions with * Bullets, with each bullet and action on a new line.

Example
* {{Lacerate}}
Contentsuggested