Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ExpLevelLibrary

All Superinterfaces:

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

All Known Implementing Classes:

CoffeeLevels

public interface ExpLevelLibrary
extends CMLibrary

Library which handles the gaining and losing of experience, as well as the gaining and losing of levels. Also handles giving mobs stats appropriate to their level.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExpLevelLibrary.ModXP	Class for tracking conditional changes to XP.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
int	adjustedExperience(MOB mob, MOB victim, int amount)	Given a killer mob, and his victim, and a base amount of experience, this method will adjust the experience gain according to context, levels and so forth
Command	deferCommandCheck(MOB mob, Command C, java.util.List<java.lang.String> cmds)	Checks whether the given Command is assigned as the Deferred XP Assignment command in the coffeemud.ini file.
MOB	fillOutMOB(CharClass C, Race R, int level)	This method fills in combat and rejuvenation related stats for the given mob of the given class at the given level.
MOB	fillOutMOB(MOB mob, int level)	This method fills in combat and rejuvenation related stats for the given mob of their current base class at the given level.
void	gainExperience(MOB mob, java.lang.String sourceId, MOB victim, java.lang.String homage, int amount, boolean quiet)	Called whenever a player actually gains any experience.
void	gainRPExperience(MOB mob, java.lang.String sourceId, MOB victim, java.lang.String homageMessage, int amount, boolean quiet)	Called whenever a player actually gains RP experience.
int	getEffectFudgedLevel(MOB mob)	Calculates the 'Power Level' for the given mob.
int	getLevelAttack(MOB mob)	Returns the amount of combat prowess the given mob would have being their current base class.
int	getLevelExperience(MOB mob, int level)	Returns how much experience a player must have to be the given level.
int	getLevelExperienceJustThisLevel(MOB mob, int level)	Returns how much experience a player must gain at this level to advance to the next.
int	getLevelHitPoints(MOB mob)	Returns the amount of mana the given npc mob should have
int	getLevelMana(MOB mob)	Returns the amount of mana the given mob would have being their current base class.
int	getLevelMOBArmor(MOB mob)	Returns the armor rating the given mob would have being their current base class.
int	getLevelMOBDamage(MOB mob)	Returns the amount of damage per hit the given mob would have being their current base class.
double	getLevelMOBSpeed(MOB mob)	Returns the number of attacks the given mob would have being their current base class.
double[]	getLevelMoneyRange(MOB mob)	Returns the range of money the given mob would have being their current base class.
int	getLevelMove(MOB mob)	Returns the amount of movement the given mob would have being their current base class.
int	getPlayerHitPoints(MOB mob)	Returns the amount of hp the given player would have being their current base class.
int	getPowerLevel(MOB M)	Returns the combat power level of the mob based on basic combat stats.
void	handleExperienceChange(CMMsg msg)	Handles a message dealing with an experience change and applies it if necessary.
void	handleRPExperienceChange(CMMsg msg)	Handles a message dealing with an RP experience change and applies it if necessary.
int	handleXPMods(MOB mob, MOB target, ExpLevelLibrary.ModXP mod, java.lang.String sourceID, boolean useTarget, int amount)	Modifies the given amount of experience and returns the modification, according to the global rules defined by XPMOD in the ini file.
void	level(MOB mob)	Causes the given mob to gain a level, with all that entails
void	loseExperience(MOB mob, java.lang.String sourceId, int amount)	Called whenever a member loses any experience.
void	loseRPExperience(MOB mob, java.lang.String sourceId, int amount)	Called whenever a player actually loses RP experience.
ExpLevelLibrary.ModXP[]	parseXPMods(java.lang.String modStr)	Given an encoded string of xp mods (see help on Prop_ModExperience), this will return the parsed and ready to use mod objects.
int	postExperience(MOB mob, java.lang.String sourceID, MOB victim, java.lang.String homage, int amount, boolean quiet)	Generates and posts a normal experience gain message, allowing it to be previewed, modified, and then to happen.
boolean	postExperienceToAllAboard(Physical possibleShip, java.lang.String sourceID, int amount, Physical target)	If the given item is a boardable, this method will post the given amount of experience to all aboard.
boolean	postRPExperience(MOB mob, java.lang.String sourceID, MOB target, java.lang.String homage, int amount, boolean quiet)	Generates and posts a rolePlay experience gain message, allowing it to be previewed, modified, and then to happen.
void	unLevel(MOB mob)	Causes the given mob to lose a level, with all that entails This might include losing skills/abilities, and always includes things like losing trains and pracs

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

getLevelExperience

int getLevelExperience(MOB mob,
                       int level)

Returns how much experience a player must have to be the given level.

Parameters:

mob - the mob who has the experience level

level - the level to base the exp on

Returns:

the amount of experiene required to be the given level

getLevelExperienceJustThisLevel

int getLevelExperienceJustThisLevel(MOB mob,
                                    int level)

Returns how much experience a player must gain at this level to advance to the next.

Parameters:

mob - the mob who has the experience level

level - the level to check at

Returns:

the amount of experience

getEffectFudgedLevel

int getEffectFudgedLevel(MOB mob)

Calculates the 'Power Level' for the given mob. The Power Level is determined by the EFFECTCXL from the ini file, and reflects Affects on the mob cast by higher level friends.

Parameters:

mob - the mob to get the power level of

Returns:

the power level, which might be same as normal level

handleExperienceChange

void handleExperienceChange(CMMsg msg)

Handles a message dealing with an experience change and applies it if necessary. Can be called with any sort of message and it will filter it.

Parameters:

msg - the message to check and maybe handle

See Also:

handleRPExperienceChange(CMMsg), adjustedExperience(MOB, MOB, int), postExperience(MOB, String, MOB, String, int, boolean), gainExperience(MOB, String, MOB, String, int, boolean), loseExperience(MOB, String, int)

handleRPExperienceChange

void handleRPExperienceChange(CMMsg msg)

Handles a message dealing with an RP experience change and applies it if necessary. Can be called with any sort of message and it will filter it.

Parameters:

msg - the message to check and maybe handle

See Also:

handleExperienceChange(CMMsg), gainRPExperience(MOB, String, MOB, String, int, boolean), loseRPExperience(MOB, String, int), postRPExperience(MOB, String, MOB, String, int, boolean)

adjustedExperience

int adjustedExperience(MOB mob,
                       MOB victim,
                       int amount)

Given a killer mob, and his victim, and a base amount of experience, this method will adjust the experience gain according to context, levels and so forth

Parameters:

mob - the killer who gains xp

victim - the victim

amount - the base amount of xp to gain

Returns:

the adjusted amount of xp

See Also:

handleExperienceChange(CMMsg), postExperience(MOB, String, MOB, String, int, boolean)

loseRPExperience

void loseRPExperience(MOB mob,
                      java.lang.String sourceId,
                      int amount)

Called whenever a player actually loses RP experience.

Parameters:

mob - the mob to take experience from

sourceId - an arbitrary string denoting the xp source

amount - the amount of experience to lose

See Also:

gainRPExperience(MOB, String, MOB, String, int, boolean), postRPExperience(MOB, String, MOB, String, int, boolean), handleRPExperienceChange(CMMsg), loseExperience(MOB, String, int)

gainRPExperience

void gainRPExperience(MOB mob,
                      java.lang.String sourceId,
                      MOB victim,
                      java.lang.String homageMessage,
                      int amount,
                      boolean quiet)

Called whenever a player actually gains RP experience.

Parameters:

mob - the mob to distribute experience to

sourceId - an arbitrary string denoting the xp source

victim - the mob killed, if any, to cause the experience gain

homageMessage - the name, if any, of another mob whose gain experience is causing this gain

amount - the amount of experience to gain

quiet - true if no messages should be given

See Also:

loseRPExperience(MOB, String, int), postRPExperience(MOB, String, MOB, String, int, boolean), handleRPExperienceChange(CMMsg), gainExperience(MOB, String, MOB, String, int, boolean)

postRPExperience

boolean postRPExperience(MOB mob,
                         java.lang.String sourceID,
                         MOB target,
                         java.lang.String homage,
                         int amount,
                         boolean quiet)

Generates and posts a rolePlay experience gain message, allowing it to be previewed, modified, and then to happen.

Parameters:

mob - the gainer of the rp xp

sourceID - null, or arbitrary string that denotes source of the xp

