Template:Item infobox/doc

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
This is the documentation subpage of Template:Item infobox. It contains usage information that is not part of the underlying template page.

Use this infobox for defining general items within the game, e.g. crafting materials, housing items, materia, etc.

{{item infobox
| name = 
| icon = 
| image =
| description = 
| type =  
| effects = 
| effects-hq = 
| material-type = 
| unique = 
| untradable = 
| unsellable = 
| rarity = 
| level = 
| ilvl = 
| race = 
| gender = 
| recast = 
| recast-hq = 
| cost = 
| value = 
| value-hq = 
| seals = 
| patch = 
| release = 
| id-edb = 
| id-gt = 
| id-edb-exists = 
| id-gt-exists = 
}}

Parameters

name
Optional. Name of the article. Defaults to {{PAGENAME}}. This should be the canonical in-game name, although the page name may include information to differentiate it from other pages. Example: King Elmer III Card (Key Item)
icon
Optional. Item icon. Defaults to File:{{PAGENAME}}.png
image
Optional. The filename of the image to be displayed in the infobox (primarily used for housing items). The item name should not include any text. Only the filename is needed, no File: prefix or formatting is necessary. Defaults to the item's page name ({{PAGENAME}}.png/.jpg); set to "no" to disable the image display. Sets Property:Has appearance.
description
Optional. Verbatim from the game.
effects
Optional. Item effects. Applies mostly to consumables, potions, meals, etc. See {{item effect}} for details on how to apply one or multiple effects.
effects-hq
Optional. Item effects if the item is high quality. Applies mostly to consumables, potions, meals, etc.
type
Various item types. Includes meal, minion, other, container, crafting material, etc.
material-type
Optional. Historically this was the material type for any item with type = Crafting material set (i.e.cloth, ingredient, reagent, etc.). Now it's used more generally as the item sub-type, such as "furnishing", "meal", "seafood". The type/sub-type generally match the categorizations in the Eorzea Database.
unique/untradeable/unsellable
Optional. Input "y" in the appropriate fields if the item has the trait, otherwise leave blank.
release
Optional. Expansion this item 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.

See also