Commit d27ae603 authored by Onei's avatar Onei
Browse files

Merge branch 'master' into tkc-memcached

Conflicts:
	README.md
parents 6c1bd9e2 15842ae5
......@@ -2,7 +2,7 @@
A MediaWiki extension that provides easy access to [RuneScape's Hiscores](http://services.runescape.com/m=hiscore/overview) for use in wikitext and JS calculators. Originally designed for the [RuneScape Wiki](http://runescape.wikia.com).
Issues and pull requests should filed [here](https://github.com/TehKittyCat/RSHiscores). However, the version used by [Wikia](http://www.wikia.com) (and the RuneScape Wiki) might be behind this version. For the version used by Wikia see [here](https://github.com/Wikia/app/tree/dev/extensions/3rdparty/RSHighscores). Alternatively, see the ['wikia' branch](https://github.com/TehKittyCat/RSHiscores/tree/wikia) for the currently submitted version.
Issues and pull requests should filed [here](https://github.com/TehKittyCat/RSHiscores). However, the version used by [Wikia](http://www.wikia.com) (and the RuneScape Wiki) might be behind this version. For the version used by Wikia see [here](https://github.com/Wikia/app/tree/dev/extensions/3rdparty/RSHighscores). Alternatively, see [Special:Version](http://runescape.wikia.com/wiki/Special:Version) on RuneScape Wiki.
# Installation
......@@ -37,7 +37,7 @@ If an error occurs, then an error code will be returned. See [Errors](#errors) f
| rs3 | RuneScape (Current) |
| osrs | Old School |
## Skills
## RS3 Skills
| Number | Skill/Activity |
| ------ | ---------------------------------- |
| -1 | Returns the raw data. (default) |
......@@ -90,26 +90,61 @@ If an error occurs, then an error code will be returned. See [Errors](#errors) f
| 46 | Heist Guard Level |
| 47 | Heist Robber Level |
| 48 | CFP: 5 Game Average |
| 49 | AF15: Cow tipping |
| 50 | AF15: Rat kills after miniquest |
## OSRS Skills
| Number | Skill/Activity |
| ------ | ---------------------------------- |
| -1 | Returns the raw data. (default) |
| 0 | Overall |
| 1 | Attack |
| 2 | Defence |
| 3 | Strength |
| 4 | Constitution |
| 5 | Ranged |
| 6 | Prayer |
| 7 | Magic |
| 8 | Cooking |
| 9 | Woodcutting |
| 10 | Fletching |
| 11 | Fishing |
| 12 | Firemaking |
| 13 | Crafting |
| 14 | Smithing |
| 15 | Mining |
| 16 | Herblore |
| 17 | Agility |
| 18 | Thieving |
| 19 | Slayer |
| 20 | Farming |
| 21 | Runecrafting |
| 22 | Hunter |
| 23 | Construction |
| 24 | Clue scrolls |
| 25 | Bounty Hunter Rogue |
| 26 | Bounty Hunter |
## Types
| Number | Type |
| ------ | --------------------- |
| 0 | Rank |
| 1 | Level/Score (default) |
| 2 | Experience |
| 2 | Experience* |
\* Experience only applies to skill levels.
## Errors
If there is an error in the usage or request, one of the following codes will be returned instead.
If there is an error in the usage or request, a message describing the error will be returned instead.
| Code | Error |
| ---- | -------------------- |
| A | No name was entered. |
| B | The player could not be found. |
| C<#> | A curl error occurred, if it's form of C<#>, check the number [here](http://curl.haxx.se/libcurl/c/libcurl-errors.html) for the cause. |
| D<#> | An unexpected HTTP status was returned, check the number [here](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for the cause. |
| E | The name call limit was reached. This is by default 2 player names. This is not a limit on the number of function calls. |
| F | The skill does not exist. |
| G | The type does not exist. |
| H | The API is unknown or unsupported. |
| The type does not exist. |
| I | A timeout error occurred, normally caused by too many requests being submitted in too short a time. This causes all requests to be prevented for a cooldown period of 15 minutes, at which point requests can be resumed. |
| Error No. | Message | Details |
| --------- | ------- | ------- |
| 1 | Player name missing. | No name was entered into the parser function usage. |
| 2 | Player was not found in RuneScape's Hiscores. | The requested player could not be found in the hiscores. |
| 3 | Unexpected cURL error returned: $1. | A cURL error occurred. See [here](http://curl.haxx.se/libcurl/c/libcurl-errors.html) for more details.
| 4 | Unexpected HTTP status returned: $1. | A HTTP status that was not 200 or 404 was returned. See [here](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for more details.
| 5 | Name call limit exceeded. | The maximum number of players per page was exceeded, as defined by `$wgRSLimit`. |
| 6 | The skill requested does not exist. | <foo> |
| 7 | The type requested does not exist. | <foo> |
| 8 | Unexpected API type entered. | The API type entered was not recognised. See [above](#API) for valid types. |
| 9 | Timeout error returned. All requests are temporarily prevented. | A timeout error occurred, normally caused by too many requests being submitted in too short a time. This causes all requests to be prevented for a cooldown period of 15 minutes, at which point requests can be resumed. |
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment