CMPlayers

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.CMPlayers

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, PlayerLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class CMPlayers
extends StdLibrary
implements PlayerLibrary
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class CMPlayers.AcctThinSortCode
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary
  PlayerLibrary.PlayerCode, PlayerLibrary.PlayerSortCode, PlayerLibrary.ThinnerPlayer, PlayerLibrary.ThinPlayer

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`CMPlayers.AcctThinSortCode`

Field Summary

Fields
Modifier and Type	Field	Description
`protected SVector<PlayerAccount>`	`accountsList`
`protected boolean`	`allAccountsLoaded`
`protected long[]`	`autoPurgeDaysLevels`
`protected int`	`autoPurgeHash`
`protected static java.util.Map<java.lang.String,PlayerLibrary.PlayerSortCode>`	`charThinMap`
`protected static java.util.List<Pair<java.lang.String,java.lang.Integer>>`	`emptyPride`
`protected PlayerLibrary[]`	`playerLibList`
`protected CrossRefTreeMap<MOB,Room>`	`playerLocations`
`protected SVector<MOB>`	`playersList`
`protected long[]`	`prePurgeLevels`
`protected static int`	`PRIDE_TOP_SIZE`
`protected java.util.List<Pair<java.lang.String,java.lang.Integer>>[][]`	`topAccounts`
`protected java.util.List<Pair<java.lang.String,java.lang.Integer>>[][]`	`topPlayers`
`protected long[]`	`topPrideExpiration`

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors
Constructor Description

CMPlayers()

Constructors
Constructor	Description
`CMPlayers()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`activate()`	Activates the library.
`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.
`protected void`	`adjustTopPrideStats(java.util.List<Pair<java.lang.String,java.lang.Integer>>[][] topWhat, java.lang.String name, AccountStats.PrideStat stat, AccountStats astats)`
`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.
`protected CMPlayers.AcctThinSortCode`	`getAccountThinSortCode(java.lang.String codeName, boolean loose)`
`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.
`protected PlayerLibrary[]`	`getOtherPlayerLibAllHosts()`
`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,
`protected PlayerLibrary.ThinPlayer`	`getThinPlayer(MOB mob)`
`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.
`protected java.lang.String`	`getThinSortValue(PlayerAccount account, CMPlayers.AcctThinSortCode code)`
`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.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`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.
`protected void`	`saveLastMonthsTopsData(boolean debugTopThread)`
`int`	`savePlayers()`	Saves all cached players.
`protected void`	`selectRandomTitle(PlayerStats pStats)`
`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.
`boolean`	`shutdown()`	Shuts down the library.
`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.
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`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
getServiceClient, L, propertiesLoaded

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

- Field Detail
  - playersList
```
protected SVector<MOB> playersList
```
  - accountsList
```
protected SVector<PlayerAccount> accountsList
```
  - allAccountsLoaded
```
protected boolean allAccountsLoaded
```
  - playerLocations
```
protected CrossRefTreeMap<MOB,Room> playerLocations
```
  - autoPurgeDaysLevels
```
protected long[] autoPurgeDaysLevels
```
  - prePurgeLevels
```
protected long[] prePurgeLevels
```
  - autoPurgeHash
```
protected int autoPurgeHash
```
  - playerLibList
```
protected PlayerLibrary[] playerLibList
```
  - PRIDE_TOP_SIZE
```
protected static final int PRIDE_TOP_SIZE
```
    See Also:
    
    Constant Field Values
  - topPrideExpiration
```
protected final long[] topPrideExpiration
```
  - topPlayers
```
protected final java.util.List<Pair<java.lang.String,java.lang.Integer>>[][] topPlayers
```
  - topAccounts
```
protected final java.util.List<Pair<java.lang.String,java.lang.Integer>>[][] topAccounts
```
  - emptyPride
```
protected static final java.util.List<Pair<java.lang.String,java.lang.Integer>> emptyPride
```
  - charThinMap
```
protected static final java.util.Map<java.lang.String,PlayerLibrary.PlayerSortCode> charThinMap
```
- Constructor Detail
  - CMPlayers
```
public CMPlayers()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Overrides:
    
    ID in class StdLibrary
    
    Returns:
    
    the name of this class
  - numPlayers
```
public int numPlayers()
```
    Description copied from interface: PlayerLibrary
    
    Returns the number of player character mobs currently cached by this manager.
    
    Specified by:
    
    numPlayers in interface PlayerLibrary
    
    Returns:
    
    the number of cached players
    
    See Also:
    
    PlayerLibrary.delPlayer(MOB), PlayerLibrary.addPlayer(MOB), PlayerLibrary.players()
  - addPlayer
```
public void addPlayer(MOB newOne)
```
    Description copied from interface: PlayerLibrary
    
    Adds a reference to the given player char mob to this manager cache.
    
    Specified by:
    
    addPlayer in interface PlayerLibrary
    
    Parameters:
    
    newOne - the player mob to add
    
    See Also:
    
    PlayerLibrary.delPlayer(MOB), PlayerLibrary.numPlayers(), PlayerLibrary.players()
  - delPlayer
```
public void delPlayer(MOB oneToDel)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    delPlayer in interface PlayerLibrary
    
    Parameters:
    
    oneToDel - the player char mob to remove from the cache
    
    See Also:
    
    PlayerLibrary.addPlayer(MOB), PlayerLibrary.numPlayers(), PlayerLibrary.players()
  - getPlayersHere
```
public java.util.Set<MOB> getPlayersHere(Room room)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getPlayersHere in interface PlayerLibrary
    
    Parameters:
    
    room - the room curious about
    
    Returns:
    
    the set of chars, or null
    
    See Also:
    
    PlayerLibrary.changePlayersLocation(MOB, Room)
  - changePlayersLocation
```
public void changePlayersLocation(MOB mob,
                                  Room room)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    changePlayersLocation in interface PlayerLibrary
    
    Parameters:
    
    mob - the player to keep tracking
    
    room - the room the player is in, or null to remove him altogther
    
    See Also:
    
    PlayerLibrary.getPlayersHere(Room)
  - getThinPlayer
```
public PlayerLibrary.ThinPlayer getThinPlayer(java.lang.String mobName)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getThinPlayer in interface PlayerLibrary
    
    Parameters:
    
    mobName - the char name
    
    Returns:
    
    the ThinPlayer
    
    See Also:
    
    PlayerLibrary.ThinPlayer, PlayerLibrary.newThinnerPlayer(), PlayerLibrary.thinPlayers(String, Map)
  - getThinPlayer
```
protected PlayerLibrary.ThinPlayer getThinPlayer(MOB mob)
```
  - getLoadPlayerByEmail
```
public MOB getLoadPlayerByEmail(java.lang.String email)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getLoadPlayerByEmail in interface PlayerLibrary
    
    Parameters:
    
    email - email address to find a player for
    
    Returns:
    
    null, or the player char mob found
    
    See Also:
    
    PlayerLibrary.getLoadPlayer(String), PlayerLibrary.getLoadPlayerAllHosts(String)
  - unloadOfflinePlayer
```
public void unloadOfflinePlayer(MOB mob)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    unloadOfflinePlayer in interface PlayerLibrary
    
    Parameters:
    
    mob - the player char to unload
  - isSameAccount
```
public boolean isSameAccount(MOB player1,
                             MOB player2)
```
    Description copied from interface: PlayerLibrary
    
    Given two player characters, this will return whether they either share an account.
    
    Specified by:
    
    isSameAccount in interface PlayerLibrary
    
    Parameters:
    
    player1 - the first player mob
    
    player2 - the second player mob
    
    Returns:
    
    whether they are on the same account
    
    See Also:
    
    PlayerLibrary.isSameAccount(MOB, MOB), PlayerLibrary.isSameAccountIP(MOB, MOB)
  - isSameAccountIP
