Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface PlayerLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CMPlayers

public interface PlayerLibrary
extends CMLibrary

The Player Manager is primarily a cache and lookup utility library for player character mobs and player accounts if the account system is enabled. It is mostly optimized to cache as few players as possible, providing many methods of getting and changing player character information w/o a permanent load.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PlayerLibrary.PlayerCode	The player library can query individual fields from player characters regardless of whether the player is cached or not.
static class	PlayerLibrary.PlayerSortCode	For systems that list users and allow sorting, here is an enum of the popular sort codes, along with popular alias for the code names.
static interface	PlayerLibrary.ThinnerPlayer	The absolute smallest whole view of a player char is the ThinnerPlayer interface, which requires the least work pulling from the database, short of pulling only a single field.
static interface	PlayerLibrary.ThinPlayer	Sometimes the system does not need the entire mob object and all associated attributes to make decisions about a particular player char.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
boolean	accountExists(java.lang.String name)	Returns whether an account of the given name exists in the database managed by this player lib.
boolean	accountExistsAllHosts(java.lang.String name)	Returns whether an account of the given name exists in the database managed by this player lib.
java.util.Enumeration<PlayerAccount>	accounts()	Returns an enumeration of all player account objects
java.util.Enumeration<PlayerAccount>	accounts(java.lang.String sort, java.util.Map<java.lang.String,java.lang.Object> cache)	Returns an enumeration of all account objects, with optional sort field, and optional cache so that subsequent calls are faster.
void	addAccount(PlayerAccount acct)	Adds a new account to this player manager, for caching only.
void	addPlayer(MOB newOne)	Adds a reference to the given player char mob to this manager cache.
int	bumpPrideStat(MOB mob, AccountStats.PrideStat stat, int amt)	Given a player who did something that triggers a change in a pride stat, the pride stat that changed, and the amount it changed by, this will update the pride lists and return the given value.
void	changePlayersLocation(MOB mob, Room room)	Sometimes the list of players in a given room needs to be determined rather instantly.
void	delPlayer(MOB oneToDel)	Deletes a reference to a player character mob from the cache.
MOB	findPlayerOnline(java.lang.String srchStr, boolean exactOnly)	Given a player name, or substring for searching, this will return a player character object that is presently online and in the game.
PlayerAccount	getAccount(java.lang.String calledThis)	Returns null or an account of the given name if it exists in the cache managed by this player lib.
PlayerAccount	getAccountAllHosts(java.lang.String calledThis)	Returns null or an account of the given name if it exists in the cache managed by this player lib.
PlayerLibrary.PlayerSortCode	getCharThinSortCode(java.lang.String codeName, boolean loose)	Given a possible sort code name, and now exact of a match you want, this might return a player sort code match.
java.lang.String	getLiegeOfUserAllHosts(java.lang.String userName)	Given a player name, this will attempt to find the name of the liege of this player, regardless of whether they've been cached or not, and checking all user databases that share a map with the caller.
PlayerAccount	getLoadAccount(java.lang.String calledThis)	Returns null or an account of the given name if it exists in the database managed by this player lib.
PlayerAccount	getLoadAccountByEmail(java.lang.String email)	Returns null or an account of the given email addy if it exists in the database managed by this player lib.
MOB	getLoadPlayer(java.lang.String last)	Finds a player character who has the given unique name, first checking the manager cache, and if not found, goes to the associated database and loads the character into the cache and then returns it.
MOB	getLoadPlayerAllHosts(java.lang.String last)	Finds a player character who has the given unique name, first checking the manager cache, and if not found, goes to the associated database and loads the character into the cache and then returns it.
MOB	getLoadPlayerByEmail(java.lang.String email)	Finds a player character who has the given email address (possibly from their account), and loads that character into the player manager cache and then returns it.
MOB	getPlayer(java.lang.String calledThis)	Given a player character name, this will search the list of cached player mobs and return the one with that name.
MOB	getPlayerAllHosts(java.lang.String calledThis)	Given a player character name, this will search the list of cached player mobs and return the one with that name.
java.util.List<java.lang.String>	getPlayerLists()	Returns a list of all player char names in the database.
java.util.List<java.lang.String>	getPlayerListsAllHosts()	Returns a list of all player char names from all databases connected to the same map as this player manager.
java.util.Set<MOB>	getPlayersHere(Room room)	Sometimes the list of players in a given room needs to be determined rather instantly.
java.lang.Object	getPlayerValue(java.lang.String playerName, PlayerLibrary.PlayerCode code)	Given a player name, and code representing an attribute of the player character, this will fetch the value on the player, regardless of whether they are online or no.
java.lang.String	getSortValue(MOB player, PlayerLibrary.PlayerSortCode code)	Given a player character mob, and a sort code, this will return the sortable string value of that attribute,
PlayerLibrary.ThinPlayer	getThinPlayer(java.lang.String mobName)	Given a player name, this will construct a ThinPlayer object if the player char is already cached, or a new one from the database if not.
java.lang.Object	getThinSortValue(PlayerLibrary.ThinPlayer player, PlayerLibrary.PlayerSortCode code)	Given a player character thinplayer obj, and a sort code, this will return the sortable string value of that attribute,
java.util.List<Pair<java.lang.String,java.lang.Integer>>	getTopPrideAccounts(TimeClock.TimePeriod period, AccountStats.PrideStat stat)	Returns the top winning account names and the associated values that got them there, for the given time period and given pridestat.
java.util.List<Pair<java.lang.String,java.lang.Integer>>	getTopPridePlayers(TimeClock.TimePeriod period, AccountStats.PrideStat stat)	Returns the top winning character names and the associated values that got them there, for the given time period and given pridestat.
boolean	isLoadedPlayer(MOB M)	Returns whether the given player char mob is currently cached by this player manager.
boolean	isLoadedPlayer(java.lang.String mobName)	Returns whether the given player char name is currently cached by this player manager.
boolean	isSameAccount(MOB player1, MOB player2)	Given two player characters, this will return whether they either share an account.
boolean	isSameAccountIP(MOB player1, MOB player2)	Given two player characters, this will return whether they either share an account, or the same ip address.
PlayerLibrary.ThinnerPlayer	newThinnerPlayer()	Factory method for a ThinnerPlayer object, so that new features can be added in the future w/o having to change many files.
int	numPlayers()	Returns the number of player character mobs currently cached by this manager.
void	obliterateAccountOnly(PlayerAccount deadAccount)	Removes the given player account from the list of protected names, and then deletes the account from the manager cache, from the database, and from the world.
void	obliteratePlayer(MOB deadMOB, boolean deleteAssets, boolean quiet)	Obliterates a cached loaded player character from the database, from the cache, from everything.
Pair<java.lang.Long,int[]>[]	parsePrideStats(java.lang.String[] nextPeriods, java.lang.String[] prideStats)	Given an array of timestamps indexed by period ordinals, and previous pride stat values similarly indexed, this will generate an array of pairs representing the data.
boolean	playerExists(java.lang.String name)	Given a player name, this will attempt to find them and return whether they actually exist regardless of whether they've been cached or not.
boolean	playerExistsAllHosts(java.lang.String name)	Given a player name, this will attempt to find them and return whether they actually exist regardless of whether they've been cached or not, and checking all user databases that share a map with the caller.
java.util.Enumeration<MOB>	players()	Returns an enumeration of all cached players in this manager.
void	renamePlayer(MOB mob, java.lang.String oldName)	Renaming a player is quite involved, as there are so many tables and objects index by the players names.
void	resetAllPrideStats()	Causes the pride stats list to be reloaded from the player database.
int	savePlayers()	Saves all cached players.
void	setPlayerValue(java.lang.String playerName, PlayerLibrary.PlayerCode code, java.lang.Object value)	Given a player name, and code representing an attribute of the player character, and a new value appropriate to that code, this will change the value on the player, regardless of whether they are online or no.
java.util.Enumeration<PlayerLibrary.ThinPlayer>	thinPlayers(java.lang.String sort, java.util.Map<java.lang.String,java.lang.Object> cache)	Given a possible player sort code string, and an optional cache of pre-loaded key pairs, one of which might be "PLAYERLISTVECTOR"+sort, pointing to a vector of pre-loaded thinplayers, this will return an enumeration of all players in the game.
void	unloadOfflinePlayer(MOB mob)	Given a player char mob object, this will ensure that the char is indeed not currently in the game and, if so, remove them from the player cache without saving them.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLoadAccount

PlayerAccount getLoadAccount(java.lang.String calledThis)

Returns null or an account of the given name if it exists in the database managed by this player lib.

Parameters:

calledThis - the name of the account

Returns:

the account found, or null

See Also:

getLoadAccountByEmail(String)

getLoadAccountByEmail

PlayerAccount getLoadAccountByEmail(java.lang.String email)

Returns null or an account of the given email addy if it exists in the database managed by this player lib.

Parameters:

email - the email of the account

Returns:

the account found, or null

See Also:

getLoadAccount(String)

getAccount

PlayerAccount getAccount(java.lang.String calledThis)

Returns null or an account of the given name if it exists in the cache managed by this player lib.

Parameters:

calledThis - the name of the account

Returns:

the account found, or null

See Also:

getAccountAllHosts(String)

getAccountAllHosts

PlayerAccount getAccountAllHosts(java.lang.String calledThis)

Returns null or an account of the given name if it exists in the cache managed by this player lib. If not found, all other player libraries are consulted if they share the same map as this one.

Parameters:

calledThis - the name of the account

Returns:

the account found, or null

See Also:

getAccount(String)

addAccount

void addAccount(PlayerAccount acct)

Adds a new account to this player manager, for caching only.

Parameters:

acct - the new account

accountExists

boolean accountExists(java.lang.String name)

