Template:Equipment/doc

From RuneRealm Wiki

This is the current revision of this page, as edited by Alex (talk | contribs) at 00:04, 16 October 2024 (Created page with "{{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 w..."). The present address (URL) is a permanent link to this version.

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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.

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

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

Results in:

2147M
2147M

Equipments table with stats

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

Results in:

Attack bonusStab: +0Slash: +0Crush: +0Magic: +0Range: +0Defence bonusStab: +0Slash: +0Crush: +0Magic: +0Range: +0Other bonusesMelee strength: +0Ranged strength: +0Magic damage: +0.0%Prayer: +0 0.0 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
Stringoptional
Use equipment tab with buttons?buttons

Shows equipment interface buttons if set to yes

Default
no
Example
yes
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
Stringoptional
Head slot itemhead

Name of the item to put in the head slot

Example
Rune full helm
Page nameoptional
Cape slot itemcape

Name of the item to put in the cape slot

Example
Cape of legends
Page nameoptional
Neck slot itemneck

Name of the item to put in the neck slot

Example
Amulet of power
Page nameoptional
Ammo slot itemammo

Name of the item to put in the ammo slot

Example
Rune arrows
Page nameoptional
Ammo quantityammoquantity

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

Example
10
Numberoptional
Second ammo slot itemammo2

Name of the item to put in the second ammo slot (for Dizana's quiver or bolt pouch)

Example
Diamond bolts (e)
Page nameoptional
Second ammo quantityammo2quantity

Ammo quantity for the second ammo slot (e.g. for arrows or bolts)

Example
10
Numberoptional
Weapon slot itemweapon

Name of the item to put in the weapon slot

Example
Rune battleaxe
Page nameoptional
Weapon quantityweaponquantity

Quantity (used for thrown weapons)

Example
73
Numberoptional
Torso slot itemtorso

Name of the item to put in the torso slot

Example
Rune platebody
Page nameoptional
Legs slot itemlegs

Name of the item to put in the legs slot

Example
Rune platelegs
Page nameoptional
Shield slot itemshield

Name of the item to put in the shield slot

Example
Rune kite shield
Page nameoptional
Gloves slot itemgloves

Name of the item to put in the gloves slot

Example
Barrows gloves
Page nameoptional
Boots slot itemboots

Name of the item to put in the boots slot

Example
Rune boots
Page nameoptional
Ring slot itemring

Name of the item to put in the ring slot

Example
Diamond ring
Page nameoptional