Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ExpertiseLibrary.ExpertiseDefinition

All Superinterfaces:

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

Enclosing interface:

ExpertiseLibrary

public static interface ExpertiseLibrary.ExpertiseDefinition
extends CMObject

Class definiing a single level of a particular expertise, along with all requirements to gain it.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
void	addCost(CostDef.CostType type, java.lang.Double value)	Adds another resource cost to acquire this expertise.
void	addFinalMask(java.lang.String mask)	Adds a ZapperMask describing who may acquire this expertise through training.
void	addListMask(java.lang.String mask)	Adds a ZapperMask describing who may know about the availability of this expertise.
void	addRawMasks(java.lang.String listMask, java.lang.String finalMask)	Adds the raw, unprocessed mask strings to this object.
java.lang.String	allRequirements()	Gets a ZapperMask describing who may know about the availability of this expertise AND acquire it.
MaskingLibrary.CompiledZMask	compiledFinalMask()	Gets a ZapperMask describing who may acquire this expertise through training.
MaskingLibrary.CompiledZMask	compiledListMask()	Gets a ZapperMask describing who may know about the availability of this expertise.
java.lang.String	costDescription()	Returns a friendly description of this expertise cost
java.lang.String	finalRequirements()	Gets a ZapperMask describing who may acquire this expertise through training.
java.lang.String	getBaseName()	Gets the base (non-leveled) name of this expertise, for association with its other-leveled brethren.
java.util.Set<ExpertiseLibrary.XType>	getFlagTypes()	Read/Writeable list of XType flags for this expertise.
int	getMinimumLevel()	Returns the minimum player level required to learn this expertise.
ExpertiseLibrary.ExpertiseDefinition	getParent()	If this is a later stage expertise definition, this method returns the parent/base definition.
java.lang.String[]	getStageNames()	If this expertise supports naming _DATA for each stage/level, this will return an array of the names of each stage/level for easy lookup.
java.lang.String	listRequirements()	Gets a ZapperMask describing who may know about the availability of this expertise.
boolean	meetsCostRequirements(MOB mob)	Returns whether the given mob has enough resources to cover the costs described by this expertise.
java.lang.String	rawFinalMask()	Gets the raw unprocessed final mask
java.lang.String	rawListMask()	Gets the raw unprocessed list mask
void	setBaseName(java.lang.String baseName)	Sets the base (non-leveled) name of this expertise, for association with its other-leveled brethren.
void	setID(java.lang.String ID)	Sets the code name of this expertise, including its stage/level number.
void	setName(java.lang.String name)	Sets the friendly name of this expertise, including its stage/level number.
void	setStageNames(java.lang.String[] data)	If this expertise supports naming _DATA for each stage/level, this will set an array of the names of each stage/level for easy lookup.
void	spendCostRequirements(MOB mob)	Subtracts the costs described by this class from the given mob

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

getBaseName

java.lang.String getBaseName()

Gets the base (non-leveled) name of this expertise, for association with its other-leveled brethren.

Returns:

the base name of this expertise type

See Also:

setBaseName(String)

setBaseName

void setBaseName(java.lang.String baseName)

Sets the base (non-leveled) name of this expertise, for association with its other-leveled brethren.

Parameters:

baseName - the base name of this expertise type

See Also:

getBaseName()

setName

void setName(java.lang.String name)

Sets the friendly name of this expertise, including its stage/level number. e.g. EXPERTISE8

Parameters:

name - the friendly name

setID

void setID(java.lang.String ID)

Sets the code name of this expertise, including its stage/level number. e.g. EXPERTISE8

Parameters:

ID - the code name of this expertise

setStageNames

void setStageNames(java.lang.String[] data)

If this expertise supports naming _DATA for each stage/level, this will set an array of the names of each stage/level for easy lookup.

Parameters:

data - an array of the names

See Also:

getStageNames()

getParent

ExpertiseLibrary.ExpertiseDefinition getParent()

If this is a later stage expertise definition, this method returns the parent/base definition.

Returns:

the parent/base definition.

getMinimumLevel

int getMinimumLevel()

Returns the minimum player level required to learn this expertise.

Returns:

the minimum player level required

getStageNames

java.lang.String[] getStageNames()

If this expertise supports naming _DATA for each stage/level, this will return an array of the names of each stage/level for easy lookup.

Returns:

the stage names

See Also:

setStageNames(String[])

compiledListMask

MaskingLibrary.CompiledZMask compiledListMask()

Gets a ZapperMask describing who may know about the availability of this expertise.

Returns:

a ZapperMask describing who may know about the availability of this

See Also:

MaskingLibrary

compiledFinalMask

MaskingLibrary.CompiledZMask compiledFinalMask()

Gets a ZapperMask describing who may acquire this expertise through training.

Returns:

a ZapperMask describing who acquire this

See Also:

MaskingLibrary

allRequirements

java.lang.String allRequirements()

Gets a ZapperMask describing who may know about the availability of this expertise AND acquire it.

Returns:

a ZapperMask describing access to this expertise

See Also:

MaskingLibrary

listRequirements

java.lang.String listRequirements()

Gets a ZapperMask describing who may know about the availability of this expertise.

Returns:

a ZapperMask describing who may know about the availability of this

See Also:

MaskingLibrary

finalRequirements

java.lang.String finalRequirements()

Gets a ZapperMask describing who may acquire this expertise through training.

Returns:

a ZapperMask describing who may acquire this

See Also:

MaskingLibrary

addListMask

void addListMask(java.lang.String mask)

Adds a ZapperMask describing who may know about the availability of this expertise.

Parameters:

mask - a ZapperMask describing who may know about the availability of this

See Also:

MaskingLibrary

addFinalMask

void addFinalMask(java.lang.String mask)

Adds a ZapperMask describing who may acquire this expertise through training.

Parameters:

mask - a ZapperMask describing who may acquire this

See Also:

MaskingLibrary

addCost

void addCost(CostDef.CostType type,
             java.lang.Double value)

Adds another resource cost to acquire this expertise.

Parameters:

type - the type of cost

value - the amount of the resource required

costDescription

java.lang.String costDescription()

Returns a friendly description of this expertise cost

Returns:

a friendly description of this expertise cost

meetsCostRequirements

boolean meetsCostRequirements(MOB mob)

Returns whether the given mob has enough resources to cover the costs described by this expertise.

Parameters:

mob - the mob to lose resources

Returns:

true if the mob can meet the costs

spendCostRequirements

void spendCostRequirements(MOB mob)

Subtracts the costs described by this class from the given mob

Parameters:

mob - the mob to lose resources

getFlagTypes

java.util.Set<ExpertiseLibrary.XType> getFlagTypes()

Read/Writeable list of XType flags for this expertise.

Returns:

the xtype flag set

addRawMasks

void addRawMasks(java.lang.String listMask,
                 java.lang.String finalMask)

Adds the raw, unprocessed mask strings to this object.

Parameters:

listMask - the most raw list mask

finalMask - the most raw final mask

rawListMask

java.lang.String rawListMask()

Gets the raw unprocessed list mask

Returns:

the raw unprocessed list mask

rawFinalMask

java.lang.String rawFinalMask()

Gets the raw unprocessed final mask

Returns:

the raw unprocessed final mask