Returns whether an account of the given name exists in the database managed by this player lib.

Parameters:

name - the name of the account

Returns:

true if the account exists

See Also:

accountExistsAllHosts(String)

accountExistsAllHosts

boolean accountExistsAllHosts(java.lang.String name)

Returns whether an account of the given name exists in the database managed by this player lib. If not found, all other player libraries are consulted if they share the same map as this one.

Parameters:

name - the name of the account

Returns:

true if the account exists

See Also:

accountExists(String)

accounts

java.util.Enumeration<PlayerAccount> accounts()

Returns an enumeration of all player account objects

Returns:

an enumeration of all player account objects

See Also:

accounts(String, Map)

accounts

java.util.Enumeration<PlayerAccount> accounts(java.lang.String sort,
                                              java.util.Map<java.lang.String,java.lang.Object> cache)

Returns an enumeration of all account objects, with optional sort field, and optional cache so that subsequent calls are faster. The sort field is a AcctThinSortCode name. The cache is a map that can contain a field called "ACCOUNTLISTVECTOR" plus the sort field, and would be the vector of accounts that can be enumerated over again.

Parameters:

sort - null, or AcctThinSortCode name

cache - map that can contain a cashed enum vector

Returns:

the enum of ALL player accounts

See Also:

accounts()

isSameAccount

boolean isSameAccount(MOB player1,
                      MOB player2)

Given two player characters, this will return whether they either share an account.

Parameters:

player1 - the first player mob

player2 - the second player mob

Returns:

whether they are on the same account

See Also:

isSameAccount(MOB, MOB), isSameAccountIP(MOB, MOB)

isSameAccountIP

boolean isSameAccountIP(MOB player1,
                        MOB player2)

Given two player characters, this will return whether they either share an account, or the same ip address.

Parameters:

player1 - the first player mob

player2 - the second player mob

Returns:

whether they are probably the same person

See Also:

isSameAccount(MOB, MOB), isSameAccountIP(MOB, MOB)

obliterateAccountOnly

void obliterateAccountOnly(PlayerAccount deadAccount)

Removes the given player account from the list of protected names, and then deletes the account from the manager cache, from the database, and from the world. It does not delete the players in the account, like, at all, so it should be done last in that process.

Parameters:

deadAccount - the account to obliterate

numPlayers

int numPlayers()

Returns the number of player character mobs currently cached by this manager.

Returns:

the number of cached players

See Also:

delPlayer(MOB), addPlayer(MOB), players()

addPlayer

void addPlayer(MOB newOne)

Adds a reference to the given player char mob to this manager cache.

Parameters:

newOne - the player mob to add

See Also:

delPlayer(MOB), numPlayers(), players()

delPlayer

void delPlayer(MOB oneToDel)

Deletes a reference to a player character mob from the cache. This does not completely remove the mob from the game itself, or all their stuff, and is thus somewhat dangerous to call.

Parameters:

oneToDel - the player char mob to remove from the cache

See Also:

addPlayer(MOB), numPlayers(), players()

players

java.util.Enumeration<MOB> players()

Returns an enumeration of all cached players in this manager.

Returns:

the enumeration of cached player mobs

See Also:

delPlayer(MOB), addPlayer(MOB), numPlayers()

getPlayer

MOB getPlayer(java.lang.String calledThis)

Given a player character name, this will search the list of cached player mobs and return the one with that name.

Parameters:

calledThis - the cached player to get

Returns:

null if not cached, or the player char mob

See Also:

getPlayerAllHosts(String)

getPlayerAllHosts

MOB getPlayerAllHosts(java.lang.String calledThis)

Given a player character name, this will search the list of cached player mobs and return the one with that name. If not found in this player manager, it will search all others that share the same map.

Parameters:

calledThis - the cached player to get

Returns:

null if not cached, or the player char mob

See Also:

getPlayer(String)

findPlayerOnline

MOB findPlayerOnline(java.lang.String srchStr,
                     boolean exactOnly)

Given a player name, or substring for searching, this will return a player character object that is presently online and in the game.

Parameters:

srchStr - the name, or substring if Not exact only

exactOnly - true to only search full names, false for substring

Returns:

null, or the found online player

getLoadPlayer

MOB getLoadPlayer(java.lang.String last)

Finds a player character who has the given unique name, first checking the manager cache, and if not found, goes to the associated database and loads the character into the cache and then returns it.

Parameters:

last - the character name

Returns:

null, or the character found

See Also:

getLoadPlayerByEmail(String), getLoadPlayerAllHosts(String)

getLoadPlayerAllHosts

MOB getLoadPlayerAllHosts(java.lang.String last)

Finds a player character who has the given unique name, first checking the manager cache, and if not found, goes to the associated database and loads the character into the cache and then returns it. If not found there, it checks all other player managers who share a map with this one.

Parameters:

last - the character name

Returns:

null, or the character found

See Also:

getLoadPlayerByEmail(String), getLoadPlayer(String)

getLoadPlayerByEmail

MOB getLoadPlayerByEmail(java.lang.String email)

Finds a player character who has the given email address (possibly from their account), and loads that character into the player manager cache and then returns it. It will check the cache first, of course.

Parameters:

email - email address to find a player for

Returns:

null, or the player char mob found

See Also:

getLoadPlayer(String), getLoadPlayerAllHosts(String)

getPlayerLists

java.util.List<java.lang.String> getPlayerLists()

Returns a list of all player char names in the database.

Returns:

list of all player names

See Also:

getPlayerListsAllHosts()

getPlayerListsAllHosts

java.util.List<java.lang.String> getPlayerListsAllHosts()

Returns a list of all player char names from all databases connected to the same map as this player manager.

Returns:

list of all player names

See Also:

getPlayerLists()

isLoadedPlayer

boolean isLoadedPlayer(MOB M)

Returns whether the given player char mob is currently cached by this player manager.

Parameters:

M - the player char

Returns:

true if cached, false otherwise

See Also:

isLoadedPlayer(String)

isLoadedPlayer

boolean isLoadedPlayer(java.lang.String mobName)

Returns whether the given player char name is currently cached by this player manager.

Parameters:

mobName - the player char name

Returns:

true if cached, false otherwise

See Also:

isLoadedPlayer(MOB)

playerExists

boolean playerExists(java.lang.String name)

Given a player name, this will attempt to find them and return whether they actually exist regardless of whether they've been cached or not.

Parameters:

name - the player name

Returns:

true if the player exists anywhere

See Also:

playerExistsAllHosts(String)

playerExistsAllHosts

boolean playerExistsAllHosts(java.lang.String name)

Given a player name, this will attempt to find them and return whether they actually exist regardless of whether they've been cached or not, and checking all user databases that share a map with the caller.

Parameters:

name - the player name

Returns:

true if the player exists anywhere

See Also:

playerExists(String)

getLiegeOfUserAllHosts

java.lang.String getLiegeOfUserAllHosts(java.lang.String userName)