```
public boolean isSameAccountIP(MOB player1,
                               MOB player2)
```
    Description copied from interface: PlayerLibrary
    
    Given two player characters, this will return whether they either share an account, or the same ip address.
    
    Specified by:
    
    isSameAccountIP in interface PlayerLibrary
    
    Parameters:
    
    player1 - the first player mob
    
    player2 - the second player mob
    
    Returns:
    
    whether they are probably the same person
    
    See Also:
    
    PlayerLibrary.isSameAccount(MOB, MOB), PlayerLibrary.isSameAccountIP(MOB, MOB)
  - getLoadAccount
```
public PlayerAccount getLoadAccount(java.lang.String calledThis)
```
    Description copied from interface: PlayerLibrary
    
    Returns null or an account of the given name if it exists in the database managed by this player lib.
    
    Specified by:
    
    getLoadAccount in interface PlayerLibrary
    
    Parameters:
    
    calledThis - the name of the account
    
    Returns:
    
    the account found, or null
    
    See Also:
    
    PlayerLibrary.getLoadAccountByEmail(String)
  - addAccount
```
public void addAccount(PlayerAccount acct)
```
    Description copied from interface: PlayerLibrary
    
    Adds a new account to this player manager, for caching only.
    
    Specified by:
    
    addAccount in interface PlayerLibrary
    
    Parameters:
    
    acct - the new account
  - getLoadAccountByEmail
```
public PlayerAccount getLoadAccountByEmail(java.lang.String email)
```
    Description copied from interface: PlayerLibrary
    
    Returns null or an account of the given email addy if it exists in the database managed by this player lib.
    
    Specified by:
    
    getLoadAccountByEmail in interface PlayerLibrary
    
    Parameters:
    
    email - the email of the account
    
    Returns:
    
    the account found, or null
    
    See Also:
    
    PlayerLibrary.getLoadAccount(String)
  - getAccount
```
public PlayerAccount getAccount(java.lang.String calledThis)
```
    Description copied from interface: PlayerLibrary
    
    Returns null or an account of the given name if it exists in the cache managed by this player lib.
    
    Specified by:
    
    getAccount in interface PlayerLibrary
    
    Parameters:
    
    calledThis - the name of the account
    
    Returns:
    
    the account found, or null
    
    See Also:
    
    PlayerLibrary.getAccountAllHosts(String)
  - getOtherPlayerLibAllHosts
```
protected PlayerLibrary[] getOtherPlayerLibAllHosts()
```
  - getAccountAllHosts
```
public PlayerAccount getAccountAllHosts(java.lang.String calledThis)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getAccountAllHosts in interface PlayerLibrary
    
    Parameters:
    
    calledThis - the name of the account
    
    Returns:
    
    the account found, or null
    
    See Also:
    
    PlayerLibrary.getAccount(String)
  - getPlayerLists
```
public java.util.List<java.lang.String> getPlayerLists()
```
    Description copied from interface: PlayerLibrary
    
    Returns a list of all player char names in the database.
    
    Specified by:
    
    getPlayerLists in interface PlayerLibrary
    
    Returns:
    
    list of all player names
    
    See Also:
    
    PlayerLibrary.getPlayerListsAllHosts()
  - getPlayerListsAllHosts
```
public java.util.List<java.lang.String> getPlayerListsAllHosts()
```
    Description copied from interface: PlayerLibrary
    
    Returns a list of all player char names from all databases connected to the same map as this player manager.
    
    Specified by:
    
    getPlayerListsAllHosts in interface PlayerLibrary
    
    Returns:
    
    list of all player names
    
    See Also:
    
    PlayerLibrary.getPlayerLists()
  - getPlayer
```
public MOB getPlayer(java.lang.String calledThis)
```
    Description copied from interface: PlayerLibrary
    
    Given a player character name, this will search the list of cached player mobs and return the one with that name.
    
    Specified by:
    
    getPlayer in interface PlayerLibrary
    
    Parameters:
    
    calledThis - the cached player to get
    
    Returns:
    
    null if not cached, or the player char mob
    
    See Also:
    
    PlayerLibrary.getPlayerAllHosts(String)
  - getPlayerAllHosts
```
public MOB getPlayerAllHosts(java.lang.String calledThis)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getPlayerAllHosts in interface PlayerLibrary
    
    Parameters:
    
    calledThis - the cached player to get
    
    Returns:
    
    null if not cached, or the player char mob
    
    See Also:
    
    PlayerLibrary.getPlayer(String)
  - getLoadPlayerAllHosts
```
public MOB getLoadPlayerAllHosts(java.lang.String last)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getLoadPlayerAllHosts in interface PlayerLibrary
    
    Parameters:
    
    last - the character name
    
    Returns:
    
    null, or the character found
    
    See Also:
    
    PlayerLibrary.getLoadPlayerByEmail(String), PlayerLibrary.getLoadPlayer(String)
  - getLoadPlayer
```
public MOB getLoadPlayer(java.lang.String last)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getLoadPlayer in interface PlayerLibrary
    
    Parameters:
    
    last - the character name
    
    Returns:
    
    null, or the character found
    
    See Also:
    
    PlayerLibrary.getLoadPlayerByEmail(String), PlayerLibrary.getLoadPlayerAllHosts(String)
  - getLiegeOfUserAllHosts
```
public java.lang.String getLiegeOfUserAllHosts(java.lang.String userName)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getLiegeOfUserAllHosts in interface PlayerLibrary
    
    Parameters:
    
    userName - the player char name
    
    Returns:
    
    "", or the name of the player's liege
  - accountExists
```
public boolean accountExists(java.lang.String name)
```
    Description copied from interface: PlayerLibrary
    
    Returns whether an account of the given name exists in the database managed by this player lib.
    
    Specified by:
    
    accountExists in interface PlayerLibrary
    
    Parameters:
    
    name - the name of the account
    
    Returns:
    
    true if the account exists
    
    See Also:
    
    PlayerLibrary.accountExistsAllHosts(String)
  - accountExistsAllHosts
```
public boolean accountExistsAllHosts(java.lang.String name)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    accountExistsAllHosts in interface PlayerLibrary
    
    Parameters:
    
    name - the name of the account
    
    Returns:
    
    true if the account exists
    
    See Also:
    
    PlayerLibrary.accountExists(String)
  - isLoadedPlayer
```
public boolean isLoadedPlayer(MOB M)
```
    Description copied from interface: PlayerLibrary
    
    Returns whether the given player char mob is currently cached by this player manager.
    
    Specified by:
    
    isLoadedPlayer in interface PlayerLibrary
    
    Parameters:
    
    M - the player char
    
    Returns:
    
    true if cached, false otherwise
    
    See Also:
    
    PlayerLibrary.isLoadedPlayer(String)
  - isLoadedPlayer
```
public boolean isLoadedPlayer(java.lang.String mobName)
```
    Description copied from interface: PlayerLibrary
    
    Returns whether the given player char name is currently cached by this player manager.
    
    Specified by:
    
    isLoadedPlayer in interface PlayerLibrary
    
    Parameters:
    
    mobName - the player char name
    
    Returns:
    
    true if cached, false otherwise
    
    See Also:
    
    PlayerLibrary.isLoadedPlayer(MOB)
  - playerExists
```
public boolean playerExists(java.lang.String name)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    playerExists in interface PlayerLibrary
    
    Parameters:
    
    name - the player name
    
    Returns:
    
    true if the player exists anywhere
    
    See Also:
    
    PlayerLibrary.playerExistsAllHosts(String)
  - playerExistsAllHosts
```
public boolean playerExistsAllHosts(java.lang.String name)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    playerExistsAllHosts in interface PlayerLibrary
    
    Parameters:
    
    name - the player name
    
    Returns:
    
    true if the player exists anywhere
    
    See Also:
    
    PlayerLibrary.playerExists(String)
  - players
```
public java.util.Enumeration<MOB> players()
```
    Description copied from interface: PlayerLibrary
    
    Returns an enumeration of all cached players in this manager.
    
    Specified by:
    
    players in interface PlayerLibrary
    
    Returns:
    
    the enumeration of cached player mobs
    
    See Also:
    
    PlayerLibrary.delPlayer(MOB), PlayerLibrary.addPlayer(MOB), PlayerLibrary.numPlayers()
  - accounts
```
public java.util.Enumeration<PlayerAccount> accounts()
```
    Description copied from interface: PlayerLibrary
    
    Returns an enumeration of all player account objects
    
    Specified by:
    
    accounts in interface PlayerLibrary
    
    Returns:
    
    an enumeration of all player account objects
    
    See Also:
    
    PlayerLibrary.accounts(String, Map)
  - getTopPridePlayers
```
public java.util.List<Pair<java.lang.String,java.lang.Integer>> getTopPridePlayers(TimeClock.TimePeriod period,
                                                                                   AccountStats.PrideStat stat)
```
    Description copied from interface: PlayerLibrary
    
    Returns the top winning character names and the associated values that got them there, for the given time period and given pridestat.
    
    Specified by:
    
    getTopPridePlayers in interface PlayerLibrary
    
    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), PlayerLibrary.parsePrideStats(String[], String[]), PlayerLibrary.resetAllPrideStats()
  - getTopPrideAccounts
```
public java.util.List<Pair<java.lang.String,java.lang.Integer>> getTopPrideAccounts(TimeClock.TimePeriod period,
                                                                                    AccountStats.PrideStat stat)
```
    Description copied from interface: PlayerLibrary
    
    Returns the top winning account names and the associated values that got them there, for the given time period and given pridestat.
    
    Specified by:
    
    getTopPrideAccounts in interface PlayerLibrary
    
    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), PlayerLibrary.parsePrideStats(String[], String[]), PlayerLibrary.resetAllPrideStats()
  - bumpPrideStat
```
public int bumpPrideStat(MOB mob,
                         AccountStats.PrideStat stat,
                         int amt)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    bumpPrideStat in interface PlayerLibrary
    
    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:
    
    PlayerLibrary.getTopPrideAccounts(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), PlayerLibrary.getTopPridePlayers(com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod, com.planet_ink.coffee_mud.Common.interfaces.AccountStats.PrideStat), PlayerLibrary.parsePrideStats(String[], String[]), PlayerLibrary.resetAllPrideStats()
  - adjustTopPrideStats
```
protected void adjustTopPrideStats(java.util.List<Pair<java.lang.String,java.lang.Integer>>[][] topWhat,
                                   java.lang.String name,
                                   AccountStats.PrideStat stat,
                                   AccountStats astats)
```
  - renamePlayer
```
public void renamePlayer(MOB mob,
                         java.lang.String oldName)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    renamePlayer in interface PlayerLibrary
    
    Parameters:
    
    mob - the player char who has been renamed
    
    oldName - the previous name
  - obliteratePlayer
```
public void obliteratePlayer(MOB deadMOB,
                             boolean deleteAssets,
                             boolean quiet)
```
    Description copied from interface: PlayerLibrary
    
    Obliterates a cached loaded player character from the database, from the cache, from everything. Deletes a character completely and forever.
    
    Specified by:
    
    obliteratePlayer in interface PlayerLibrary
    
    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
  - obliterateAccountOnly
```
public void obliterateAccountOnly(PlayerAccount deadAccount)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    obliterateAccountOnly in interface PlayerLibrary
    
    Parameters:
    
    deadAccount - the account to obliterate
  - savePlayers
```
public int savePlayers()
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    savePlayers in interface PlayerLibrary
    
    Returns:
    
    the number of players saved
  - getSortValue
