Template:Infobox Var/doc

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

Standard infobox parameters

This infobox uses Module:Infobox, which provides a number of standard parameters.


This infobox supports switching between multiple versions. Each version needs to have a name defined in a parameter called version#, numbered sequentially starting from 1. For all parameters that have different values, a number can be appended to the end of each parameter name to define the value for each version. Parameters without a version number will be shared between all versions.

For example, if the name of version 2 is called "Bob", you should define |name2 = Bob.


You can link to a page and have an alternative infobox appear by using a hash value, as if you were linking to a section. The hash value is the version name, as defined by the relevant version# parameter. For example, to link to the variant of a switch infobox with |version3 = Quest, you can use [[Example#Quest]].

Alternative versions are not visible or accessible when Javascript is disabled.


This overrides the name of the Semantic MediaWiki subobject that the infobox will set the parameters into. By default, an infobox with multiple versions will save properties into subobjects with the same name as the version name. This parameter only needs to be set if the version name is different from the desired subobject name, or if an unversioned infobox needs to set properties of a specific subobject (for example, when versioned and unversioned infoboxes of different types, like Item and Bonuses, are used on the same page).

This is necessary when a version name would otherwise be an invalid SMW subobject name. The value of smwname is also not permitted to be an invalid subobject name. A subobject name must not violate the following rules:

  • The first 5 characters of the name must not contain a period (.).
  • The name must not be the number zero (0).
  • The name must not be the empty string.

If the infobox does not have multiple versions, SMW properties would normally be set on the page itself. Setting smwname overrides this default behaviour and the properties will be only be set to the specified subobjects and not the page itself.

Multiple subobjects can be specified by separating the subobject names with the broken bar character (¦). The properties will be set in all of the subobjects specified.

For example, if the infobox has |version2 = H.A.M. member, this would cause an invalid subobject name due to having a period within the first 5 characters. The infobox should therefore override the smwname using |smwname2 = HAM member or something similar.

Suppressing SMW

Setting |smw = No will suppress all SMW output for the infobox.

Setting |smwX = No will suppress all SMW output for version number X.


This parameter is used only for debugging an infobox. If __dump__ is present with any value then a string version of the infobox object is dumped to the page, rather than displaying the infobox as normal. This should only be used when previewing the page and must never be saved in a mainspace page. Setting this adds Category:Dumping infoboxes to the page.

Specifically, this shows the result at the time the infobox is converted to a string. This will always occur when the module finally returns, but may instead occur earlier in the code. The object is dumped using mw.dumpObject(box). Dumping will not prevent a script error occurring.



The type of Var, either "Varbit" or "Varplayer".


The index of the Var, which should always be a number.


The name of the Varbit or Varplayer. There are no official names, but names should generally reflect the usage of the Var. This param is optional, and if it is not included, the name defaults to "Varbit X" or "Varplayer X". If used on pages other than RS:Varbit/X or RS:Varplayer/X, note that this param should be set in order to avoid strange default names being generated from the title of the page.


The content that the Var is used for, as a link. If the Var is used in multiple pieces of content, this should be explained in prose with this param set to "Multiple". If the Var is used in a way that would not be considered content, this param should be set to "Other".


The class of the Var, which describes how the Var's value is interpreted. The following classes are supported with categories.

  • Enum - Denotes a Var where each value is interpreted as a different state.
  • Switch - Denotes a Var with two values, typically 0 and 1, where one state is interpreted as ON and the other OFF.
  • Bitmap - Denotes a Var where the value of the Var is not interpreted as a single unit. Instead, each bit or groups of bits in the Var are interpreted separately.
  • Counter - Denotes a Var where the value is interpreted as a counter, usually counting up or down incrementally.
  • Other - Denotes a Var which does not fall into any of the above categories.