Given a player name, this will attempt to find the name of the liege of this player, regardless of whether they've been cached or not, and checking all user databases that share a map with the caller.

Parameters:

userName - the player char name

Returns:

"", or the name of the player's liege

obliteratePlayer

void obliteratePlayer(MOB deadMOB,
                      boolean deleteAssets,
                      boolean quiet)

Obliterates a cached loaded player character from the database, from the cache, from everything. Deletes a character completely and forever.

Parameters:

deadMOB - the player char mob object

deleteAssets - true to send retirement msg to the world and kill player data

quiet - true to do this silently, false otherwise

renamePlayer

void renamePlayer(MOB mob,
                  java.lang.String oldName)

Renaming a player is quite involved, as there are so many tables and objects index by the players names. Calling this method attempts to take care of as much as possible. To use it, first set the mob objects new name, then call this with the old one.

Parameters:

mob - the player char who has been renamed

oldName - the previous name

unloadOfflinePlayer

void unloadOfflinePlayer(MOB mob)

Given a player char mob object, this will ensure that the char is indeed not currently in the game and, if so, remove them from the player cache without saving them.

Parameters:

mob - the player char to unload

savePlayers

int savePlayers()

Saves all cached players. If the INI file does not support the player cache, this will throw out players who are offline, but otherwise leave them cached.

Returns:

the number of players saved

newThinnerPlayer

PlayerLibrary.ThinnerPlayer newThinnerPlayer()

Factory method for a ThinnerPlayer object, so that new features can be added in the future w/o having to change many files.

Returns:

a ThinnerPlayer object you can modify

See Also:

PlayerLibrary.ThinnerPlayer

getThinPlayer

PlayerLibrary.ThinPlayer getThinPlayer(java.lang.String mobName)

Given a player name, this will construct a ThinPlayer object if the player char is already cached, or a new one from the database if not.

Parameters:

mobName - the char name

Returns:

the ThinPlayer

See Also:

PlayerLibrary.ThinPlayer, newThinnerPlayer(), thinPlayers(String, Map)

thinPlayers

java.util.Enumeration<PlayerLibrary.ThinPlayer> thinPlayers(java.lang.String sort,
                                                            java.util.Map<java.lang.String,java.lang.Object> cache)

Given a possible player sort code string, and an optional cache of pre-loaded key pairs, one of which might be "PLAYERLISTVECTOR"+sort, pointing to a vector of pre-loaded thinplayers, this will return an enumeration of all players in the game.

Parameters:

sort - "", or a player sort code name

cache - null, or a map that might have a prior list

Returns:

an enumeration of all players, as thin-ones

See Also:

PlayerLibrary.PlayerSortCode, PlayerLibrary.ThinPlayer, getThinPlayer(String), newThinnerPlayer()

getCharThinSortCode

PlayerLibrary.PlayerSortCode getCharThinSortCode(java.lang.String codeName,
                                                 boolean loose)

Given a possible sort code name, and now exact of a match you want, this might return a player sort code match.

Parameters:

codeName - the possible code name

loose - true for startswith matches, false for exact

Returns:

null or the player sort code

See Also:

PlayerLibrary.PlayerSortCode, PlayerLibrary.ThinPlayer, getSortValue(MOB, PlayerSortCode), getThinSortValue(ThinPlayer, PlayerSortCode), getThinPlayer(String)

getThinSortValue

java.lang.Object getThinSortValue(PlayerLibrary.ThinPlayer player,
                                  PlayerLibrary.PlayerSortCode code)

Given a player character thinplayer obj, and a sort code, this will return the sortable string value of that attribute,

Parameters:

player - the character thinplayer obj

code - the code for the value to return

Returns:

the value of the code from the character

See Also:

PlayerLibrary.PlayerSortCode, PlayerLibrary.ThinPlayer, getSortValue(MOB, PlayerSortCode), getCharThinSortCode(String, boolean), getThinPlayer(String)

getSortValue

java.lang.String getSortValue(MOB player,
                              PlayerLibrary.PlayerSortCode code)

Given a player character mob, and a sort code, this will return the sortable string value of that attribute,

Parameters:

player - the character mob

code - the code for the value to return

Returns:

the value of the code from the character

See Also:

PlayerLibrary.PlayerSortCode, getThinSortValue(ThinPlayer, PlayerSortCode), getCharThinSortCode(String, boolean)