```
public java.lang.String getSortValue(MOB player,
                                     PlayerLibrary.PlayerSortCode code)
```
    Description copied from interface: PlayerLibrary
    
    Given a player character mob, and a sort code, this will return the sortable string value of that attribute,
    
    Specified by:
    
    getSortValue in interface PlayerLibrary
    
    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, PlayerLibrary.getThinSortValue(ThinPlayer, PlayerSortCode), PlayerLibrary.getCharThinSortCode(String, boolean)
  - getThinSortValue
```
public java.lang.Object getThinSortValue(PlayerLibrary.ThinPlayer player,
                                         PlayerLibrary.PlayerSortCode code)
```
    Description copied from interface: PlayerLibrary
    
    Given a player character thinplayer obj, and a sort code, this will return the sortable string value of that attribute,
    
    Specified by:
    
    getThinSortValue in interface PlayerLibrary
    
    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, PlayerLibrary.getSortValue(MOB, PlayerSortCode), PlayerLibrary.getCharThinSortCode(String, boolean), PlayerLibrary.getThinPlayer(String)
  - getThinSortValue
```
protected java.lang.String getThinSortValue(PlayerAccount account,
                                            CMPlayers.AcctThinSortCode code)
```
  - getCharThinSortCode
```
public PlayerLibrary.PlayerSortCode getCharThinSortCode(java.lang.String codeName,
                                                        boolean loose)
```
    Description copied from interface: PlayerLibrary
    
    Given a possible sort code name, and now exact of a match you want, this might return a player sort code match.
    
    Specified by:
    
    getCharThinSortCode in interface PlayerLibrary
    
    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, PlayerLibrary.getSortValue(MOB, PlayerSortCode), PlayerLibrary.getThinSortValue(ThinPlayer, PlayerSortCode), PlayerLibrary.getThinPlayer(String)
  - getAccountThinSortCode
```
protected CMPlayers.AcctThinSortCode getAccountThinSortCode(java.lang.String codeName,
                                                            boolean loose)
```
  - thinPlayers
```
public java.util.Enumeration<PlayerLibrary.ThinPlayer> thinPlayers(java.lang.String sort,
                                                                   java.util.Map<java.lang.String,java.lang.Object> cache)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    thinPlayers in interface PlayerLibrary
    
    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, PlayerLibrary.getThinPlayer(String), PlayerLibrary.newThinnerPlayer()
  - parsePrideStats
```
public Pair<java.lang.Long,int[]>[] parsePrideStats(java.lang.String[] nextPeriods,
                                                    java.lang.String[] prideStats)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    parsePrideStats in interface PlayerLibrary
    
    Parameters:
    
    nextPeriods - the timestamps by period
    
    prideStats - the previous stat values by period
    
    Returns:
    
    the array of pairs
    
    See Also:
    
    PlayerLibrary.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), PlayerLibrary.resetAllPrideStats()
  - findPlayerOnline
```
public MOB findPlayerOnline(java.lang.String srchStr,
                            boolean exactOnly)
```
    Description copied from interface: PlayerLibrary
    
    Given a player name, or substring for searching, this will return a player character object that is presently online and in the game.
    
    Specified by:
    
    findPlayerOnline in interface PlayerLibrary
    
    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
  - newThinnerPlayer
```
public PlayerLibrary.ThinnerPlayer newThinnerPlayer()
```
    Description copied from interface: PlayerLibrary
    
    Factory method for a ThinnerPlayer object, so that new features can be added in the future w/o having to change many files.
    
    Specified by:
    
    newThinnerPlayer in interface PlayerLibrary
    
    Returns:
    
    a ThinnerPlayer object you can modify
    
    See Also:
    
    PlayerLibrary.ThinnerPlayer
  - accounts
