com.planet_ink.coffee_mud.Common.interfaces
Interface PlayerStats

All Superinterfaces:

AccountStats, java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>, Contingent, Modifiable

All Known Implementing Classes:

DefaultPlayerStats

public interface PlayerStats
extends CMCommon, Modifiable, AccountStats, Contingent

Accessible from any PC mob object, PlayerStats are the repository for all manner of player specific mob values.

See Also:

MOB.playerStats()

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Common.interfaces.AccountStats

AccountStats.Agent, AccountStats.PrideStat

Field Summary

static int	BIRTHDEX_DAY Constant for day of birthday, as from getBirthday()
static int	BIRTHDEX_LASTYEARCELEBRATED Constant for year of last known birthday, as from getBirthday()
static int	BIRTHDEX_MONTH Constant for month of birthday, as from getBirthday()
static int	BIRTHDEX_YEAR Constant for year of birthday, as from getBirthday()
static long	HYGIENE_COMMONDIRTY Constant for hygiene system, denotes amount of dirtiness from using common skills
static long	HYGIENE_DELIMIT Constant for hygiene system, denotes ceiling of stinkiness before emoting
static long	HYGIENE_FIGHTDIRTY Constant for hygiene system, denotes amount of dirtiness from fighting
static long	HYGIENE_RAINCLEAN Constant for hygiene system, denotes amount of cleaning water does per tick
static long	HYGIENE_WATERCLEAN Constant for hygiene system, denotes amount of cleaning water does per tick
static int	REPLY_SAY Constant for private messenging, means the last private msg was a SAYTO
static int	REPLY_TELL Constant for private messenging, means the last private msg was a TELL
static int	REPLY_YELL Constant for private messenging, means the last private msg was a YELL

Method Summary

void	addAliasName(java.lang.String named) Adds a new alias command for this player, undefined at first.
void	addAutoInvokeList(java.lang.String abilityID) Adds the given ability ID is on the list of those skills whose autoInvocation should be suppressed.
void	addGTellStack(java.lang.String msg) Adds a new string message to the gtell stack.
void	addLegacyLevel(java.lang.String category) Adds a new legacy level in the given category.
boolean	addRoomVisit(Room R) Records the fact that this player has been to the given room.
void	addTellStack(java.lang.String msg) Adds a new string message to the tell stack.
boolean	adjHygiene(long byThisMuch) Modifies, up or down, how stinky this player is.
void	delAliasName(java.lang.String named) Removes an old alias command for this player.
PlayerAccount	getAccount() If the ACCOUNTSYSTEM is used, this will access the account object that is shared by all players of this account.
java.lang.String	getActiveTitle() Returns which of the player available titles is currently being used by this player.
java.lang.String	getAlias(java.lang.String named) Returns the definition of the given alias command for this player.
java.lang.String[]	getAliasNames() Returns the string array set of defined alias commands for this player.
java.lang.String	getAnnounceMessage() For players with the ANNOUNCE command, this is the message used to prefix the announcements proclaimed.
int[]	getBirthday() Returns a 2-dimensional integer array with the players birth day and month (in mud calendar)
int	getChannelMask() Returns a bitmask of channels turned on/off.
java.util.Map<java.lang.String,java.lang.Object>	getClassVariableMap(CharClass charClass) Returns a personal miscellaneous object map, to be used for non-core-system attributes, such as transient class variables.
java.lang.String	getColorStr() Returns a custom coded string detailing the changes to the official color code that apply to this player only.
java.util.Map<java.lang.String,int[]>	getCombatSpams() If the player has NoCombatSpam turned on, then these player settings are used to hold accumulated information about combat results for summarizing later.
java.lang.String	getDeathPoof() This is the message seen by all when the player dies.
int	getDeferredXP() Returns the current amount of deferred xp that this player has been awarded, typically over a given level.
ItemCollection	getExtItems() Gets external items belonging to this player, which should be destroyed with the player, but can still be transient.
java.util.Map<java.lang.String,ExpertiseLibrary.ExpertiseDefinition>	getExtraQualifiedExpertises() Returns a mapping definition between awarded expertise and their requirements.
java.util.Map<java.lang.String,AbilityMapper.AbilityMapping>	getExtraQualifiedSkills() Returns a mapping definition between awarded abilities and their requirements.
java.util.List<java.lang.String>	getGTellStack() Returns a List of the last few string messages sent and received to and from this players group.
long	getHygiene() Returns a long value of how stinky this player is.
long	getLastRolePlayXPTime() Returns the last time roleplay xp was earned in a way that could be spammed.
long	getLastUpdated() The time, in milis since 1970, that the player was last saved.
long	getLastXPAwardMillis() Returns the last time this player has been awarded XP.
int	getLegacyLevel(java.lang.String category) Returns the legacy levels for this player, in the given categories
int	getMaxDeferredXP() Returns the maximum amount of deferred xp that this player can be awarded, typically over a given level.
int	getMaxRolePlayXP() Returns the maximum amount of role playing xp that this player can be awarded, typically over a given level.
int	getPageBreak() Returns the page break row for this player, or 0.
java.lang.String	getPoofIn() For player with the GOTO command, this is the message seen by all when the player arrives from using GOTO.
java.lang.String	getPoofOut() For player with the GOTO command, this is the message seen by all when the player leaves using GOTO.
java.lang.String	getPrompt() Returns the custom prompt, an encoded string, for this player.
MOB	getReplyToMOB() Returns the last MOB player who sent this player a private instant message.
long	getReplyToTime() Returns the last time, in millis since 1970, that a player last sent this playe a private message.
int	getReplyType() Returns the type of private message last sent to this player, an encoded constant.
int	getRolePlayXP() Returns the current amount of role playing xp that this player has been awarded, typically over a given level.
java.lang.String	getSavedPose() Gets the saved pose string for players.
CMSecurity.SecGroup	getSecurityFlags() Returns a read-only Set of security flags that apply to this player.
java.lang.String	getSetSecurityFlags(java.lang.String newFlags) Returns and/or sets the security flags and groups strings to which this player is privileged.
java.util.List<java.lang.String>	getTellStack() Returns a List of the last few string messages sent and received to and from this player.
int	getTheme() Returns the theme used to create this player.
java.util.List<java.lang.String>	getTitles() Returns a list of modifiable title definitions.
int	getTotalLegacyLevels() Returns the total legacy levels for this player, all categories
java.lang.String	getTranPoofIn() For player with the TRANSFER command, this is the message seen by all when the player arrives from using TRANSFER.
java.lang.String	getTranPoofOut() For player with the TRANSFER command, this is the message seen by all when the player leaves using TRANSFER.
int	getWrap() Returns the word wrap column number for this player, or 0.
boolean	hasVisited(Area A) Returns whether this player has visited the given area.
boolean	hasVisited(Room R) Returns whether this player has visited the given room.
int	initializeBirthday(TimeClock clock, int ageHours, Race R) When a player is first created, this method is used to either initialize their birthday, or derive their birthday based on the number of hours they've played.
void	introduceTo(java.lang.String name) If the INTRODUCTIONSYSTEM is used, this notifys the system that this player has met the player of the given name.
boolean	isIntroducedTo(java.lang.String name) If the INTRODUCTIONSYSTEM is used, this returns true if the player has been introduced to the other player of the given name.
boolean	isOnAutoInvokeList(java.lang.String abilityID) Checks whether the given ability ID is on the list of those skills whose autoInvocation should be suppressed.
long	leveledDateTime(int level) The time, in milis since 1970, that the player gained the given level
long	leveledMinutesPlayed(int level) The number of minutes played when the player gained the given level
java.lang.String	leveledRoomID(int level) The roomID that the player gained the given level
int	percentVisited(MOB mob, Area A) Returns the percentage (0-100) of the given area that the given player has explored.
void	removeAutoInvokeList(java.lang.String abilityID) Removes the given ability ID is on the list of those skills whose autoInvocation should be suppressed.
boolean	sameAs(PlayerStats E) Whether this object instance is functionally identical to the object passed in.
void	setAccount(PlayerAccount account) If the ACCOUNTSYSTEM is used, this will allow you to set the account object that is shared by all players of this account.
void	setAlias(java.lang.String named, java.lang.String value) Modifies the commands executed by an existing alias command.
void	setAnnounceMessage(java.lang.String msg) For players with the ANNOUNCE command, this sets the message used to prefix the announcements proclaimed.
void	setChannelMask(int newMask) Sets the bitmask of channels turned on/off.
void	setColorStr(java.lang.String color) Sets a custom coded string detailing the changes to the official color code that apply to this player only.
void	setDeathPoof(java.lang.String poof) This is the message seen by all when the player dies.
void	setDeferredXP(int amt) Sets the amount of deferred xp that this player has been awarded, typically over a given level.
void	setHygiene(long newVal) Sets the number meaning how stinky this player is.
void	setLastRolePlayXPTime(long tm) Sets the last time roleplay xp was earned in a way that could be spammed.
void	setLastUpdated(long time) Sets the time, in milis since 1970, that the player was last saved.
void	setLastXPAwardMillis(long time) Sets the last time this player has been awarded XP.
void	setLeveledDateTime(int level, long ageHours, Room R) Notifies the player records that, at the moment this method was called, the player gained the given level.
void	setMaxDeferredXP(int amt) Sets the maximum amount of deferred xp that this player can be awarded, typically over a given level.
void	setMaxRolePlayXP(int amt) Sets the maximum amount of role playing xp that this player can be awarded, typically over a given level.
void	setPageBreak(int newBreak) Sets the page break row for this player, or 0.
void	setPoofs(java.lang.String poofIn, java.lang.String poofOut, java.lang.String tranPoofIn, java.lang.String tranPoofOut) For players with either the GOTO or TRANSFER command, this will set the various messages seen when coming and going using either of those commands.
void	setPrompt(java.lang.String prompt) Sets the custom prompt, an encoded string, for this player.
void	setReplyTo(MOB mob, int replyType) Sets the last MOB player who sent this player a private instant message, and some information about that tell (a defined constant).
void	setRolePlayXP(int amt) Sets the amount of role playing xp that this player has been awarded, typically over a given level.
void	setSavedPose(java.lang.String msg) Sets the saved pose string for players.
void	setTheme(int theme) Sets the theme used to create this player.
void	setWrap(int newWrap) Sets the word wrap column number for this player, or 0.
void	unVisit(Area A) Deletes the visitation record for all rooms in the given area.
void	unVisit(Room R) Deletes the visitation record for the given room

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from interface com.planet_ink.coffee_mud.Common.interfaces.AccountStats

bumpPrideStat, getAccountExpiration, getAchievementTracker, getBonusCharStatPoints, getBonusCommonSkillLimits, getBonusCraftingSkillLimits, getBonusLanguageLimits, getBonusNonCraftingSkillLimits, getEmail, getFriends, getIgnored, getLastDateTime, getLastIP, getNotes, getPasswordStr, getPrideStat, getXML, isIgnored, isIgnored, killAchievementTracker, matchesPassword, rebuildAchievementTracker, setAccountExpiration, setBonusCharStatPoints, setBonusCommonSkillLimits, setBonusCraftingSkillLimits, setBonusLanguageLimits, setBonusNonCraftingSkillLimits, setEmail, setLastDateTime, setLastIP, setNotes, setPassword, setXML

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

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

amDestroyed, destroy, isSavable, setSavable

Field Detail

BIRTHDEX_DAY

static final int BIRTHDEX_DAY

Constant for day of birthday, as from getBirthday()

See Also:

Constant Field Values

BIRTHDEX_MONTH

static final int BIRTHDEX_MONTH

Constant for month of birthday, as from getBirthday()

See Also:

Constant Field Values

BIRTHDEX_YEAR

static final int BIRTHDEX_YEAR

Constant for year of birthday, as from getBirthday()

See Also:

Constant Field Values

BIRTHDEX_LASTYEARCELEBRATED

static final int BIRTHDEX_LASTYEARCELEBRATED

Constant for year of last known birthday, as from getBirthday()

See Also:

Constant Field Values

REPLY_SAY

static final int REPLY_SAY

Constant for private messenging, means the last private msg was a SAYTO

See Also:

Constant Field Values

REPLY_YELL

static final int REPLY_YELL

Constant for private messenging, means the last private msg was a YELL

See Also:

Constant Field Values

REPLY_TELL

static final int REPLY_TELL

Constant for private messenging, means the last private msg was a TELL

See Also:

Constant Field Values

HYGIENE_DELIMIT

static final long HYGIENE_DELIMIT

Constant for hygiene system, denotes ceiling of stinkiness before emoting

See Also:

Constant Field Values

HYGIENE_WATERCLEAN

static final long HYGIENE_WATERCLEAN

Constant for hygiene system, denotes amount of cleaning water does per tick

See Also:

Constant Field Values

HYGIENE_COMMONDIRTY

static final long HYGIENE_COMMONDIRTY

Constant for hygiene system, denotes amount of dirtiness from using common skills

See Also:

Constant Field Values

HYGIENE_FIGHTDIRTY

static final long HYGIENE_FIGHTDIRTY

Constant for hygiene system, denotes amount of dirtiness from fighting

See Also:

Constant Field Values

HYGIENE_RAINCLEAN

static final long HYGIENE_RAINCLEAN

Constant for hygiene system, denotes amount of cleaning water does per tick

See Also:

Constant Field Values

Method Detail

getLastUpdated

long getLastUpdated()

The time, in milis since 1970, that the player was last saved.

Specified by:

getLastUpdated in interface AccountStats

Returns:

the time, in milis since 1970, that the player was last saved.

See Also:

setLastUpdated(long)

setLastUpdated

void setLastUpdated(long time)

Sets the time, in milis since 1970, that the player was last saved.

Specified by:

setLastUpdated in interface AccountStats

Parameters:

time - the time, in milis since 1970, that the player was last saved.

See Also:

getLastUpdated()

leveledDateTime

long leveledDateTime(int level)

The time, in milis since 1970, that the player gained the given level

Parameters:

level - the level to check for

Returns:

the time, in milis since 1970, that the player gained the given level

See Also:

setLeveledDateTime(int, long, Room)

leveledRoomID

java.lang.String leveledRoomID(int level)

The roomID that the player gained the given level

Parameters:

level - the level to check for

Returns:

roomID that the player gained the given level

See Also:

setLeveledDateTime(int, long, Room)

leveledMinutesPlayed

long leveledMinutesPlayed(int level)

The number of minutes played when the player gained the given level

Parameters:

level - the level to check for

Returns:

the minutes played before the player gained the given level

See Also:

setLeveledDateTime(int, long, Room)

setLeveledDateTime

void setLeveledDateTime(int level,
                        long ageHours,
                        Room R)

Notifies the player records that, at the moment this method was called, the player gained the given level.

Parameters:

level - the level to set up

ageHours - the hours played at this point

R - the room in which the level was gained

See Also:

leveledDateTime(int)

getChannelMask

int getChannelMask()

Returns a bitmask of channels turned on/off. (32 channels supported)

Returns:

a bitmask of channels turned on/off. (1=off)

See Also:

setChannelMask(int)

setChannelMask

void setChannelMask(int newMask)

Sets the bitmask of channels turned on/off. (32 channels supported)

Parameters:

newMask - the bitmask of channels turned on/off. (1=off)

See Also:

setChannelMask(int)

getColorStr

java.lang.String getColorStr()

Returns a custom coded string detailing the changes to the official color code that apply to this player only. The format is the Color Code Letter (the one after the ^ character) followed by the ansi color from the basic set, followed by a # character, repeated.

Returns:

a custom coded color string

See Also:

setColorStr(String)

setColorStr

void setColorStr(java.lang.String color)

Sets a custom coded string detailing the changes to the official color code that apply to this player only. The format is the Color Code Letter (the one after the ^ character) followed by the ansi color from the basic set, followed by a # character, repeated.

Parameters:

color - a custom coded color string

See Also:

getColorStr()

getSavedPose

java.lang.String getSavedPose()

Gets the saved pose string for players.

Returns:

a saved pose string

See Also:

setSavedPose(String)

setSavedPose

void setSavedPose(java.lang.String msg)

Sets the saved pose string for players.

Parameters:

msg - a saved pose string

See Also:

getSavedPose()

getWrap

int getWrap()

Returns the word wrap column number for this player, or 0.

Returns:

the word wrap column number for this player, or 0.

See Also:

setWrap(int)

setWrap

void setWrap(int newWrap)

Sets the word wrap column number for this player, or 0.

Parameters:

newWrap - the word wrap column number for this player, or 0.

See Also:

getWrap()

getPageBreak

int getPageBreak()

Returns the page break row for this player, or 0.

Returns:

the page break row for this player, or 0.

See Also:

setPageBreak(int)

setPageBreak

void setPageBreak(int newBreak)

Sets the page break row for this player, or 0.

Parameters:

newBreak - the page break row for this player, or 0.

See Also:

getPageBreak()

getPrompt

java.lang.String getPrompt()

Returns the custom prompt, an encoded string, for this player. "" means default is used.

Returns:

the custom prompt, an encoded string, or ""

See Also:

setPrompt(String)

setPrompt

void setPrompt(java.lang.String prompt)

Sets the custom prompt, an encoded string, for this player. "" means default is used.

Parameters:

prompt - the custom prompt, an encoded string, or ""

See Also:

getPrompt()

getTitles

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

Returns a list of modifiable title definitions. These are things like *, the bunny slayer and such.

Returns:

a list of modifiable title definitions

See Also:

getActiveTitle()

getActiveTitle

java.lang.String getActiveTitle()

Returns which of the player available titles is currently being used by this player. Its a string like *, the bunny slayer

Returns:

a title being used by this player

See Also:

getTitles()

getTellStack

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

Returns a List of the last few string messages sent and received to and from this player.

Returns:

a List of strings, the last few tell messages

See Also:

addTellStack(String)

addTellStack

void addTellStack(java.lang.String msg)

Adds a new string message to the tell stack.

Parameters:

msg - the new message for the tell stack.

See Also:

getTellStack()

getGTellStack

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

Returns a List of the last few string messages sent and received to and from this players group.

Returns:

a List of strings, the last few gtell messages

See Also:

addGTellStack(String)

addGTellStack

void addGTellStack(java.lang.String msg)

Adds a new string message to the gtell stack.

Parameters:

msg - the new message for the gtell stack.

See Also:

getGTellStack()

getPoofIn

java.lang.String getPoofIn()

For player with the GOTO command, this is the message seen by all when the player arrives from using GOTO.

Returns:

the poof-in GOTO message

See Also:

getPoofOut(), setPoofs(String, String, String, String)

getPoofOut

java.lang.String getPoofOut()

For player with the GOTO command, this is the message seen by all when the player leaves using GOTO.

Returns:

the poof-out GOTO message

See Also:

getPoofIn(), setPoofs(String, String, String, String)

getTranPoofIn

java.lang.String getTranPoofIn()

For player with the TRANSFER command, this is the message seen by all when the player arrives from using TRANSFER.

Returns:

the poof-in TRANSFER message

See Also:

getTranPoofOut(), setPoofs(String, String, String, String)

getTranPoofOut

java.lang.String getTranPoofOut()

For player with the TRANSFER command, this is the message seen by all when the player leaves using TRANSFER.

Returns:

the poof-out TRANSFER message

See Also:

getTranPoofIn(), setPoofs(String, String, String, String)

setPoofs

void setPoofs(java.lang.String poofIn,
              java.lang.String poofOut,
              java.lang.String tranPoofIn,
              java.lang.String tranPoofOut)

For players with either the GOTO or TRANSFER command, this will set the various messages seen when coming and going using either of those commands.

Parameters:

poofIn - the msg seen when entering a room using GOTO

poofOut - the msg seen when leaving a room using TRANSFER

tranPoofIn - the msg seen when entering a room using GOTO

tranPoofOut - the msg seen when leaving a room using TRANSFER

See Also:

getTranPoofIn(), getTranPoofOut(), getPoofIn(), getPoofOut()

getDeathPoof

java.lang.String getDeathPoof()

This is the message seen by all when the player dies.

Returns:

the death poof-message

See Also:

setDeathPoof(String)

setDeathPoof

void setDeathPoof(java.lang.String poof)

This is the message seen by all when the player dies.

Parameters:

poof - the death poof-message

See Also:

getDeathPoof()

getAnnounceMessage

java.lang.String getAnnounceMessage()

For players with the ANNOUNCE command, this is the message used to prefix the announcements proclaimed.

Returns:

prefix to announcements

See Also:

setAnnounceMessage(String)

setAnnounceMessage

void setAnnounceMessage(java.lang.String msg)

For players with the ANNOUNCE command, this sets the message used to prefix the announcements proclaimed.

Parameters:

msg - prefix to announcements

See Also:

getAnnounceMessage()

getReplyToMOB

MOB getReplyToMOB()

Returns the last MOB player who sent this player a private instant message.

Returns:

the last MOB player who sent this player a private instant message.

See Also:

setReplyTo(MOB, int), getReplyType(), getReplyToTime()

setReplyTo

void setReplyTo(MOB mob,
                int replyType)

Sets the last MOB player who sent this player a private instant message, and some information about that tell (a defined constant).

Parameters:

mob - the last MOB player who sent this player a private instant message.

replyType - the type of

See Also:

getReplyToMOB(), getReplyType(), getReplyToTime(), REPLY_SAY, REPLY_TELL, REPLY_YELL

getReplyType

int getReplyType()

Returns the type of private message last sent to this player, an encoded constant.

Returns:

the type of private message last sent to this player

See Also:

setReplyTo(MOB, int), getReplyToMOB(), getReplyToTime(), REPLY_SAY, REPLY_TELL, REPLY_YELL

getReplyToTime

long getReplyToTime()

Returns the last time, in millis since 1970, that a player last sent this playe a private message.

Returns:

the last time this player got a private message

See Also:

