The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Runescape-Stats-0.02
/ Runescape::Stats::StatPod

NAME

Runescape::Stats::StatPod - A very, very simple module through which Runescape::Stats retuns data from it's stat retrieval functions.

SYNOPSIS

Runescape::Stats::StatPod items are created and returned by the getStat() and getAllStats() functions of Runescape::Stats.

For example: $statpod = $statsobject->getStat($username, $skill);

Each StatPod has seven accessor functions:

  • $statpod->name

    Returns username of user whose stats are within this StatPod.

  • $statpod->skill

    Returns name of Runescape skill which contains these stats for this user.

  • $statpod->lvl and $statpod->level

    Synonymic functions which both return the level of the specified user in the specified skill.

  • $statpod->rank

    Returns the rank of the specified user in the specified skill.

  • $statpod->xp, $statpod->exp, and $statpod->experience

    Synonymic functions which return the experience of the specified user in the specifed skill.

What if the user doesn't appear in the stat table?

The StatPod accessor methods for rank, level, and experience will all return undef. If any one of them returns undef, you can assume that the rest will be due to the logic used within Runescape::Stats.

AUTHORS

Designed, created, and developed by Ben Ullian : http://www.madcoder.net

URL

Information on using this module will soon be available on http://www.madcoder.net