Template:Infobox Construction/doc

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

The standard infobox for buildable Construction objects.

For quick copy/paste

{{Infobox Construction
|name = 
|buildname = 
|image = 
|icon = 
|release = 
|update = 
|level = 
|experience = 
|room = 
|hotspot = 
|flatpack = 
|actions = 
|examine = 
|id = 
|mat1 = 
|mat1qty = 
|mat1img = 
|mat2 = 
|mat2qty = 
|mat2img = 
}}

Standard parameters

This template uses Module:Infobox, and as such the following standard parameters apply.

Versioning

This template supports versioning. To make a versioned infobox, simply add version# parameters, starting at 1 and increasing until all required versioned are covered. The value of the version parameter is the name given to the version, which applies to the button/option to select the version, as well as to any SMW subobjects used.

For example, |version1=used|version2=broken.

Other parameters can (and at least some should) be versioned, and can be done by appending corresponding integers to the parameter name (e.g. |name1=Superior tetsu body|name2=Superior tetsu body (broken)).

If a version name is set to a value that results in an invalid name for a subobject, the subobject name will be modified and Category:Pages with an invalid subobject name will be added to the page.

appliesto

This sets the Semantic MediaWiki subobject(s) that the infobox (or current infobox version) should set the parameters into. This is only required when the infobox version name is not the intended destination of semantic properties, or if an unversioned infobox needs to set properties into a specific subobject (e.g. when versioned and unversioned infoboxes (of different types, like Item and Bonuses) are used on the same page).

By default if the page has versions, properties are set into named subobjects, where the names are the version names; if the page does not have versions, the properties are set on to the page itself. Setting an appliesto overrides the default behaviour - the properties will be set to the specified subobjects and only the specified subobjects.

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

appliesto can be versioned to change where specific infobox versions set the properties.

__dump__

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

Specifically, this applies when the infobox is converted to a string, which will always occur when the module finally returns, but may occur earlier in the code. The object is dumped using mw.dumpObject(box). Dumping will not prevent a script error occuring.

Parameters

name

Name of the furniture. This should be the object's name in-game exactly, as it appears when built.

buildname

Name of the furniture in the "Build Furniture" interface (eg: "Wooden bed" is the build name, and "Bed" is the name of the object when built).

image

Image of the object.

icon

Item image of the object, as seen on the hotspot building interface or Construction skill guide.

release

Release date of the object. Should follow the format [[DD Month]] [[YYYY]]. ([[6 June]] [[2012]] etc).

update

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

removal

Optional Date the object was removed from game. Should follow the format [[DD Month]] [[YYYY]].

removalupdate

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

members

Optional Whether or not the object is members only. It is automatically informed by the level parameter. It is free-to-play if it requires a Construction level of 5 or lower, and members if it is higher than that. It should only be informed for exceptions to this rule.

level

The Construction level required to build the object.

experience

The Construction experience gained from building the object.

secSkill

Name of an additional skill required to build the object.

secLevel

The second skill's level requirement to build the object.

secXP

The second skill's experience gained from building the object.

room

The room of the player-owned house that this object can be built in. It is not necessary to use brackets as they are automatically added.

hotspot

The place within a room that this object can be built in. It is not necessary to use brackets.

flatpack

Whether or not the object can be created as a flatpack item.

actions

Right-click options the object provides. Should be a comma separated list, bullet generation is handled internally.

examine

The examine text of the object.

id

The object's internal game ID. This parameter must be a number.

mat#

Item name used for display, without brackets. If the material is nails of any type, simply use Nails.

mat#img

Item's image for display. Do not include the 'File:' prefix (though doing so will not break the template); do not use brackets. This parameter can be removed if it would be the same as "name.png"

mat#qty

The amount of the material used in the process. Omit parameter if the quantity is 1.

materials (deprecated)

A list of all the materials and their amounts required to build the object, separated by comma. This parameter is deprecated and should be replaced with the above mat# parameters.

Using switching values

Version

Infobox Construction can be used to support multiple values for each of parameters with JavaScript-run switching. Alternate versions must be named and defined with the respective "version#" parameter to appear; each version parameter should be unique and sufficiently descriptive. Infobox Construction will only look up to the highest consecutive value, starting at 1.

Parameters can be assigned different values in different versions by adding an index after the name. For example, if we want the 2nd version to be called "Object 2", we would add "|name2 = Object 2". If left blank or undefined, alternate values will default to the original value (the one without an index defined).

If there are more than 5 versions, the buttons will turn into a dropdown.

Alternative versions are not visible or accessible when Javascript is disabled, or using the mobile skin.

References

If the same parameter is used in multiple versions (but not the default, e.g. a shared image), the parameter can be set to a reference to another version of the parameter using the format $versionNumber. For example, if the image of version 4 is the same as the image in version 2, we use |image4=$2. Utilising references is only suggested for the image parameter, as using them for a numerical parameters will often result in a parsing error in the module.

Linking

If you wish to link to a page and have an alternative infobox appear, you can use 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 monster with |version3=Level 64, you can use [[Example#Level 64]].