setReplyTo(MOB, int), getReplyToMOB(), getReplyType()

getSecurityFlags

CMSecurity.SecGroup getSecurityFlags()

Returns a read-only Set of security flags that apply to this player. All groups are accounted for.

Returns:

a group of security flags

getSetSecurityFlags

java.lang.String getSetSecurityFlags(java.lang.String newFlags)

Returns and/or sets the security flags and groups strings to which this player is privileged. The sets should be semicolon delimited.

Parameters:

newFlags - null, or a semicolon list of flags and groups

Returns:

the official parsed list of flags and groups

initializeBirthday

int initializeBirthday(TimeClock clock,
                       int ageHours,
                       Race R)

When a player is first created, this method is used to either initialize their birthday, or derive their birthday based on the number of hours they've played.

Parameters:

clock - the local clock to use for month/day calculations

ageHours - the number of hours the player played

R - the players Race

Returns:

the players new age, in mud-years

See Also:

getBirthday(), MOB.getAgeMinutes(), Race

getBirthday

int[] getBirthday()

Returns a 2-dimensional integer array with the players birth day and month (in mud calendar)

Returns:

a 2-dimensional integer array (day/month)

See Also:

initializeBirthday(TimeClock, int, Race)

getHygiene

long getHygiene()

Returns a long value of how stinky this player is.

Returns:

how stinky this player is

See Also:

adjHygiene(long), setHygiene(long), HYGIENE_DELIMIT

adjHygiene

boolean adjHygiene(long byThisMuch)

Modifies, up or down, how stinky this player is.

Parameters:

byThisMuch - an amount to adjust the stinkiness by.

Returns:

true of the amount goes past the HYGIENE_DELIMIT constant

See Also:

getHygiene(), setHygiene(long), HYGIENE_COMMONDIRTY, HYGIENE_FIGHTDIRTY, HYGIENE_WATERCLEAN, HYGIENE_DELIMIT

setHygiene

void setHygiene(long newVal)

Sets the number meaning how stinky this player is.

Parameters:

newVal - how stinky this player is.

See Also:

getHygiene(), adjHygiene(long), HYGIENE_DELIMIT

hasVisited

boolean hasVisited(Room R)

Returns whether this player has visited the given room.

Parameters:

R - the room to check and see whether the player has been there.

Returns:

true if the player has been there, false otherwise.

See Also:

hasVisited(Area), percentVisited(MOB, Area), addRoomVisit(Room), unVisit(Room), unVisit(Area)

hasVisited

boolean hasVisited(Area A)

Returns whether this player has visited the given area.

Parameters:

A - the area to check

Returns:

true if the player has been there, false otherwise

See Also:

hasVisited(Room), percentVisited(MOB, Area), addRoomVisit(Room), unVisit(Room), unVisit(Area)

percentVisited

int percentVisited(MOB mob,
                   Area A)

Returns the percentage (0-100) of the given area that the given player has explored.

Parameters:

mob - the player of these stats

A - the Area to check

Returns:

the percent of the area the player has explored

See Also:

hasVisited(Room), hasVisited(Area), addRoomVisit(Room), unVisit(Room), unVisit(Area)

addRoomVisit

boolean addRoomVisit(Room R)

Records the fact that this player has been to the given room.

Parameters:

R - the room to credit the player with

Returns:

true if this was first visit, false otherwise

See Also:

hasVisited(Room), hasVisited(Area), percentVisited(MOB, Area), unVisit(Room), unVisit(Area)

unVisit

void unVisit(Area A)

Deletes the visitation record for all rooms in the given area.

Parameters:

A - area of rooms to remove

See Also:

hasVisited(Room), hasVisited(Area), percentVisited(MOB, Area), unVisit(Room)

unVisit

void unVisit(Room R)

Deletes the visitation record for the given room

Parameters:

R - the room to remove

See Also:

hasVisited(Room), hasVisited(Area), percentVisited(MOB, Area), unVisit(Area)

getClassVariableMap

java.util.Map<java.lang.String,java.lang.Object> getClassVariableMap(CharClass charClass)

Returns a personal miscellaneous object map, to be used for non-core-system attributes, such as transient class variables.

Parameters:

charClass - the Character Class for the variables

Returns:

a personal miscellaneous object map

getAliasNames

java.lang.String[] getAliasNames()

Returns the string array set of defined alias commands for this player.

Returns:

the string array set of defined alias commands.

See Also:

getAlias(String), addAliasName(String), delAliasName(String), setAlias(String, String)

