Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ExpertiseLibrary

All Superinterfaces:

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

All Known Implementing Classes:

ColumbiaUniv

public interface ExpertiseLibrary
extends CMLibrary

The ExpertiseLibrary manages a list of optional, purchaseable player attributes, called expertises. Each expertise applies to a certain group of skills, and will modify the behavior or cost of those skills by the expertise type. Types of expertise include those affecting the level of the skill, its mana cost, its duration or time, and other miscellaneous scorings.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExpertiseLibrary.ExpertiseDefinition	Class definiing a single level of a particular expertise, along with all requirements to gain it.
static class	ExpertiseLibrary.XType	The Expertise Type num, which describes what skill aspect that this expertise will modify

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
boolean	addModifyDefinition(java.lang.String codedLine, boolean andSave)	Adds a temporary or permanent expertise and all of its stage definitions from a coded string.
boolean	canBeTaught(MOB teacher, MOB student, Environmental item, java.lang.String msg)	Given an Ability or ExpertiseDefinition, or msg containing a learn coded string, this will return whether the given teacher can teach, and the given student can learn the ability or expertise.
boolean	confirmAndTeach(MOB teacherM, MOB studentM, CMObject teachableO, java.lang.Runnable callBack)	Given a teacher, student, and either an Ability or Expertise, this method will confirm the lesson with the student, and call the Runnable if approval is given.
java.lang.String	confirmExpertiseLine(java.lang.String row, java.lang.String ID, boolean addIfPossible)	Validate the syntax of a coded expertise definition line, returning a readable error if found.
java.util.Enumeration<ExpertiseLibrary.ExpertiseDefinition>	definitions()	Returns an enumeration of all expertise stage definitions
boolean	delDefinition(java.lang.String ID, boolean andSave)	Can delete either a single definition stage, or all stages of a expertise, and optionally save.
java.util.Iterator<java.lang.String>	filterUniqueExpertiseIDList(java.util.Iterator<java.lang.String> i)	Given an iterator of expertise stage ids, this will return an iterator of unique expertise stage ids, filtering out other later stages.
ExpertiseLibrary.ExpertiseDefinition	findDefinition(java.lang.String ID, boolean exactOnly)	Find an expertise stage definition by name or id
java.lang.String	findExpertiseID(java.lang.String ID, boolean exact)	Finds the expertise ID being searched for, or null
java.lang.String	getApplicableExpertise(java.lang.String abilityID, ExpertiseLibrary.XType code)	Returns the base expertise id that applies to the given ability and expertise type
java.lang.String[]	getApplicableExpertises(java.lang.String abilityID, ExpertiseLibrary.XType code)	Returns all stage expertise ids that apply to the given ability and expertise type.
ExpertiseLibrary.ExpertiseDefinition	getConfirmedDefinition(MOB mob, java.lang.String ID)	Given a mob and expertise id, this method will return the definition for the expertise that the mob actually has, if it is the same.
ExpertiseLibrary.ExpertiseDefinition	getDefinition(java.lang.String ID)	Returns a single expertise stage definition
java.lang.String	getExpertiseHelp(java.lang.String ID)	Gets the help/info about a specific expertise stage.
java.lang.String	getExpertiseInstructions()	Returns the instructions for the coded line version of base expertise definitions.
int	getExpertiseLevelCached(MOB mob, java.lang.String abilityID, ExpertiseLibrary.XType code)	If the given mob has an expertise that applies the given expertise type to the given ability id, then this method will return how many levels of that expertise the mob has, or 0 if none.
int	getExpertiseLevelCalced(MOB mob, java.lang.String abilityID, ExpertiseLibrary.XType code)	If the given mob has an expertise that applies the given expertise type to the given ability id, then this method will return how many levels of that expertise the mob has, or 0 if none.
int	getHighestListableStageBySkill(MOB mob, java.lang.String ableID, ExpertiseLibrary.XType flag)	Finds the expertise that applies to the given mob and ability id and expertise type, and then returns the highest stage that is qualified for by the mob.
java.util.List<java.lang.String>	getPeerStageCodes(java.lang.String expertiseCode)	Returns the other individual expertise stage ids for all stages in the base expertise as the given full stage expertise id.
java.util.List<java.lang.String>	getStageCodes(java.lang.String baseExpertiseCode)	Returns the individual expertise stage ids for all stages in a given base expertise id.
void	handleBeingTaught(MOB teacher, MOB student, Environmental item, java.lang.String msg, int add)	Handles the teaching of an Ability or ExpertiseDefinition, either given, or by parsing a coded Learn string from a message.
java.util.List<ExpertiseLibrary.ExpertiseDefinition>	myListableExpertises(MOB mob)	Returns all the expertises that the given mob can list for possible training.
java.util.List<ExpertiseLibrary.ExpertiseDefinition>	myQualifiedExpertises(MOB mob)	Returns all the expertises that the given mob qualifies for.
int	numExpertises()	Returns the number of expertise definitions, which includes all stages for each expertise type.
int	numStages(java.lang.String baseExpertiseCode)	Returns the number of stages of the given base expertise ID.
boolean	postTeach(MOB teacher, MOB student, CMObject teachObj)	Posts a teaching message of the given Ability or ExpertiseDefinition for the given teacher and student.
void	recompileExpertises()	Re-loads all expertise definitions from the file /resources/expertises.txt (.1, .2, etc)

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

numExpertises

int numExpertises()

Returns the number of expertise definitions, which includes all stages for each expertise type.

Returns:

the number of all expertise stages

See Also:

delDefinition(String, boolean), addModifyDefinition(String, boolean), numStages(String), getDefinition(String), definitions()

addModifyDefinition

boolean addModifyDefinition(java.lang.String codedLine,
                            boolean andSave)

Adds a temporary or permanent expertise and all of its stage definitions from a coded string. The coded string format is as defined in the expertises.txt file.

Parameters:

codedLine - the coded expertise line

andSave - true to save, false to leave in ram

Returns:

true if the expertise stages were added

See Also:

delDefinition(String, boolean), numExpertises(), numStages(String), getDefinition(String), definitions(), CMMiscUtils.createCostManager(CostType, Double), confirmExpertiseLine(String, String, boolean)

delDefinition

boolean delDefinition(java.lang.String ID,
                      boolean andSave)

Can delete either a single definition stage, or all stages of a expertise, and optionally save.

Parameters:

ID - either a fully qualified, or base expertise name

andSave - true to save, false to just change ram

Returns:

true if a delete happened, false otherwise

See Also:

addModifyDefinition(String, boolean), numExpertises(), numStages(String), getDefinition(String), definitions()

getDefinition

ExpertiseLibrary.ExpertiseDefinition getDefinition(java.lang.String ID)

Returns a single expertise stage definition

Parameters:

ID - a full expertise id, including stage

Returns:

the corresponding expertise definition

See Also:

delDefinition(String, boolean), addModifyDefinition(String, boolean), numExpertises(), numStages(String), definitions()

findDefinition

ExpertiseLibrary.ExpertiseDefinition findDefinition(java.lang.String ID,
                                                    boolean exactOnly)

Find an expertise stage definition by name or id

Parameters:

ID - search string

exactOnly - true for only exact matches, false to be looser

Returns:

the found definition, or null

See Also:

delDefinition(String, boolean), addModifyDefinition(String, boolean), numExpertises(), definitions()

definitions

java.util.Enumeration<ExpertiseLibrary.ExpertiseDefinition> definitions()

Returns an enumeration of all expertise stage definitions

Returns:

all the definitions by stage

See Also:

delDefinition(String, boolean), addModifyDefinition(String, boolean), numExpertises(), findDefinition(String, boolean)

recompileExpertises

void recompileExpertises()

Re-loads all expertise definitions from the file /resources/expertises.txt (.1, .2, etc)

See Also:

delDefinition(String, boolean), addModifyDefinition(String, boolean), numExpertises(), findDefinition(String, boolean), definitions()

getExpertiseInstructions

java.lang.String getExpertiseInstructions()

Returns the instructions for the coded line version of base expertise definitions.

Returns:

the instructions from expertises.txt

getExpertiseHelp

java.lang.String getExpertiseHelp(java.lang.String ID)

Gets the help/info about a specific expertise stage.

Parameters:

ID - the expertise stage id, or search string

Returns:

help/info text for the stage

findExpertiseID

java.lang.String findExpertiseID(java.lang.String ID,
                                 boolean exact)

Finds the expertise ID being searched for, or null

Parameters:

ID - the ID to search for

exact - true for exact matches only

Returns:

null, or the final ID

numStages

int numStages(java.lang.String baseExpertiseCode)

Returns the number of stages of the given base expertise ID.

Parameters:

baseExpertiseCode - full base expertise code

Returns:

the number of stages in the expertise

See Also:

numExpertises(), getStageCodes(String), getDefinition(String)

getStageCodes

java.util.List<java.lang.String> getStageCodes(java.lang.String baseExpertiseCode)

Returns the individual expertise stage ids for all stages in a given base expertise id.

Parameters:

baseExpertiseCode - the base expertise id code

Returns:

the expertise stage id codes

See Also:

numExpertises(), numStages(String), getDefinition(String)

getPeerStageCodes

java.util.List<java.lang.String> getPeerStageCodes(java.lang.String expertiseCode)

Returns the other individual expertise stage ids for all stages in the base expertise as the given full stage expertise id.

Parameters:

expertiseCode - the full stage expertise id code

Returns:

the other expertise stage id codes

See Also:

numExpertises(), numStages(String), getDefinition(String), getStageCodes(String)

confirmExpertiseLine

java.lang.String confirmExpertiseLine(java.lang.String row,
                                      java.lang.String ID,
                                      boolean addIfPossible)

Validate the syntax of a coded expertise definition line, returning a readable error if found.

Parameters:

row - the coded definition

ID - the expertise definition id code

addIfPossible - true to cache, false to not

Returns:

an error message, or null if all is OK

See Also:

addModifyDefinition(String, boolean), CMMiscUtils.createCostManager(CostType, Double)

getConfirmedDefinition

ExpertiseLibrary.ExpertiseDefinition getConfirmedDefinition(MOB mob,
                                                            java.lang.String ID)

Given a mob and expertise id, this method will return the definition for the expertise that the mob actually has, if it is the same.

Parameters:

mob - the mob/player to check

ID - the expertise stage id

Returns:

the definition that applies, or null

See Also:

getDefinition(String), myListableExpertises(MOB), myQualifiedExpertises(MOB), getExpertiseLevelCached(MOB, String, XType), getExpertiseLevelCalced(MOB, String, XType)

myQualifiedExpertises

java.util.List<ExpertiseLibrary.ExpertiseDefinition> myQualifiedExpertises(MOB mob)

Returns all the expertises that the given mob qualifies for.

Parameters:

mob - the mob to check

Returns:

the definitions qualified for

See Also:

getDefinition(String), myListableExpertises(MOB), getConfirmedDefinition(MOB, String), getExpertiseLevelCached(MOB, String, XType), getExpertiseLevelCalced(MOB, String, XType), getHighestListableStageBySkill(MOB, String, XType)

myListableExpertises

java.util.List<ExpertiseLibrary.ExpertiseDefinition> myListableExpertises(MOB mob)

Returns all the expertises that the given mob can list for possible training.

Parameters:

mob - the mob to check

Returns:

the definitions qualified for

See Also:

getDefinition(String), myQualifiedExpertises(MOB), getConfirmedDefinition(MOB, String), getExpertiseLevelCached(MOB, String, XType), getExpertiseLevelCalced(MOB, String, XType), getHighestListableStageBySkill(MOB, String, XType)

getExpertiseLevelCached

int getExpertiseLevelCached(MOB mob,
                            java.lang.String abilityID,
                            ExpertiseLibrary.XType code)

If the given mob has an expertise that applies the given expertise type to the given ability id, then this method will return how many levels of that expertise the mob has, or 0 if none. This method employs the mob-specific cache to prevent constant recalculation.

Parameters:

mob - the player to check

abilityID - the ability to check

code - the expertise type to check

Returns:

the level of expertise that applies, or 0

See Also:

getDefinition(String), myListableExpertises(MOB), myQualifiedExpertises(MOB), getConfirmedDefinition(MOB, String), getExpertiseLevelCalced(MOB, String, XType)

getExpertiseLevelCalced

int getExpertiseLevelCalced(MOB mob,
                            java.lang.String abilityID,
                            ExpertiseLibrary.XType code)

If the given mob has an expertise that applies the given expertise type to the given ability id, then this method will return how many levels of that expertise the mob has, or 0 if none. This method employs the mob-specific cache to prevent constant recalculation.

Parameters:

mob - the player to check

abilityID - the ability to check

code - the expertise type to check

Returns:

the level of expertise that applies, or 0

See Also:

