Template:Infobox Item/doc

From RuneSaga Wiki
Revision as of 21:17, 20 February 2024 by Plz2 (talk | contribs) (Created page with "{{Documentation}} {{invokes|Infobox Item}} {{ToC|left}} {{clear}} {{Standard infobox parameters}} ==Parameters== ===name=== The name of the item '''exactly''' as it appears in game (identical case and spacing). ===image=== The inventory image of the item, formatted as <nowiki>File:Image.png</nowiki>. Ideally in PNG format (or GIF format if the image is animated). For stackable items with multiple images, a...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Lua error in package.lua at line 80: module 'Module:DPLlua' not found. Template:Invokes

Template:Standard infobox parameters

Parameters

name

The name of the item exactly as it appears in game (identical case and spacing).

image

The inventory image of the item, formatted as [[File:Image.png]]. Ideally in PNG format (or GIF format if the image is animated). For stackable items with multiple images, all images should be included in increasing order.

release

Release date of the item. Should follow the format [[DD Month]] [[YYYY]].

update

Update page that the item was released with. Do not include brackets ([[ & ]]) or the Update: prefix.

removal

(Optional) Removal date of the item. Should follow the format [[DD Month]] [[YYYY]].

removalupdate

(Optional) Update page that the item was removed with. Do not include brackets ([[ & ]]) or the Update: prefix.

aka

(Optional) Other names commonly associated with the item.

members

Whether or not the item is a members only item. Must be the string "Yes" or "No".

quest

See Category:Quest items for guidelines. Also applicable for miniquests.

The possible values for this field are:

  • [[''Quest name'']]
  • No

tradeable

Whether the item is tradeable between players. For example, Barrows gloves are bought from a "shop" (Culinaromancer's Chest), but these gloves cannot be sold to other players as the Barrows gloves are not tradeable.

Examples:

  • Yes
  • No

bankable

(Optional) Whether the item can be put in the bank. Can omit if "Yes", otherwise must be the string "Yes" or "No".

stacksinbank

(Optional) Whether the item will stack in one bank space. Can omit if "Yes", otherwise must be the string "Yes" or "No".

placeholder

(Optional) Whether this item can be removed with a placeholder in the bank. (Not currently used)

equipable

Whether the item is equipable. For instance, a rune sword may be wielded (Yes), while a tinderbox may not be equipped (No). Must be the string "Yes" or "No".

stackable

Whether the item stacks in the player's inventory, in its unnoted form. For example, runes and arrows are stackable, while pickaxes are not. Must be the string "Yes" or "No".

noteable

(Optional) Whether the item can be withdrawn from the bank as a note. Can omit if "Yes", otherwise must be the string "Yes" or "No".

edible

(Optional) Whether the item is edible. This should not be added on every page, only pages describing items which are actually edible or easily mistaken as edible; i.e. shark (edible) or cooking apple (easily mistaken as edible). If omitted, the field will be hidden.

options

The right-click options for an item while held in the Inventory. The options "Use" and "Examine" should not be listed here.

wornoptions

(Optional) The right-click options for an item while it is equipped by the player, as visible in the Worn Equipment tab. The options "Remove" and "Examine" are the default, so simply put "No" if there are no options besides these.

destroy

(Optional) Text displayed as a final warning when a player tries to destroy the item. Destroy is an option for some items from quests or discontinued items and holiday drops. Certain items may behave differently when it is dropped, and this behaviour should be included in the field with - as a separator. For example, an explosive potion explodes when dropped.

Examples:

  • The Oneiromancer might be able to help you get another. - Lunar staff
  • Drop - Explodes

examine

The examine text exactly as it appears in game (identical case, spaces, typo, etc). The text is obtained through the contextual menu "Examine" option.

value

The value of the item as set by Jagex. Commas are not necessary as they are included automatically. The high and low alch values are computed from this value. Must be a number.

alchable

(Optional) Whether or not the item can be alchemised. Can be omitted to default to "Yes". Must be the string "Yes" or "No".

weight

The item's weight. The weight appears in the Equipment Stats submenu from Worn Equipment interface. The weight unit ("kilogram", "kg") need NOT be added to this field, as it is added automatically. For special weight-reducing items which has "negative" weight, the negative "-" should be included in the field.

Examples:

  • 2
  • -4.5

respawn

(Optional) The item's respawn time in ticks.

exchange

(Optional) Should be set to "Yes" if the item can be traded on the Grand Exchange. May be omitted to default to "No". Must be the string "Yes" or "No".

gemwname

(Optional) Should be included if the wiki exchange article for the item has a different name than the exact in-game name set in the name parameter. This occurs when there are multiple items with the same name on the grand exchange. Should be set to the name of the wiki exchange article for the item, or omitted if this is identical to the in game name.

id

The item's internal game ID. Must be a comma separated list of IDs. Beta IDs should be prefixed by "beta". Items that have been removed from the cache should have IDs prefixed by "hist".

Example values for this field:

  • 1234
  • 123,124,125
  • beta22326
  • hist9662,hist9663

Quick copy

{{Infobox Item
|name = 
|image = 
|release = 
|update = 
|removal = (Optional)
|removalupdate = (Optional)
|aka = (Optional)
|members = 
|quest = 
|tradeable = 
|bankable = (Optional)
|stacksinbank = (Optional)
|placeholder = (Optional)
|equipable = 
|stackable = 
|noteable = (Optional)
|edible = (Optional)
|options = 
|wornoptions = (Optional)
|destroy = 
|examine = 
|value = 
|alchable = (Optional)
|weight = 
|respawn = (Optional)
|exchange = (Optional)
|gemwname = (Optional)
|id = 
}}