getAlias

java.lang.String getAlias(java.lang.String named)

Returns the definition of the given alias command for this player.

Parameters:

named - the alias command to get the definition of

Returns:

the command(s) to execute when the command is entered.

See Also:

getAliasNames(), addAliasName(String), delAliasName(String), setAlias(String, String)

addAliasName

void addAliasName(java.lang.String named)

Adds a new alias command for this player, undefined at first.

Parameters:

named - the name of the alias command to add

See Also:

getAliasNames(), getAlias(String), delAliasName(String), setAlias(String, String)

delAliasName

void delAliasName(java.lang.String named)

Removes an old alias command for this player.

Parameters:

named - the name of the alias command to delete

See Also:

getAliasNames(), getAlias(String), addAliasName(String), setAlias(String, String)

setAlias

void setAlias(java.lang.String named,
              java.lang.String value)

Modifies the commands executed by an existing alias command.

Parameters:

named - the alias command to modify

value - the new command(s) to execute

See Also:

getAliasNames(), getAlias(String), addAliasName(String), delAliasName(String)

isIntroducedTo

boolean isIntroducedTo(java.lang.String name)

If the INTRODUCTIONSYSTEM is used, this returns true if the player has been introduced to the other player of the given name.

Parameters:

name - the name of the other player

Returns:

true if this player has met that one, false otherwise

See Also:

introduceTo(String)

introduceTo

void introduceTo(java.lang.String name)

If the INTRODUCTIONSYSTEM is used, this notifys the system that this player has met the player of the given name.

Parameters:

name - the player whom this player just met.

See Also:

isIntroducedTo(String)

getAccount

PlayerAccount getAccount()

If the ACCOUNTSYSTEM is used, this will access the account object that is shared by all players of this account.

Returns:

the account object

setAccount

void setAccount(PlayerAccount account)

If the ACCOUNTSYSTEM is used, this will allow you to set the account object that is shared by all players of this account.

Parameters:

account - the account object

getExtItems

ItemCollection getExtItems()

Gets external items belonging to this player, which should be destroyed with the player, but can still be transient. These are items like player corpses, buried items, perhaps artifacts, or ships, vehicles, children, etc.

Returns:

an item collection

See Also:

ItemCollection, Item

sameAs

boolean sameAs(PlayerStats E)

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)

getTheme

int getTheme()

Returns the theme used to create this player.

Returns:

the theme used to create this player.

See Also:

Area.THEME_BIT_NAMES, setTheme(int)

setTheme

void setTheme(int theme)

Sets the theme used to create this player.

Parameters:

theme - the theme used to create this player.

See Also:

Area.THEME_BIT_NAMES, getTheme()

getTotalLegacyLevels

int getTotalLegacyLevels()

Returns the total legacy levels for this player, all categories

Returns:

the total legacy levels for this player

See Also:

addLegacyLevel(String), getLegacyLevel(String)

addLegacyLevel

void addLegacyLevel(java.lang.String category)

Adds a new legacy level in the given category.

Parameters:

category - the category to add a legacy level for

See Also:

getTotalLegacyLevels(), getLegacyLevel(String)

isOnAutoInvokeList

boolean isOnAutoInvokeList(java.lang.String abilityID)

Checks whether the given ability ID is on the list of those skills whose autoInvocation should be suppressed. The abilityID is case sensitive, and you can send the fake ID "ANYTHIN" to check if ANY skills are on the list.

Parameters:

abilityID - the ability ID() to suppress

Returns:

true if it is on the list, false otherwise

addAutoInvokeList

void addAutoInvokeList(java.lang.String abilityID)

Adds the given ability ID is on the list of those skills whose autoInvocation should be suppressed. The abilityID is case sensitive.

Parameters:

abilityID - the ability ID() to add

removeAutoInvokeList

void removeAutoInvokeList(java.lang.String abilityID)

Removes the given ability ID is on the list of those skills whose autoInvocation should be suppressed. The abilityID is case sensitive.

Parameters:

abilityID - the ability ID() to remove

getLegacyLevel

int getLegacyLevel(java.lang.String category)

Returns the legacy levels for this player, in the given categories

Parameters:

category - the category to add a legacy level for

Returns:

the legacy levels for this player this category

See Also:

addLegacyLevel(String), getTotalLegacyLevels()

getExtraQualifiedSkills

java.util.Map<java.lang.String,AbilityMapper.AbilityMapping> getExtraQualifiedSkills()

