Template:Weapon page: Difference between revisions
No edit summary |
No edit summary |
||
Line 130: | Line 130: | ||
* {{Price | {{{price}}} }} | * {{Price | {{{price}}} }} | ||
{{#if: {{{special|}}} | | {{#if: {{{special|}}} | | ||
<h3> Special </h3> | |||
The holder of this item gains: | The holder of this item gains: | ||
{{{special}}} | {{{special}}} | ||
}} | }} | ||
<h3> Weapon Actions </h3> | |||
{{WeaponProficiencyUnlocks}} | {{WeaponProficiencyUnlocks}} |
Revision as of 17:57, 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.)
Parameter | Description | Type | Status | |
---|---|---|---|---|
image | image | The filename of the image/icon associated with this item.
| File | required |
category | category | The weapon's overall proficiency category (martial or simple)
| String | required |
description | description | 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.
| Content | suggested |
quote | quote | The in-game flavour text in the weapon's tooltip. | String | suggested |
where to find | where to find | Describe where and how to obtain the weapon (can leave empty if it's super commonly obtainable).
| Content | suggested |
type | type | The weapon's specific type. Always plural.
| String | required |
rarity | rarity | The rarity level of the weapon (common, uncommon, rare, very rare, legendary, story)
| String | required |
melee or ranged | melee or ranged | no description
| String | required |
handedness | handedness | no description
| String | required |
damage | damage | 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.
| String | required |
versatile damage | versatile damage | Same format as regular damage. Leave EMPTY if this weapon is not Versatile.
| String | suggested |
damage type | damage type | The damage type of the weapon
| String | required |
extra damage | extra 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.
| String | suggested |
enchantment | enchantment | The value of the enchantment on the weapon. Leave blank if no enchantment.
| String | suggested |
range | range | 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.
| String | suggested |
special range m | range m | Leave EMPTY unless range is "special." Special range of the weapon in meters.
| Number | suggested |
special range ft | range ft | Leave EMPTY unless range is "special." Special range of the weapon in feet.
| Number | suggested |
ammunition | ammunition | Does this weapon have the Ammunition property? (Leave EMPTY if no!)
| String | suggested |
finesse | finesse | Does this weapon have the Finesse property? (Leave BLANK if no!)
| String | suggested |
heavy | heavy | Does this weapon have the Heavy property? (Leave BLANK if no!)
| String | suggested |
light | light | Does this weapon have the Light property? (Leave BLANK if no!)
| String | suggested |
loading | loading | Does this weapon have the Loading property? (Leave BLANK if no!)
| String | suggested |
reach | reach | Does this weapon have the Extra Reach property? (Leave BLANK if no!)
| String | suggested |
thrown | thrown | Does this weapon have the Thrown property? (Leave BLANK if no!)
| String | suggested |
can't dual wield | can't dual wield | Does this weapon have the Can't Dual Wield property? (Leave BLANK if no!)
| String | suggested |
dippable | dippable | Does this weapon have the Dippable property? (Leave BLANK if no!)
| String | suggested |
weight kg | weight kg | Weight of the weapon in kilograms
| Number | required |
weight lb | weight lb | Weight of the weapon 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 |
special | special | Any special features granted to the wielder of the weapon. Separate multiple special features with bullets.
| Content | suggested |
actions | actions | 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.
| Content | suggested |