```
public java.util.Enumeration<PlayerAccount> accounts(java.lang.String sort,
                                                     java.util.Map<java.lang.String,java.lang.Object> cache)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    accounts in interface PlayerLibrary
    
    Parameters:
    
    sort - null, or AcctThinSortCode name
    
    cache - map that can contain a cashed enum vector
    
    Returns:
    
    the enum of ALL player accounts
    
    See Also:
    
    PlayerLibrary.accounts()
  - resetAllPrideStats
```
public void resetAllPrideStats()
```
    Description copied from interface: PlayerLibrary
    
    Causes the pride stats list to be reloaded from the player database.
    
    Specified by:
    
    resetAllPrideStats in interface PlayerLibrary
    
    See Also:
    
    PlayerLibrary.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), PlayerLibrary.parsePrideStats(String[], String[])
  - getPlayerValue
```
public java.lang.Object getPlayerValue(java.lang.String playerName,
                                       PlayerLibrary.PlayerCode code)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    getPlayerValue in interface PlayerLibrary
    
    Parameters:
    
    playerName - player character name
    
    code - PlayerCode to fetch
    
    Returns:
    
    value the character value
    
    See Also:
    
    PlayerLibrary.PlayerCode, PlayerLibrary.setPlayerValue(String, PlayerCode, Object)
  - setPlayerValue
```
public void setPlayerValue(java.lang.String playerName,
                           PlayerLibrary.PlayerCode code,
                           java.lang.Object value)
```
    Description copied from interface: PlayerLibrary
    
    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.
    
    Specified by:
    
    setPlayerValue in interface PlayerLibrary
    
    Parameters:
    
    playerName - player character name
    
    code - PlayerCode to change
    
    value - the new value
    
    See Also:
    
    PlayerLibrary.PlayerCode, PlayerLibrary.getPlayerValue(String, PlayerCode)
  - activate
```
public boolean activate()
```
    Description copied from interface: CMLibrary
    
    Activates the library. This is called after the mud is booted, but before connections are accepted.
    
    Specified by:
    
    activate in interface CMLibrary
    
    Overrides:
    
    activate in class StdLibrary
    
    Returns:
    
    true if activation was successful, false if you're screwed
    
    See Also:
    
    CMLibrary.shutdown()
  - saveLastMonthsTopsData
```
protected void saveLastMonthsTopsData(boolean debugTopThread)
```
  - selectRandomTitle
```
protected void selectRandomTitle(PlayerStats pStats)
```
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class StdLibrary
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - shutdown
```
public boolean shutdown()
```
    Description copied from interface: CMLibrary
    
    Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.
    
    Specified by:
    
    shutdown in interface CMLibrary
    
    Overrides:
    
    shutdown in class StdLibrary
    
    Returns:
    
    true if shutdown was successful, false if there's nothing you can do about it
    
    See Also:
    
    CMLibrary.activate()

Class CMPlayers

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary

Field Summary

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Constructor Summary

Method Summary

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

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

playersList

accountsList

allAccountsLoaded

playerLocations

autoPurgeDaysLevels

prePurgeLevels

autoPurgeHash

playerLibList

PRIDE_TOP_SIZE

topPrideExpiration

topPlayers

topAccounts

emptyPride

charThinMap

Constructor Detail

CMPlayers

Method Detail

ID

numPlayers

addPlayer

delPlayer

getPlayersHere

changePlayersLocation

getThinPlayer

getThinPlayer

getLoadPlayerByEmail

unloadOfflinePlayer

isSameAccount

isSameAccountIP

getLoadAccount

addAccount

getLoadAccountByEmail

getAccount

getOtherPlayerLibAllHosts

getAccountAllHosts

getPlayerLists

getPlayerListsAllHosts

getPlayer

getPlayerAllHosts

getLoadPlayerAllHosts

getLoadPlayer

getLiegeOfUserAllHosts

accountExists

accountExistsAllHosts

isLoadedPlayer

isLoadedPlayer

playerExists

playerExistsAllHosts

players

accounts

getTopPridePlayers

getTopPrideAccounts

bumpPrideStat

adjustTopPrideStats

renamePlayer

obliteratePlayer

obliterateAccountOnly

savePlayers

getSortValue

getThinSortValue

getThinSortValue

getCharThinSortCode

getAccountThinSortCode

thinPlayers

parsePrideStats