Returns a mapping definition between awarded abilities and their requirements. These are always above and beyond whatever is provided by class, race, or clan.

Returns:

a skill mapping, keyed by ability ID()

getExtraQualifiedExpertises

java.util.Map<java.lang.String,ExpertiseLibrary.ExpertiseDefinition> getExtraQualifiedExpertises()

Returns a mapping definition between awarded expertise and their requirements. These are always above and beyond whatever is provided by class, race, or clan.

Returns:

an expertise map

getCombatSpams

java.util.Map<java.lang.String,int[]> getCombatSpams()

If the player has NoCombatSpam turned on, then these player settings are used to hold accumulated information about combat results for summarizing later. The map is between the name of the combatant and the amount of damage taken.

Returns:

a combat damage map

getMaxRolePlayXP

int getMaxRolePlayXP()

Returns the maximum amount of role playing xp that this player can be awarded, typically over a given level.

Returns:

the maximum amount of role playing xp

See Also:

setMaxRolePlayXP(int), getRolePlayXP(), setRolePlayXP(int), AccountStats.setLastDateTime(long), getLastRolePlayXPTime()

setMaxRolePlayXP

void setMaxRolePlayXP(int amt)

Sets the maximum amount of role playing xp that this player can be awarded, typically over a given level.

Parameters:

amt - the maximum amount of role playing xp

See Also:

getMaxRolePlayXP(), getRolePlayXP(), setRolePlayXP(int), AccountStats.setLastDateTime(long), getLastRolePlayXPTime()

getRolePlayXP

int getRolePlayXP()

Returns the current amount of role playing xp that this player has been awarded, typically over a given level.

Returns:

the maximum amount of role playing xp

See Also:

setMaxRolePlayXP(int), getMaxRolePlayXP(), setRolePlayXP(int), AccountStats.setLastDateTime(long), getLastRolePlayXPTime()

setRolePlayXP

void setRolePlayXP(int amt)

Sets the amount of role playing xp that this player has been awarded, typically over a given level.

Parameters:

amt - the maximum amount of role playing xp

See Also:

getMaxRolePlayXP(), getRolePlayXP(), setMaxRolePlayXP(int), AccountStats.setLastDateTime(long), getLastRolePlayXPTime()

getLastRolePlayXPTime

long getLastRolePlayXPTime()

Returns the last time roleplay xp was earned in a way that could be spammed.

Returns:

the last time roleplay xp

See Also:

setMaxRolePlayXP(int), getMaxRolePlayXP(), setRolePlayXP(int), getRolePlayXP(), AccountStats.setLastDateTime(long)

setLastRolePlayXPTime

void setLastRolePlayXPTime(long tm)

Sets the last time roleplay xp was earned in a way that could be spammed.

Parameters:

tm - the last time roleplay xp

See Also:

getMaxRolePlayXP(), getRolePlayXP(), setRolePlayXP(int), setMaxRolePlayXP(int), getLastRolePlayXPTime()

getMaxDeferredXP

int getMaxDeferredXP()

Returns the maximum amount of deferred xp that this player can be awarded, typically over a given level.

Returns:

the maximum amount of deferred xp

See Also:

setMaxDeferredXP(int), getDeferredXP(), setDeferredXP(int)

setMaxDeferredXP

void setMaxDeferredXP(int amt)

Sets the maximum amount of deferred xp that this player can be awarded, typically over a given level.

Parameters:

amt - the maximum amount of deferred xp

See Also:

getMaxDeferredXP(), getDeferredXP(), setDeferredXP(int)

getDeferredXP

int getDeferredXP()

Returns the current amount of deferred xp that this player has been awarded, typically over a given level.

Returns:

the maximum amount of deferred xp

See Also:

setMaxDeferredXP(int), getMaxDeferredXP(), setDeferredXP(int)

setDeferredXP

void setDeferredXP(int amt)

Sets the amount of deferred xp that this player has been awarded, typically over a given level.

Parameters:

amt - the maximum amount of deferred xp

See Also:

getMaxDeferredXP(), getDeferredXP(), setMaxDeferredXP(int)

getLastXPAwardMillis

long getLastXPAwardMillis()

Returns the last time this player has been awarded XP. This is used for the guildmaster exception, where XP is only awarded under certain conditions.

Returns:

the last time this player has been awarded

setLastXPAwardMillis

void setLastXPAwardMillis(long time)

Sets the last time this player has been awarded XP. This is used for the guildmaster exception, where XP is only awarded under certain conditions.

Parameters:

time - the time xp was awarded in millis