getPlayerValue

java.lang.Object getPlayerValue(java.lang.String playerName,
                                PlayerLibrary.PlayerCode code)

Given a player name, and code representing an attribute of the player character, this will fetch the value on the player, regardless of whether they are online or no. See PlayerCode enum for information on proper object type for the return value.

Parameters:

playerName - player character name

code - PlayerCode to fetch

Returns:

value the character value

See Also:

PlayerLibrary.PlayerCode, setPlayerValue(String, PlayerCode, Object)

setPlayerValue

void setPlayerValue(java.lang.String playerName,
                    PlayerLibrary.PlayerCode code,
                    java.lang.Object value)

Given a player name, and code representing an attribute of the player character, and a new value appropriate to that code, this will change the value on the player, regardless of whether they are online or no. See PlayerCode enum for information on proper object type for the value.

Parameters:

playerName - player character name

code - PlayerCode to change

value - the new value

See Also:

PlayerLibrary.PlayerCode, getPlayerValue(String, PlayerCode)

getPlayersHere

java.util.Set<MOB> getPlayersHere(Room room)

Sometimes the list of players in a given room needs to be determined rather instantly. This method helps do that by returning all player chars in the given room, or null.

Parameters:

room - the room curious about

Returns:

the set of chars, or null

See Also:

changePlayersLocation(MOB, Room)

changePlayersLocation

void changePlayersLocation(MOB mob,
                           Room room)

Sometimes the list of players in a given room needs to be determined rather instantly. This method helps do that by keeping a double-hash reference of players to their rooms.

Parameters:

mob - the player to keep tracking

room - the room the player is in, or null to remove him altogther

See Also:

getPlayersHere(Room)

resetAllPrideStats

void resetAllPrideStats()

Causes the pride stats list to be reloaded from the player database.

See Also:

getTopPrideAccounts(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), #see PlayerLibrary#bumpPrideStat(MOB, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat, int), parsePrideStats(String[], String[])

parsePrideStats

Pair<java.lang.Long,int[]>[] parsePrideStats(java.lang.String[] nextPeriods,
                                             java.lang.String[] prideStats)

Given an array of timestamps indexed by period ordinals, and previous pride stat values similarly indexed, this will generate an array of pairs representing the data.

Parameters:

nextPeriods - the timestamps by period

prideStats - the previous stat values by period

Returns:

the array of pairs

See Also:

getTopPrideAccounts(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), #see PlayerLibrary#bumpPrideStat(MOB, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat, int), resetAllPrideStats()

bumpPrideStat

int bumpPrideStat(MOB mob,
                  AccountStats.PrideStat stat,
                  int amt)

Given a player who did something that triggers a change in a pride stat, the pride stat that changed, and the amount it changed by, this will update the pride lists and return the given value.

Parameters:

mob - the player char who did something

stat - the pride stat reflecting what they did

amt - the amount to change the stat by + or -

Returns:

the give amt, or 0

See Also:

getTopPrideAccounts(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), getTopPridePlayers(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), parsePrideStats(String[], String[]), resetAllPrideStats()

getTopPridePlayers

java.util.List<Pair<java.lang.String,java.lang.Integer>> getTopPridePlayers(TimeClock.TimePeriod period,
                                                                            AccountStats.PrideStat stat)

Returns the top winning character names and the associated values that got them there, for the given time period and given pridestat.

Parameters:

period - the time period to get the top character for

stat - the pridestat to find winners for

Returns:

the list of top winners

See Also:

#see PlayerLibrary#bumpPrideStat(MOB, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat, int), parsePrideStats(String[], String[]), resetAllPrideStats()

getTopPrideAccounts

java.util.List<Pair<java.lang.String,java.lang.Integer>> getTopPrideAccounts(TimeClock.TimePeriod period,
                                                                             AccountStats.PrideStat stat)

Returns the top winning account names and the associated values that got them there, for the given time period and given pridestat.

Parameters:

period - the time period to get the top accounts for

stat - the pridestat to find winners for

Returns:

the list of top winners

See Also:

#see PlayerLibrary#bumpPrideStat(MOB, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat, int), parsePrideStats(String[], String[]), resetAllPrideStats()