View source for Template:Equipment/doc

{{documentation}}
The '''Equipment''' template mimics the in-game display of equipped items.

==Usage==
<pre>
{{Equipment|align=left/center/right
|buttons = "yes" to show equipment interface buttons (defaults "no" if omitted)
|stats = "yes" to show equipment stats (defaults "no" if omitted)
|head = Head slot item
|cape = Cape slot item
|neck = Neck slot item
|ammo = Ammo slot item
|ammoquantity = Optional: Item quantity
|ammo2 = Optional: Second ammo slot item (for use with [[Dizana's quiver]] or [[Bolt pouch]])
|ammo2quantity = Optional: Item quantity
|weapon = Weapon slot item
|weaponquantity = Optional: Item quantity
|torso = Body slot item
|legs = Legs slot item
|shield = Shield slot item
|gloves = Glove slot item
|boots = Boot slot item
|ring = Ring slot item
}}
</pre>

All parameters are optional. Do not include <code>File:</code>, <code>Image:</code>, or <code>.png</code> on any of the equipment slot parameters.

To align the interface to a specific side, use the ''align'' parameter. For example, use <code>|align=right</code> to move the table to the right of the page. To use a GIF instead of PNG image for the item picture, add <code>;g</code> after the item name.

If an item has a different in-game name than the #anchor link required for the article, add <code>;Itemname#Anchor</code> after the item name. This can be used together with the above <code>;g</code> flag, if necessary. This is used to obtain item stats.

When using the <code>stats=yes</code> parameter to show stats, it is recommended to include <code>buttons=yes</code> as well, to better align the interface, and to allow users to switch from the Equipment Stats to the Items Kept on Death, using the buttons below the interface. These buttons only become functional when <code>stats=yes</code> is set.

==Examples==
===Plain equipments table===
<pre>
{{Equipment|align=left
|head = Ancient coif
|cape = Dizana's max cape
|neck = Amulet of fury
|ammo = Runite bolts
|ammoquantity = 2147483647
|ammo2 = Dragon arrow
|ammo2quantity = 2147483647
|weapon = Zaryte crossbow
|torso = Ancient d'hide body
|legs = Ancient chaps
|shield = Ancient d'hide shield
|gloves = Ancient bracers
|boots = Ancient d'hide boots
|ring = Treasonous ring
}}
</pre>

Results in:
{{Equipment|align=left
|head = Ancient coif
|cape = Dizana's max cape
|neck = Amulet of fury
|ammo = Runite bolts
|ammoquantity = 2147483647
|ammo2 = Dragon arrow
|ammo2quantity = 2147483647
|weapon = Zaryte crossbow
|torso = Ancient d'hide body
|legs = Ancient chaps
|shield = Ancient d'hide shield
|gloves = Ancient bracers
|boots = Ancient d'hide boots
|ring = Treasonous ring
}}
{{Clear}}

===Equipments table with stats===
<pre>{{Equipment|align=left
|buttons = yes
|stats = yes
|head = Brassica halo
|cape = Cabbage cape
|neck = Gnome amulet
|ammo = Peaceful blessing
|weapon = Apprentice wand
|shield = Cabbage round shield
|torso = Xerician top
|legs = Xerician robe
|gloves = Zombie gloves
|boots = Ranger boots
|ring = Explorer's ring 4
}}
</pre>

Results in:

{{Equipment|align=left
|buttons = yes
|stats = yes
|head = Brassica halo
|cape = Cabbage cape
|neck = Gnome amulet
|ammo = Peaceful blessing
|weapon = Apprentice wand
|shield = Cabbage round shield
|torso = Xerician top
|legs = Xerician robe
|gloves = Zombie gloves
|boots = Ranger boots
|ring = Explorer's ring 4
}}
{{Clear}}

==Quick copy==
<pre>
{{Equipment|align=right
|buttons = 
|stats = 
|head = 
|cape = 
|neck = 
|ammo = 
|weapon = 
|torso = 
|legs = 
|shield = 
|gloves = 
|boots = 
|ring = 
}}
</pre>

==See also==
*[[Template:Inventory]]
*[[Template:Looting bag]]
*[[Template:Rune pouch]]

{{TemplateData|<templatedata>
{
	"params": {
		"align": {
			"label": "Page alignment",
			"description": "To align the rune pouch to a specific side of the page, use the align parameter. For example, use |align=right to move the table to the right of the page.",
			"example": "right",
			"type": "string",
			"default": "left"
		},
		"buttons": {
			"label": "Use equipment tab with buttons?",
			"description": "Shows equipment interface buttons if set to yes",
			"example": "yes",
			"type": "string",
			"default": "no",
			"suggested": false
		},
		"stats": {
			"label": "Show stats next to equipment?",
			"description": "Shows equipment stats next to the loadout itself; use in combination with buttons recommended.",
			"example": "yes",
			"type": "string",
			"default": "no",
			"suggested": false
		},
		"head": {
			"label": "Head slot item",
			"description": "Name of the item to put in the head slot",
			"example": "Rune full helm",
			"type": "wiki-page-name"
		},
		"cape": {
			"label": "Cape slot item",
			"description": "Name of the item to put in the cape slot",
			"example": "Cape of legends",
			"type": "wiki-page-name"
		},
		"neck": {
			"label": "Neck slot item",
			"description": "Name of the item to put in the neck slot",
			"example": "Amulet of power",
			"type": "wiki-page-name"
		},
		"ammo": {
			"label": "Ammo slot item",
			"description": "Name of the item to put in the ammo slot",
			"example": "Rune arrows",
			"type": "wiki-page-name"
		},
		"ammo2": {
			"label": "Second ammo slot item",
			"description": "Name of the item to put in the second ammo slot (for Dizana's quiver or bolt pouch)",
			"example": "Diamond bolts (e)",
			"type": "wiki-page-name"
		},
		"weapon": {
			"label": "Weapon slot item",
			"description": "Name of the item to put in the weapon slot",
			"example": "Rune battleaxe",
			"type": "wiki-page-name"
		},
		"torso": {
			"label": "Torso slot item",
			"description": "Name of the item to put in the torso slot",
			"example": "Rune platebody",
			"type": "wiki-page-name"
		},
		"legs": {
			"label": "Legs slot item",
			"description": "Name of the item to put in the legs slot",
			"example": "Rune platelegs",
			"type": "wiki-page-name"
		},
		"shield": {
			"label": "Shield slot item",
			"description": "Name of the item to put in the shield slot",
			"example": "Rune kite shield",
			"type": "wiki-page-name"
		},
		"gloves": {
			"label": "Gloves slot item",
			"description": "Name of the item to put in the gloves slot",
			"example": "Barrows gloves",
			"type": "wiki-page-name"
		},
		"boots": {
			"label": "Boots slot item",
			"description": "Name of the item to put in the boots slot",
			"example": "Rune boots",
			"type": "wiki-page-name"
		},
		"ring": {
			"label": "Ring slot item",
			"description": "Name of the item to put in the ring slot",
			"example": "Diamond ring",
			"type": "wiki-page-name"
		},
		"ammoquantity": {
			"label": "Ammo quantity",
			"description": "Ammo quantity (e.g. for arrows or bolts)",
			"example": "10",
			"type": "number"
		},
		"ammo2quantity": {
			"label": "Second ammo quantity",
			"description": "Ammo quantity for the second ammo slot (e.g. for arrows or bolts)",
			"example": "10",
			"type": "number"
		},
		"weaponquantity": {
			"label": "Weapon quantity",
			"description": "Quantity (used for thrown weapons)",
			"type": "number",
			"example": "73"
		}
	},
	"description": "This template mimics the in-game display of equipped items.\n\nTo align the inventory to a specific side, use the align parameter. For example, use |align=right to move the table to the right of the page.\n\nTo switch to using the GIF version of an item icon, add ;g after the name of the item like |cape=Fire cape;g\n\nButtons and equipment stats can optionally be enabled to show extra features of the equipment.",
	"format": "\n{{_\n|_ = _\n}}",
	"paramOrder": [
		"align",
		"buttons",
		"stats",
		"head",
		"cape",
		"neck",
		"ammo",
		"ammoquantity",
		"ammo2",
		"ammo2quantity",
		"weapon",
		"weaponquantity",
		"torso",
		"legs",
		"shield",
		"gloves",
		"boots",
		"ring"
	]
}
</templatedata>}}
<includeonly>[[Category:Transclusion templates|{{PAGENAME}}]]</includeonly>