Template:Weapon infobox/doc

This is the documentation subpage of Template:Weapon infobox. It contains usage information that is not part of the underlying template page.

{{Weapon infobox
| name = 
| model =
| image =
| icon = 
| requires = 
| type = 
| level = 
| ilvl = 
| rarity = 
| attributes = 
| customizable-substats = 
| random-substats = 
| sanction-attributes = 
| physical-damage = 
| physical-damage-hq = 
| magic-damage = 
| magic-damage-hq = 
| autoattack = 
| autoattack-hq = 
| delay = 
| delay-hq = 
| dps = 
| dps-hq = 
| flavor-text = 
| race = 
| gender = 
| cost = 
| value = 
| value-hq = 
| repair = 
| npc-repair = 
| set-name = 
| materia-slots = 
| adv-melding = 
| convertible =
| unique = 
| untradable = 
| dyeable = 
| dye-count = 
| projectable =  
| desynthesizable = 
| desynth-level = 
| crest-worthy = 
| storable = 
| collectable = 
| patch = 
| release = 
| id-edb =
| id-gt =
| id-edb-exists = 
}}

Parameters

name

Weapon name. Defaults to the page name.

icon

Weapon icon to show. If not explicitly stated, displays File:<name>.png.

model

Optional. The weapon's model ID in the game files. Can be viewed from GarlandTools. Will assigned during page creation via bot; please do not modify.

image

Optional. The weapon's in-game appearance. Infobox images are typically of the form Pagename.jpeg and created automatically. However, manually specifying this parameter will override the default image.

requires

Class/job required in order to equip such weapon. Accepts comma-separated: marauder, gladiator, warrior, paladin, dark knight, conjurer, white mage, scholar, astrologian, pugilist, lancer, archer, rogue, thaumaturge, arcanist, monk, dragoon, bard, black mage, summoner, ninja, machinist, samurai, red mage, "blue mage", "gunbreaker", "dancer", "reaper", "sage", carpenter, blacksmith, armorer, goldsmith, leatherworker, weaver, alchemist, culinarian, botanist, fisher, miner, or any.

type

Required. The weapon's/tool's type. Accepts: alembic, saw, frypan, needle, hatchet, pickaxe, sword, wand, scepter, greataxe, polearm, bow, daggers, greatsword, firearms, katana, cane, staff, book, rapier, "gunblade", "scythe", "noulith", mortar, pliers, file, awl, scythe, sledgehammer, doming hammer, cross-pein hammer, lapidary hammer, head knife, fishing rod, fist weapon, "throwing weapons", star globe, claw hammer, culinary knife, grinding wheel, or spinning wheel

attributes

Weapon attributes. See {{attribute increase}} for examples.

customizable-substats

Optional. Set true if the weapon's secondary attributes can be customized. Exclusively applies to late stage Relic weapons.

random-substats

Optional. Set true if the weapon's secondary attributes are randomly determined on acquisition. Exclusively applies to Aetherial equipment.

sanction-attributes

Armor attributes for Sanction Effect. See {{attribute increase}} and {{attribute decrease}} for examples.

physical-damage

Optional. Weapon's physical damage.

physical-damage-hq

Optional. Weapon's physical damage when HQ.

magic-damage

Optional. Weapon's magic damage.

magic-damage-hq

Optional. Weapon's magic damage when HQ.

autoattack

Optional. Weapon's auto-attack damage.

autoattack-hq

Optional. Weapon's auto-attack damage when HQ.

delay

Optional. Weapon's attack delay.

delay-hq

Optional. Weapon's attack delay when HQ.

dps

Optional. Weapon's DPS.

dps-hq

Optional. Weapon's DPS when HQ.

flavor-text

Weapon's flavor text. Check {{colorize}} template to learn how to add color to the flavor text using special backticks markup.

repair

Optional. The class required to repair the weapon. Level will be automatically resolved by the formula: <req. level> - 10.

npc-repair

Optional. The NPC repair cost.

set-name

Optional. The gear set page name from Category:Weapon Sets. Case sensitive

materia-slots

Optional. How many materia slots available to this item.

adv-melding

Optional. Set n to notify this weapon can't be overmelded.

convertible

Optional. Set anything to notify this weapon is extractable.

unique

Optional. Set anything to notify this weapon is unique.

untradable

Optional. Set anything to notify this weapon is untradable.

dyeable

Optional. Set anything to notify this weapon is dyeable.

dye-count

Optional. Number of dye channels. Defaults to 1 for dyeable items.

projectable

Optional. Set anything to notify this weapon is projectable (can have its glamour cast on other weapons).

desynthesizable

Optional. Set anything to notify this weapon is desynthesizable.

desynth-level

Optional. Desynthesis level. Defaults to the value set for ilvl, and if not set to 1.

storable

Optional. Set anything to notify this weapon is storable (can be stored in the armoire).

crest-worthy

Optional. Set anything to notify this weapon can have FC crests affixed to it.

collectable

Obsolete, do not use. Collectables are now totally separate items.

release

Optional. Expansion this weapon belongs to. Accepts: heavensward, or stormblood, or shadowbringers or endwalker or dawntrail.

The following parameters are handled by the {{Default item parameter}} template:

level

Optional. Required level to use the item.

ilvl

Optional. Item level.

rarity

Specified rarity: basic (white), aetherial (pink), dungeon (green), tomestone (blue), relic (purple). Will be set to Unspecified per default.

race

Optional. Required race to use item.

gender

Optional. Required gender to use item.

recast

Optional. Recast time (in seconds) for consumables such as medicine and meals.

recast-hq

Optional. Recast time (in seconds) for consumables such as medicine and meals if the item is high quality.

cost

Optional. Currency cost of the item when purchased from a vendor. To match it to the display in any vendor window, use the amount and the appropriate icon template, e.g. 500 {{gil}}, 2000 {{company seal}}, or 50 {{tomestone}}

value

Optional. The number of gils a vendor will pay for this item; if not specified sets the item as unsellable.

value-hq

Optional. The number of gils a vendor will pay for this item if high quality.

seals

Optional. The amount of seals earned through Grand Company deliveries.

patch

Optional. The patch where the item became available.

id-edb

Optional. ID number in the link to the item on Eorzea Database, for example, if the URL is https://na.finalfantasyxiv.com/lodestone/playguide/db/item/fb177317b75/, enter fb177317b75.

id-gt

Optional. Internal ID number from the game files. Used in the links to the external sites such as Garland Tools, Teamcraft, and Universalis. For example, if the URL is http://garlandtools.org/db/#item/11252, enter 11252.

id-edb-exists

Optional. For items which will never appear in Eorzea Database, set this parameter to n and do not provide the id-edb parameter. This excludes the item from appearing in the maintenance category Category:Items with no EDB ID specified.

id-gt-exists

Optional. For items which will never appear in GarlandTools/Teamcraft/Universalis (etc), set this parameter to n and do not provide the id-gt parameter. This excludes the item from appearing in the maintenance category Category:Items with no internal ID specified.