getDefinition(String), myListableExpertises(MOB), myQualifiedExpertises(MOB), getConfirmedDefinition(MOB, String), getExpertiseLevelCached(MOB, String, XType)

getHighestListableStageBySkill

int getHighestListableStageBySkill(MOB mob,
                                   java.lang.String ableID,
                                   ExpertiseLibrary.XType flag)

Finds the expertise that applies to the given mob and ability id and expertise type, and then returns the highest stage that is qualified for by the mob.

Parameters:

mob - the mob to check

ableID - the ability id

flag - the expertise type

Returns:

the highest listable stage or 0

See Also:

myListableExpertises(MOB), myQualifiedExpertises(MOB), getHighestListableStageBySkill(MOB, String, XType)

getApplicableExpertise

java.lang.String getApplicableExpertise(java.lang.String abilityID,
                                        ExpertiseLibrary.XType code)

Returns the base expertise id that applies to the given ability and expertise type

Parameters:

abilityID - ability ID

code - expertise type

Returns:

the expertise base id or null

See Also:

getApplicableExpertises(String, XType)

getApplicableExpertises

java.lang.String[] getApplicableExpertises(java.lang.String abilityID,
                                           ExpertiseLibrary.XType code)

Returns all stage expertise ids that apply to the given ability and expertise type.

Parameters:

abilityID - ability ID

code - expertise type

Returns:

the expertise stage ids or null

See Also:

getApplicableExpertise(String, XType)

handleBeingTaught

void handleBeingTaught(MOB teacher,
                       MOB student,
                       Environmental item,
                       java.lang.String msg,
                       int add)

Handles the teaching of an Ability or ExpertiseDefinition, either given, or by parsing a coded Learn string from a message.

Parameters:

teacher - the teacher mob

student - the student mob

item - the Ability or ExpertiseDefinition object

msg - an optional coded learn string

add - an amount of ability proficiency to add over default

See Also:

handleBeingTaught(MOB, MOB, Environmental, String, int), canBeTaught(MOB, MOB, Environmental, String), confirmAndTeach(MOB, MOB, CMObject, Runnable), postTeach(MOB, MOB, CMObject)

canBeTaught

boolean canBeTaught(MOB teacher,
                    MOB student,
                    Environmental item,
                    java.lang.String msg)

Given an Ability or ExpertiseDefinition, or msg containing a learn coded string, this will return whether the given teacher can teach, and the given student can learn the ability or expertise.

Parameters:

teacher - the teacher mob

student - the student mob

item - the Ability or ExpertiseDefinition object

msg - an optional coded learn string

Returns:

true if teaching is OK, false otherwise

See Also:

handleBeingTaught(MOB, MOB, Environmental, String, int), confirmAndTeach(MOB, MOB, CMObject, Runnable), postTeach(MOB, MOB, CMObject)

confirmAndTeach

boolean confirmAndTeach(MOB teacherM,
                        MOB studentM,
                        CMObject teachableO,
                        java.lang.Runnable callBack)

Given a teacher, student, and either an Ability or Expertise, this method will confirm the lesson with the student, and call the Runnable if approval is given.

Parameters:

teacherM - the teacher

studentM - the student

teachableO - the ability or expertise

callBack - the runnable to call on approval

Returns:

true if confirmation is proceeding

See Also:

handleBeingTaught(MOB, MOB, Environmental, String, int), canBeTaught(MOB, MOB, Environmental, String), postTeach(MOB, MOB, CMObject)

postTeach

boolean postTeach(MOB teacher,
                  MOB student,
                  CMObject teachObj)

Posts a teaching message of the given Ability or ExpertiseDefinition for the given teacher and student.

Parameters:

teacher - the teacher mob

student - the student mob

teachObj - the ability or expertisedefinition

Returns:

true if the posting went ok, though not necessarily a completed learn

See Also:

handleBeingTaught(MOB, MOB, Environmental, String, int), canBeTaught(MOB, MOB, Environmental, String), confirmAndTeach(MOB, MOB, CMObject, Runnable)

filterUniqueExpertiseIDList

java.util.Iterator<java.lang.String> filterUniqueExpertiseIDList(java.util.Iterator<java.lang.String> i)

Given an iterator of expertise stage ids, this will return an iterator of unique expertise stage ids, filtering out other later stages.

Parameters:

i - the id list to filter

Returns:

the filtered list