OsrsEx v0.1.1 OsrsEx.Hiscores.Activity View Source

A Hiscores Activity.

Link to this section Summary

Types

The rank of the player compared to all other players in the activity

The score a player has in an Activity

t()

A struct for representing an anonymous skill tuple as returned from the hiscores

Link to this section Types

Link to this type rank() View Source
rank() :: 1..2000000 | nil

The rank of the player compared to all other players in the activity.

If the player is not in the top 2_000_000, then they are unranked and represented as nil.

Link to this type score() View Source
score() :: non_neg_integer()

The score a player has in an Activity.

While the Jagex Hiscore API will return -1 for unranked players, OsrsEx ensures that the minimum score is 0.

Link to this type t() View Source
t() :: %OsrsEx.Hiscores.Activity{rank: rank(), score: score()}

A struct for representing an anonymous skill tuple as returned from the hiscores