Template:Hiscore/doc

From RuneRealm Wiki

This is the current revision of this page, as edited by Alex (talk | contribs) at 00:31, 17 October 2024 (Created page with "<!-- The documentation is included as a whole in the template page which often does not show the template itself. Editing the page actually results in editing the actual template rather than the documentation. The templates to achieve a more sensible behaviour are missing from the RuneScape Wiki. As an interim measure, users should use the section edit. --> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> {{Documentation}} The '''Hiscore'''..."). 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:Hiscore.
It contains usage information, categories, and other content that is not part of the original template page.

The Hiscore template can be used to extract chosen skill levels, rank or experience for calculators.

Usage

{{Hiscore|display name|skill name|type name}}

The display name is the name of the user to retrieve the hiscore data of.

The skill name is the name of the skill to extract the information for. The skill name can be one of the following:

  • A standard skill name, such as attack, ranged, etc.
  • overall - for overall skill rank, level and xp.

The type name is the type of value to extract.

  • rank - for the skill or minigame rank.
  • lvl - for the skill level or minigame score (this is the default).
  • exp - for the skill experience (does not apply to minigames).

In the case of error, the following status codes may be returned:

  • 0 - Enter a display name.
  • 1 - The user does not exist.
  • 2 - An unknown error occurred, try again.
  • 3 - You have gone beyond the limit of two separate names per page.
  • 4 - The skill does not exist.
  • 5 - The type does not exist.

Examples

The following template call returns the overall level of a user called Example:

{{Hiscore| Example | overall}}

The following example shows the number of experience points for the user Example for the Fletching skill:

{{Hiscore| Example | fletching | exp}}