Template:Armor/doc

Description

This is the main template for all armor pages. It determines the layout of the individual page and provides functionality for extracting specific armor information for use in other pages.

Usage

{{Armor
|Mode = {{{1|Page}}}
|Param1 = {{{2|}}}
|Param2 = {{{3|}}}

<!-- Quick Facts -->
|Name = 
|Pagename = 
|Status = 
|Type = 
|Version = 
|VersionUpdate = 
|Rarity = 
|Set = 
|Attributes = 
|Quests = 
|Prerequisites = 

<!-- Media -->
|Image = 
|Icon = 

<!-- Info -->
|Description = 
|Notes = 

<!-- Value -->
|Buy = 
|Sell = 

<!-- Stats -->
|Traits = 
|Stats = 
|Offense = 
|Defense = 
|Resist = 
|Effects = 
|Specials = 

<!-- Location -->
|FoundIn = 
|DroppedBy = 
|SoldBy = 
|RewardedBy = 
}}

Parameters

Name	Required	Description	Values
Mode	Yes	Determines the mode of execution of the template (see below). Changing the predefined value may lead to unexpected behavior.	{{{1|Page}}} (should not be changed)
Param1	Yes	Used for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior.	{{{2|}}} (should not be changed)
Param2	Yes	Used for routing a selection parameter to the template in certain modes (see below). Changing the predefined value may lead to unexpected behavior.	{{{3|}}} (should not be changed)
Quick Facts
Name	Yes	The name of the armor. Usually identical to the page title. Will be displayed in the infobox of the page.	arbitrary text
Pagename	Yes	The title of the armor page, needed for linking purposes. Note: Do not use magic words such as {{PAGENAME}} here, as this prevents proper linking when transcluding information from this page on other pages.	arbitrary text
Status	No	If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page.	one of the values defined in Template:PageStatus
Type	Yes	The specific type of the armor. Will be displayed in the infobox of the page. A list of predefined types can be found in Template:ArmorType (if new types are introduced, they should also be added there).	one of the values defined in Template:ArmorType (other values are ignored): Garment • Jewelry • Shield
Version	Yes	The game version in which the armor was first introduced. Will be displayed in the infobox of the page.	version number in the form X.Y.Z
VersionUpdate	No	The game version in which the armor was last updated. Will be displayed in the infobox of the page.	version number in the form X.Y.Z
Rarity	Yes	The incidence of the armor. Will be displayed in the infobox of the page.	one of the values defined in Template:Rarity (other values are ignored): Unique • Limited • Rare • Common • Unknown
Set	No	If the armor belongs to a certain set of equipment, this can be stated here. Will be displayed in the infobox of the page.	one of the equipment [[Set]]s
Attributes	No	One or more attributes which describe certain aspects of the armor. Will be displayed in the infobox of the page. A list of predefined attributes can be found in Template:ArmorAttributes (if new attributes are introduced, they should also be added there).	a semicolon-separated list of the values defined in Template:ArmorAttributes (other values are ignored): Quest • Craftable • Crafting • Summon
Quests	No	If the armor is of importance for certain quests, they can be listed here.	a semicolon-separated list of [[Quests]]s
Prerequisites	No	If specific prerequisites have to be fulfilled to wear the armor, they can be listed here. Will be displayed in the infobox of the page.	a semicolon-separated list of prerequisites
Media
Image	Yes	The image (PNG or JPG) to be displayed in the infobox of the page.	image name (including file extension)
Icon	No	The image (PNG or JPG) to be displayed as an icon in armor tables, lists, etc. If nothing is specified, a small version of Image is used instead.	image name (including file extension)
Info
Description	Yes	A concise description of the armor itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough).	arbitrary text
Notes	No	Any kind of ancillary information (which does not seem appropriate anywhere else) can be provided here.	arbitrary text, ideally formatted as a bullet list (using *)
Value
Buy	Yes	The basic price of the armor when bought from a merchant (without modifiers). Set to 0 when not buyable.	non-negative number
Sell	Yes	The basic price of the armor when sold to a merchant (without modifiers). Set to 0 when unsellable.	non-negative number
Stats
Traits	Yes	The trait bonus/malus provided by the armor. See Template:Traits for further information.	a vector of 7 comma-separated numbers, representing trait values (e.g. "4,8,8,5,6,3,6")
Stats	Yes	The base stats bonus/malus provided by the armor. See Template:Stats for further information.	a vector of 6 comma-separated numbers, representing stat values (e.g. "52,11,10,18,3,0")
Offense	Yes	The offensive properties bonus/malus provided by the armor. See Template:Offense for further information.	a vector of 7 comma-separated numbers, representing offense values (e.g. "3,8,0,2,1,50,10")
Defense	Yes	The defensive properties bonus/malus provided by the armor. See Template:Defense for further information.	a vector of 2 comma-separated numbers, representing defense values (e.g. "2,15")
Resist	Yes	The resistance bonus/malus provided by the armor. See Template:Elements for further information.	a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")
Effects	No	If special proc effects are provided by the armor, they can be listed here. See Template:Effect for further information.	a semicolon-separated list of {{Effect|...}}s (using Template:Effect)
Specials	No	If the armor provides special combat properties, they can be listed here.	a semicolon-separated list of [[Special]]s
Location
FoundIn	No	If the armor is found in certain areas, they can be listed here.	a semicolon-separated list of [[Area]]s
DroppedBy	No	If the armor is dropped by certain characters/creatures, they can be listed here.	a semicolon-separated list of [[Character]]s and/or [[Creature]]s
SoldBy	No	If the armor can by bought from certain merchants, they can be listed here.	a semicolon-separated list of [[Character]]s
RewardedBy	No	If the armor is rewarded by certain quests, they can be listed here.	a semicolon-separated list of [[Quest]]s

Extracting specific armor information for use in other pages

Syntax

You can transclude information from an armor page in any other page by using the following syntax:

{{:<pagename>|<mode>|<param1>|<param2>}}

Here, <pagename> is the armor's full page name (in main namespace), <mode> determines the type of information to be transcluded, and <param1> & <param2> represent selection parameters required by certain modes.

Modes and parameters

Mode	Description	Parameter 1	Parameter 2
Page	Outputs the full armor page. This is the default mode.	none	none
TableHead	Outputs the header of an armor table (intended for constructing overview tables).	none	none
TableEntry	Outputs a table row containing specific armor information (intended for constructing overview tables). If a selector is specified in <param1>, output is only generated if the selector of a specific armor matches the value of <param2>. If no selector is specified, output is always generated.	one of the following selectors: Type • Attribute	one of the possible values of the specified selector