Template:Armor infobox/doc

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

{{Armor infobox
| name = 
| icon = 
| image =
| model =
| requires = 
| type = 
| level = 
| ilvl = 
| attributes = 
| customizable-substats = 
| random-substats = 
| eureka-attributes = 
| bozja-attributes = 
| save-the-queen-area-attributes = 
| sanction-attributes = 
| defense = 
| defense-hq = 
| magic-defense = 
| magic-defense-hq = 
| block-strength = 
| block-strength-hq = 
| block-rate = 
| block-rate-hq = 
| rarity = 
| 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 = 
| display-on-hrothgar =
| display-on-viera = 
| patch = 
| release = 
| id-edb = 
| id-gt = 
| id-edb-exists = 
| id-gt-exists = 
}}

Parameters

name

Armor name. Defaults to the page name.

icon

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

image

Optional. The filename of the image to be displayed in the infobox. The item preview image itself should not include any text. Only the filename is needed, no File: prefix or formatting is necessary. Defaults to the item level page name ({{{ilvl}}} {{PAGENAME}}.png). Sets Property:Has appearance.

model

Model ID in the format "N-N-N-N". Used to display list of other items using the same 3-D model. Sets Property:Has gear model.

requires

Class/job required in order to equip such armor. 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", carpenter, blacksmith, armorer, goldsmith, leatherworker, weaver, alchemist, culinarian, botanist, fisher, miner, or any (all classes).

It's also possible to use the following shorthands (articles will be categorized according to role):

Class types: disciple of war, or disciple of magic, or "disciple of hand", or "disciple of land".

Tanking role: fending.

Healing role: healing.

Physical Ranged DPS role:

ARC/BRD/MCH/DNC: aiming.

Magic Ranged DPS role:

THM/ACN/BLM/SMN/RDM/BLU: casting.

Melee DPS role:

LNC/DRG/RPR: maiming.

PGL/MNK/SAM: striking.

ROG/NIN: scouting.

PGL/MNK/SAM/LNC/DRG/RPR: slaying.

type

Required. The armor piece's type. Accepts: shield, head, body, hands, waist, legs, or feet.

attributes

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

customizable-substats

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

random-substats

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

eureka-attributes

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

bozja-attributes

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

save-the-queen-area-attributes

Armor attributes for Save the Queen Area Effect Effect. See {{attribute increase}} and {{attribute decrease}} for examples.

sanction-attributes

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

defense

Optional. The armor's defense.

defense-hq

Optional. The armor's defense when HQ.

magic-defense

Optional. The armor's magic defense.

magic-defense-hq

Optional. The armor's magic defense when HQ.

block-strength

Optional. The shield's block strength.

block-strength-hq

Optional. The shield's block strength when HQ.

block-rate

Optional. The shield's block rate.

block-rate-hq

Optional. The shield's block rate when HQ.

flavor-text

Armor'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 armor. Level will be automatically resolved by the formula: <req. level> - 10.

npc-repair

Optional. The NPC repair cost.

set-name

Optional. The "Outfit Glamour Combination" name from the Lodestone, or the gear set page name from Category:Armor Sets or Category:Glamour Sets. Case sensitive. Separate multiple set names with a comma.

materia-slots

Optional. How many materia slots available to this item.

adv-melding

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

convertible

Optional. Set anything to notify this armor is extractable.

unique

Optional. Set anything to notify this armor is unique.

untradable

Optional. Set anything to notify this armor is untradable.

dyeable

Optional. Set anything to notify this armor is dyeable.

dye-count

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

projectable

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

desynthesizable

Optional. Set anything to notify this armor is desynthesizable.

desynth-level

Optional. Desynthesis level. Defaults to ilvl, and if not set defaults to 1.

storable

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

crest-worthy

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

collectable

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

display-on-hrothgar

Optional. Set to y or n to indicate whether the item will be displayed when equipped by a Hrothgar character. Should only be used on head items.

display-on-viera

Optional. Set to y or n to indicate whether the item will be displayed when equipped by a Viera character. Should only be used on head items.

patch

Optional. Patch number.

release

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

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.

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.

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.