Template:User hiscores/doc

This is a documentation subpage for Template:User hiscores. It contains usage information, categories, and other content that is not part of the original template page.

Template:User hiscores invokes function main in Module:User hiscores using Lua.

If you wish to change how the template displays, then copy the code to a userpage and use that instead. Do not edit this page for simple display changes without consensus.

Template documentation

The User hiscores template inserts a table with all of a player's stats and hiscores, and dynamically updates when the page is refreshed. Each image on the table is a link to the relevant skill or activity, and users can hover over levels or KC to find more information, such as total XP or a player's rank on a given hiscore table.

The table is also customisable, and users can enable or disable virtual levels for skills above 99, or even set a threshold where XP (in millions) will be shown instead of a level for a skill.

Note: the template may be incorrect immediately after certain game updates where hiscore tables are changed (such as with the release of a new boss or ranked activity), until it (or Module:Hiscores) can be updated.

Usage

{{User hiscores
|name          = Player name (as shown on hiscores).
|api           = <main/iron/hardcore/ultimate/skiller/pure> (Defaults to main) set a hiscore table API to use for ranks (also displays an icon representing the account type next to the player name, where applicable)
|style         = <round/sleek> (Defaults to round) set a style for the hiscore table.
|virtual       = <yes/no> (Defaults to no) choose whether to show virtual levels post-99
|minxp         = (Defaults to 200) set an amount of xp (in millions) at which point skills will show xp gained instead of a level (whether virtual or not)
|extra-css     = (Optional) add additional CSS code.
}}

Examples

Example (default)

Below is an example of a user stat template for a player by just entering their name:

{{User hiscores
|name = Player name
}}

The example produces the following result: