Template:Equipment/doc

From Old School RuneScape Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for Template:Equipment.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Equipment invokes function main in Module:Equipment using Lua.
Template:Equipment invokes Module:Equipment using Lua.

The Equipment template mimics the in-game display of equipped items.

Usage

{{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
|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
}}

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

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

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

When using the stats=yes parameter to show stats, it is recommended to include buttons=yes 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 stats=yes is set.

Examples

Plain equipments table

{{Equipment
|align = left
|head = Blessed coif;g
|cape = Defence cape(t);Defence cape#Trimmed
|neck = Amulet of fury
|ammo = Runite bolts
|ammoquantity = 2147483647
|weapon = 3rd age longsword
|torso = Blessed body;g
|legs = Blessed chaps;g
|shield = Blessed shield;g
|gloves = Blessed vambraces;g
|boots = Blessed boots;g
|ring = Treasonous ring
}}

Results in:

Blessed coif.gif
Defence cape(t).png
Amulet of fury.png
Runite bolts 5.png2147M
3rd age longsword.png
Blessed body.gif
Blessed shield.gif
Blessed chaps.gif
Blessed vambraces.gif
Blessed boots.gif
Treasonous ring.png

Equipments table with stats

{{Equipment
|buttons = yes
|stats = yes
|align = left
|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
}}

Results in:

Brassica halo.png
Cabbage cape.png
Gnome amulet.png
Peaceful blessing.png
Apprentice wand.png
Xerician top.png
Cabbage round shield.png
Xerician robe.png
Zombie gloves.png
Ranger boots.png
Explorer's ring 4.png
Attack bonusStab: +0Slash: +0Crush: +0Magic: +14Range: +6Defence bonusStab: +50Slash: +55Crush: +50Magic: +40Range: +25Other bonusesMelee strength: +0Ranged strength: +0Magic damage: +0.0%Prayer: +5Weight icon.png 6.7 kg

Quick Copy

{{Equipment|align = right
|buttons = 
|stats = 
|head = 
|cape = 
|neck = 
|ammo = 
|weapon = 
|torso = 
|legs = 
|shield = 
|gloves = 
|boots = 
|ring = 
}}

See also


Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

This template mimics the in-game display of equipped items.

To 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.

To switch to using the GIF version of an item icon, add ;g after the name of the item like |cape=Fire cape;g

Buttons and equipment stats can optionally be enabled to show extra features of the equipment.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Page alignmentalign

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.

Default
left
Example
right
Auto value
empty
Stringoptional
Use equipment tab with buttons?buttons

Shows equipment interface buttons if set to yes

Default
no
Example
yes
Auto value
empty
Stringoptional
Show stats next to equipment?stats

Shows equipment stats next to the loadout itself; use in combination with buttons recommended.

Default
no
Example
yes
Auto value
empty
Stringoptional
Head slot itemhead

Name of the item to put in the head slot

Default
empty
Example
Rune full helm
Auto value
empty
Pagesuggested
Cape slot itemcape

Name of the item to put in the cape slot

Default
empty
Example
Cape of legends
Auto value
empty
Pagesuggested
Neck slot itemneck

Name of the item to put in the neck slot

Default
empty
Example
Amulet of power
Auto value
empty
Pagesuggested
Ammo slot itemammo

Name of the item to put in the ammo slot

Default
empty
Example
Rune arrows
Auto value
empty
Pagesuggested
Ammo quantityammoquantity

Ammo quantity (e.g. for arrows or bolts)

Default
empty
Example
10
Auto value
empty
Numberoptional
Weapon slot itemweapon

Name of the item to put in the weapon slot

Default
empty
Example
Rune battleaxe
Auto value
empty
Pagesuggested
Weapon quantityweaponquantity

Quantity (used for thrown weapons)

Default
empty
Example
empty
Auto value
empty
Numberoptional
Torso slot itemtorso

Name of the item to put in the torso slot

Default
empty
Example
Rune platebody
Auto value
empty
Pagesuggested
Legs slot itemlegs

Name of the item to put in the legs slot

Default
empty
Example
Rune platelegs
Auto value
empty
Pagesuggested
Shield slot itemshield

Name of the item to put in the shield slot

Default
empty
Example
Rune kite shield
Auto value
empty
Pagesuggested
Gloves slot itemgloves

Name of the item to put in the gloves slot

Default
empty
Example
Barrows gloves
Auto value
empty
Pagesuggested
Boots slot itemboots

Name of the item to put in the boots slot

Default
empty
Example
Rune boots
Auto value
empty
Pagesuggested
Ring slot itemring

Name of the item to put in the ring slot

Default
empty
Example
Diamond ring
Auto value
empty
Pagesuggested