target - the target of the event that causes the xp to be gained

homage - null, or person to credit the xp to (or clan, or a message, whatever)

amount - the amount of xp to gain

quiet - true to gain xp silently, false to be up front.

Returns:

true if the xp was granted.

See Also:

loseRPExperience(MOB, String, int), gainRPExperience(MOB, String, MOB, String, int, boolean), handleRPExperienceChange(CMMsg), postExperience(MOB, String, MOB, String, int, boolean)

postExperience

int postExperience(MOB mob,
                   java.lang.String sourceID,
                   MOB victim,
                   java.lang.String homage,
                   int amount,
                   boolean quiet)

Generates and posts a normal experience gain message, allowing it to be previewed, modified, and then to happen.

Parameters:

mob - the gainer of the xp, usually the killer

sourceID - arbitrary string denoting the source of the xp

victim - the victim of the event that causes the xp to be gained

homage - null, or person to credit the xp to (or clan, or a message, whatever)

amount - the amount of xp to gain

quiet - true to gain xp silently, false to be up front.

Returns:

true if the xp was granted.

See Also:

handleExperienceChange(CMMsg), gainExperience(MOB, String, MOB, String, int, boolean), loseExperience(MOB, String, int), postRPExperience(MOB, String, MOB, String, int, boolean)

level

void level(MOB mob)

Causes the given mob to gain a level, with all that entails

Parameters:

mob - the mob to gain the level

See Also:

unLevel(MOB)

unLevel

void unLevel(MOB mob)

Causes the given mob to lose a level, with all that entails This might include losing skills/abilities, and always includes things like losing trains and pracs

Parameters:

mob - the mob to lose the level

See Also:

level(MOB)

deferCommandCheck

Command deferCommandCheck(MOB mob,
                          Command C,
                          java.util.List<java.lang.String> cmds)

Checks whether the given Command is assigned as the Deferred XP Assignment command in the coffeemud.ini file. If it is, then a Defer command is returned instead, thus making the original command consumed.

Parameters:

mob - the mob who is commanding

C - the command the mob wants to do

cmds - the command line that generated the command

Returns:

the command to actually execute, which is usually the one given

postExperienceToAllAboard

boolean postExperienceToAllAboard(Physical possibleShip,
                                  java.lang.String sourceID,
                                  int amount,
                                  Physical target)

If the given item is a boardable, this method will post the given amount of experience to all aboard.

Parameters:

possibleShip - the ship to give experience to

sourceID - an abitrary string denoting the source of the xp

amount - amount of experience to give to each person found

target - the vanquished whatever that was the reason for the xp

Returns:

true if experience is posted, false otherwise

fillOutMOB

MOB fillOutMOB(MOB mob,
               int level)

This method fills in combat and rejuvenation related stats for the given mob of their current base class at the given level. This method should create a mob for the caller if mob==null.

Parameters:

mob - the mob to fill out, or null

level - the level of the mob

Returns:

the filled in mob

fillOutMOB

MOB fillOutMOB(CharClass C,
               Race R,
               int level)

This method fills in combat and rejuvenation related stats for the given mob of the given class at the given level. This method should create a mob for the caller.

Parameters:

C - the class to use.

R - the race to use.

level - the level of the mob

Returns:

the filled in mob

getPlayerHitPoints

int getPlayerHitPoints(MOB mob)

Returns the amount of hp the given player would have being their current base class.

Parameters:

mob - the mob

Returns:

the amount of hp a pc should have

See Also:

getLevelHitPoints(MOB)

getLevelHitPoints

int getLevelHitPoints(MOB mob)

Returns the amount of mana the given npc mob should have

Parameters:

mob - the mob who would have hit points

Returns:

the amount of hp an npc should have

See Also:

getLevelMana(MOB), getLevelMove(MOB), getLevelMoneyRange(MOB), getPlayerHitPoints(MOB)

getLevelMana

int getLevelMana(MOB mob)

Returns the amount of mana the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the amount of mana an npc should have

See Also:

getLevelMove(MOB), getLevelMoneyRange(MOB), getLevelHitPoints(MOB)

getLevelMoneyRange

double[] getLevelMoneyRange(MOB mob)

Returns the range of money the given mob would have being their current base class. Since money is variable, this is a range low-high

