Package com.wingman.defaultplugins.devutils.util.external

Class HiscorePlayer

java.lang.Object

com.wingman.defaultplugins.devutils.util.external.HiscorePlayer

public class HiscorePlayer
extends java.lang.Object

Class for looking up a player on the high scores. A HiscorePlayer object represents a single player on the high scores.

Example use: Retrieving a player from the standard high scores and printing the results to the console.

   new HiscorePlayer("Zezima").lookup(GameMode.STANDARD, new LookupCallback() {
     public void done(HiscorePlayer player) {
       // If the lookup was successful, iterate through the levels
       if(player != null){
         for(Level level : player.getLevels()){
           // Do something.
         }
       } else{
         // The lookup failed.
       }
     }
  });
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HiscorePlayer.Level	Class representing a single level.
static interface	HiscorePlayer.LookupCallback	Callback interface for methods to be invoked when retrieving a player from the high scores.

Constructor Summary

Constructors

Constructor	Description
HiscorePlayer()	Default constructor.
HiscorePlayer(java.lang.String playerName)	Constructs a new HiscorePlayer with a specified name.

Method Summary

Modifier and Type	Method	Description
GameMode	getLastRetrievedGameMode()	Which game mode this player's high scores were last retrieved from.
HiscorePlayer.Level	getLevel(Skill skill)	Gets this player's level for a specific skill.
java.util.Collection<HiscorePlayer.Level>	getLevels()	Returns a collection of this player's levels.
java.util.LinkedHashMap<Skill,HiscorePlayer.Level>	getLevelsMap()	Returns a mapping of skills to levels.
java.lang.String	getName()	Returns this player's name.
boolean	isBusy()	Returns whether or not this player is currently being retrieved.
boolean	isRetrieved()	Returns whether or not this player has been retrieved.
void	lookup(GameMode gameMode, HiscorePlayer.LookupCallback callback)	Asynchronously looks up the player on the high scores.
HiscorePlayer	setName(java.lang.String playerName)	Changes this player's name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HiscorePlayer

public HiscorePlayer(java.lang.String playerName)

Constructs a new HiscorePlayer with a specified name.

Parameters:

playerName - The player's name

HiscorePlayer

public HiscorePlayer()

Default constructor. The player's name should be set with HiscorePlayer#setName.

Method Detail

lookup

public void lookup(GameMode gameMode,
                   HiscorePlayer.LookupCallback callback)

Asynchronously looks up the player on the high scores.

Parameters:

gameMode - The game mode to use. If null, defaults to standard.

callback - The callback to invoke upon completion.

getLevelsMap

public java.util.LinkedHashMap<Skill,HiscorePlayer.Level> getLevelsMap()

Returns a mapping of skills to levels.

Returns:

The mapping if this player has been successfully retrieved (HiscorePlayer#isRetrieved == true). null otherwise

getLevels

public java.util.Collection<HiscorePlayer.Level> getLevels()

Returns a collection of this player's levels. The collection can be iterated in the order the skills appear on the high scores.

Returns:

If retrieved, the collection of levels. false otherwise.

getLevel

public HiscorePlayer.Level getLevel(Skill skill)

Gets this player's level for a specific skill.

Parameters:

skill - The skill to get the level for

Returns:

The level if this player has been successfully retrieved (HiscorePlayer#isRetrieved == true). null otherwise.

isRetrieved

public boolean isRetrieved()

Returns whether or not this player has been retrieved.

Returns:

true if it has; false otherwise.

getLastRetrievedGameMode

public GameMode getLastRetrievedGameMode()

Which game mode this player's high scores were last retrieved from. If isRetrieved() is false this method returns null.

Returns:

The game mode.

isBusy

public boolean isBusy()

Returns whether or not this player is currently being retrieved.

Returns:

true if this player is currently being retrieved; false otherwise.

setName

public HiscorePlayer setName(java.lang.String playerName)

Changes this player's name. HiscorePlayer#isBusy must be false for this method to take action. If the player's name is changed, any high score data previously retrieved is invalidated and must be retrieved again via HiscorePlayer#lookup.

Parameters:

playerName - The player's new name.

Returns:

reference to this if the name was successfully changed. false otherwise.

getName

public java.lang.String getName()

Returns this player's name.

Returns:

The name.