Parameters:

mob - the mob

Returns:

the range of money an npc should have

See Also:

getLevelMana(MOB), getLevelMove(MOB), getLevelHitPoints(MOB)

getLevelMOBSpeed

double getLevelMOBSpeed(MOB mob)

Returns the number of attacks the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the number of attacks an npc should have

See Also:

getLevelMOBArmor(MOB), getLevelAttack(MOB), getLevelMOBDamage(MOB)

getPowerLevel

int getPowerLevel(MOB M)

Returns the combat power level of the mob based on basic combat stats.

Parameters:

M - the mob to get the power level of

Returns:

the power level

getLevelMove

int getLevelMove(MOB mob)

Returns the amount of movement the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the amount of movement an npc should have

See Also:

getLevelMana(MOB), getLevelMoneyRange(MOB), getLevelHitPoints(MOB)

getLevelAttack

int getLevelAttack(MOB mob)

Returns the amount of combat prowess the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the amount of combat prowess an npc should have

See Also:

getLevelMOBArmor(MOB), getLevelMOBDamage(MOB), getLevelMOBSpeed(MOB)

getLevelMOBArmor

int getLevelMOBArmor(MOB mob)

Returns the armor rating the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the armor rating an npc should have

See Also:

getLevelAttack(MOB), getLevelMOBDamage(MOB), getLevelMOBSpeed(MOB)

getLevelMOBDamage

int getLevelMOBDamage(MOB mob)

Returns the amount of damage per hit the given mob would have being their current base class.

Parameters:

mob - the mob

Returns:

the amount of damage per hit an npc should have

See Also:

getLevelMOBArmor(MOB), getLevelAttack(MOB), getLevelMOBSpeed(MOB)

gainExperience

void gainExperience(MOB mob,
                    java.lang.String sourceId,
                    MOB victim,
                    java.lang.String homage,
                    int amount,
                    boolean quiet)

Called whenever a player actually gains any experience. It actually does the experience gain for the player as well as determining how much, if any should be distributed to leiges or clans. Will automatically cause a call to level if necessary.

Parameters:

mob - the mob to distribute experience to

sourceId - arbitrary string denoting the source of the xp

victim - the mob killed, if any, to cause the experience gain

homage - the name, if any, of another mob whose gain experience is causing this gain

amount - the amount of experience to gain

quiet - true if no messages should be given

See Also:

level(MOB), handleExperienceChange(CMMsg), postExperience(MOB, String, MOB, String, int, boolean), loseExperience(MOB, String, int), gainRPExperience(MOB, String, MOB, String, int, boolean)

loseExperience

void loseExperience(MOB mob,
                    java.lang.String sourceId,
                    int amount)

Called whenever a member loses any experience. It actually does the experience loss for the player as well as determining how much, if any should be taken away from leiges or clans. Will automatically cause an unleveling if necessary.

Parameters:

mob - the mob to take experience away from

sourceId - arbitrary string denoting the source of xp

amount - the amount of experience to take away

See Also:

unLevel(MOB), handleExperienceChange(CMMsg), postExperience(MOB, String, MOB, String, int, boolean), gainExperience(MOB, String, MOB, String, int, boolean), loseRPExperience(MOB, String, int)

parseXPMods

ExpLevelLibrary.ModXP[] parseXPMods(java.lang.String modStr)

Given an encoded string of xp mods (see help on Prop_ModExperience), this will return the parsed and ready to use mod objects.

Parameters:

modStr - the encoded mods, or "", or null

Returns:

an array of xpmod objects

See Also:

handleXPMods(MOB, MOB, ModXP, String, boolean, int)

handleXPMods

int handleXPMods(MOB mob,
                 MOB target,
                 ExpLevelLibrary.ModXP mod,
                 java.lang.String sourceID,
                 boolean useTarget,
                 int amount)

Modifies the given amount of experience and returns the modification, according to the global rules defined by XPMOD in the ini file.

Parameters:

mob - the receiver or loser of xp

target - a possible target of the action

mod - the mods to apply

sourceID - an arbitrary string denoting the xp source

useTarget - true to use the target for masking

amount - the amount of xp tentatively

Returns:

the modified xp

See Also:

parseXPMods(String)