Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface AbilityMapper.AbilityMapping

All Superinterfaces:

java.lang.Cloneable

Enclosing interface:

AbilityMapper

public static interface AbilityMapper.AbilityMapping
extends java.lang.Cloneable

An official Ability Mapping, used by many of the AbilityMapper classes. This class doubles as a builder of itself as well.

See Also:

AbilityMapper

Method Summary

Modifier and Type	Method	Description
java.lang.String	abilityID()	Returns the ability ID() this mapping belongs to.
AbilityMapper.AbilityMapping	abilityID(java.lang.String newValue)	Sets the ability ID() this mapping belongs to.
void	add()	Adds the final ability mapping
boolean	allQualifyFlag()	Gets whether this skill is qualified for identically by all classes, thus sharing a mapping.
AbilityMapper.AbilityMapping	allQualifyFlag(boolean newValue)	Sets whether this skill is qualified for identically by all classes, thus sharing a mapping.
boolean	autoGain()	Returns true if the skill is automatically gained, false if it must be trained.
AbilityMapper.AbilityMapping	autoGain(boolean newValue)	Sets true if the skill is automatically gained, false if it must be trained.
AbilityMapper.AbilityMapping	copyOf()	Returns a copy of this mapping.
java.lang.Integer[]	costOverrides()	Gets the array of cost overrides, indexed by the Costs enum, or null if there is no overrides of the basic costs.
AbilityMapper.AbilityMapping	costOverrides(java.lang.Integer[] newValue)	Sets the array of cost overrides, indexed by the Costs enum, or null if there is no overrides of the basic costs.
java.lang.String	defaultParm()	Returns the default argument/parameter applies to skills gained under this mapping.
AbilityMapper.AbilityMapping	defaultParm(java.lang.String newValue)	Sets the default argument/parameter applies to skills gained under this mapping.
int	defaultProficiency()	Returns the default proficiency of the skill gained under this mapping.
AbilityMapper.AbilityMapping	defaultProficiency(int newValue)	Sets the default proficiency of the skill gained under this mapping.
java.util.Map<java.lang.String,java.lang.String>	extFields()	Gets a key/value pair mappings of extraneous information to store with this ability mapping.
AbilityMapper.AbilityMapping	extFields(java.util.Map<java.lang.String,java.lang.String> newValue)	Sets a key/value pair mappings of extraneous information to store with this ability mapping.
java.lang.String	extraMask()	Gets the zapper mask to apply to players to see if they qualify to learn or gain this skill under this mapping.
AbilityMapper.AbilityMapping	extraMask(java.lang.String newValue)	Sets the zapper mask to apply to players to see if they qualify to learn or gain this skill under this mapping.
java.lang.String	ID()	Returns the class, race, or clan government ID this mapping applies to.
AbilityMapper.AbilityMapping	ID(java.lang.String newValue)	Sets the class, race, or clan government ID this mapping applies to.
boolean	isAllQualified()	Gets whether this skill is qualified for identically by all classes, thus sharing a mapping.
AbilityMapper.AbilityMapping	isAllQualified(boolean newValue)	Sets whether this skill is qualified for identically by all classes, thus sharing a mapping.
int	maxProficiency()	Returns the maximum proficiency of the skill gained under this mapping.
AbilityMapper.AbilityMapping	maxProficiency(int newValue)	Sets the maximum proficiency of the skill gained under this mapping.
java.lang.String	originalSkillPreReqList()	Gets the uncoded raw string form of the pre-requisite skills needed to train or gain this skill
AbilityMapper.AbilityMapping	originalSkillPreReqList(java.lang.String newValue)	Sets the uncoded raw string form of the pre-requisite skills needed to train or gain this skill
int	qualLevel()	Returns the class/race/clan qualifying level.
AbilityMapper.AbilityMapping	qualLevel(int newValue)	Sets the class/race/clan qualifying level.
AbilityMapper.SecretFlag	secretFlag()	Gets whether this skill is secret and unseen even when qualified for.
AbilityMapper.AbilityMapping	secretFlag(AbilityMapper.SecretFlag newValue)	Sets whether this skill is secret and unseen even when qualified for.
DVector	skillPreReqs()	Gets the coded form of the pre-requisites skills needed to train or gain this skill.
AbilityMapper.AbilityMapping	skillPreReqs(DVector newValue)	Sets the coded form of the pre-requisites skills needed to train or gain this skill.

Method Detail

ID

java.lang.String ID()

Returns the class, race, or clan government ID this mapping applies to.

Returns:

the class, race, or clan government ID

See Also:

ID(String)

ID

AbilityMapper.AbilityMapping ID(java.lang.String newValue)

Sets the class, race, or clan government ID this mapping applies to.

Parameters:

newValue - ID the class, race, or clan government ID

Returns:

this

See Also:

ID()

abilityID

java.lang.String abilityID()

Returns the ability ID() this mapping belongs to.

Returns:

the ability ID() this mapping belongs to.

See Also:

abilityID(String)

abilityID

AbilityMapper.AbilityMapping abilityID(java.lang.String newValue)

Sets the ability ID() this mapping belongs to.

Parameters:

newValue - the ability ID() this mapping belongs to.

Returns:

this

See Also:

abilityID()

qualLevel

int qualLevel()

Returns the class/race/clan qualifying level.

Returns:

the class/race/clan qualifying level.

See Also:

qualLevel(int)

qualLevel

AbilityMapper.AbilityMapping qualLevel(int newValue)

Sets the class/race/clan qualifying level.

Parameters:

newValue - the class/race/clan qualifying level.

Returns:

this

See Also:

qualLevel()

autoGain

boolean autoGain()

Returns true if the skill is automatically gained, false if it must be trained.

Returns:

true if the skill is automatically gained

See Also:

autoGain(boolean)

autoGain

AbilityMapper.AbilityMapping autoGain(boolean newValue)

Sets true if the skill is automatically gained, false if it must be trained.

Parameters:

newValue - true if the skill is automatically gained

Returns:

this

See Also:

autoGain()

defaultProficiency

int defaultProficiency()

Returns the default proficiency of the skill gained under this mapping.

Returns:

the default proficiency of the skill gained

See Also:

defaultProficiency(int)

defaultProficiency

AbilityMapper.AbilityMapping defaultProficiency(int newValue)

Sets the default proficiency of the skill gained under this mapping.

Parameters:

newValue - the default proficiency of the skill gained

Returns:

this

See Also:

defaultProficiency()

maxProficiency

int maxProficiency()

Returns the maximum proficiency of the skill gained under this mapping.

Returns:

the maximum proficiency of the skill gained

See Also:

maxProficiency(int)

maxProficiency

AbilityMapper.AbilityMapping maxProficiency(int newValue)

Sets the maximum proficiency of the skill gained under this mapping.

Parameters:

newValue - the maximum proficiency of the skill gained

Returns:

this

See Also:

maxProficiency()

defaultParm

java.lang.String defaultParm()

Returns the default argument/parameter applies to skills gained under this mapping.

Returns:

the default argument/parameter

See Also:

defaultParm(String)

defaultParm

AbilityMapper.AbilityMapping defaultParm(java.lang.String newValue)

Sets the default argument/parameter applies to skills gained under this mapping.

Parameters:

newValue - the default argument/parameter

Returns:

this

See Also:

defaultParm()

secretFlag

AbilityMapper.SecretFlag secretFlag()

Gets whether this skill is secret and unseen even when qualified for.

Returns:

whether this skill is secret and unseen

See Also:

secretFlag(SecretFlag)

secretFlag

AbilityMapper.AbilityMapping secretFlag(AbilityMapper.SecretFlag newValue)

Sets whether this skill is secret and unseen even when qualified for.

Parameters:

newValue - whether this skill is secret and unseen

Returns:

this

See Also:

secretFlag()

isAllQualified

boolean isAllQualified()

Gets whether this skill is qualified for identically by all classes, thus sharing a mapping.

Returns:

whether this skill is qualified for by all classes

See Also:

isAllQualified(boolean)

isAllQualified

AbilityMapper.AbilityMapping isAllQualified(boolean newValue)

Sets whether this skill is qualified for identically by all classes, thus sharing a mapping.

Parameters:

newValue - whether this skill is qualified for by all classes

Returns:

this

See Also:

isAllQualified()

skillPreReqs

DVector skillPreReqs()

Gets the coded form of the pre-requisites skills needed to train or gain this skill.

Returns:

the coded form of the pre-requisites skills needed

See Also:

originalSkillPreReqList(), originalSkillPreReqList(String), skillPreReqs(DVector)

skillPreReqs

AbilityMapper.AbilityMapping skillPreReqs(DVector newValue)

Sets the coded form of the pre-requisites skills needed to train or gain this skill.

Parameters:

newValue - the coded form of the pre-requisites skills needed

Returns:

this

See Also:

originalSkillPreReqList(), originalSkillPreReqList(String), skillPreReqs()

extraMask

java.lang.String extraMask()

Gets the zapper mask to apply to players to see if they qualify to learn or gain this skill under this mapping.

Returns:

the zapper mask to apply to players

See Also:

extraMask(String)

extraMask

AbilityMapper.AbilityMapping extraMask(java.lang.String newValue)

Sets the zapper mask to apply to players to see if they qualify to learn or gain this skill under this mapping.

Parameters:

newValue - the zapper mask to apply to players

Returns:

this

See Also:

extraMask()

originalSkillPreReqList

java.lang.String originalSkillPreReqList()

Gets the uncoded raw string form of the pre-requisite skills needed to train or gain this skill

Returns:

the uncoded raw string form of the pre-requisite skills

See Also:

skillPreReqs(), skillPreReqs(DVector), originalSkillPreReqList(String)

originalSkillPreReqList

AbilityMapper.AbilityMapping originalSkillPreReqList(java.lang.String newValue)

Sets the uncoded raw string form of the pre-requisite skills needed to train or gain this skill

Parameters:

newValue - the uncoded raw string form of the pre-requisite skills

Returns:

this

See Also:

skillPreReqs(), skillPreReqs(DVector), originalSkillPreReqList()

costOverrides

java.lang.Integer[] costOverrides()

Gets the array of cost overrides, indexed by the Costs enum, or null if there is no overrides of the basic costs.

Returns:

the array of cost overrides, or null

See Also:

AbilityMapper.AbilCostType, costOverrides(Integer[])

costOverrides

AbilityMapper.AbilityMapping costOverrides(java.lang.Integer[] newValue)

Sets the array of cost overrides, indexed by the Costs enum, or null if there is no overrides of the basic costs.

Parameters:

newValue - the array of cost overrides, or null

Returns:

this

See Also:

AbilityMapper.AbilCostType, costOverrides()

allQualifyFlag

boolean allQualifyFlag()

Gets whether this skill is qualified for identically by all classes, thus sharing a mapping. This is true when from the AllQualifies list file, and false when from a class or coded definition.

Returns:

whether this skill is qualified for by all classes

See Also:

allQualifyFlag(boolean)

allQualifyFlag

AbilityMapper.AbilityMapping allQualifyFlag(boolean newValue)

Sets whether this skill is qualified for identically by all classes, thus sharing a mapping. This is true when from the AllQualifies list file, and false when from a class or coded definition.

Parameters:

newValue - whether this skill is qualified for by all classes

Returns:

this

See Also:

allQualifyFlag()

extFields

java.util.Map<java.lang.String,java.lang.String> extFields()

Gets a key/value pair mappings of extraneous information to store with this ability mapping.

Returns:

a key/value pair mappings of extraneous information

See Also:

extFields(Map)

extFields

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

Sets a key/value pair mappings of extraneous information to store with this ability mapping.

Parameters:

newValue - a key/value pair mappings of extraneous information

Returns:

this

See Also:

extFields()

copyOf

AbilityMapper.AbilityMapping copyOf()

Returns a copy of this mapping. It's a deep copy.

Returns:

a copy of this mapping. It's a deep copy.

add

void add()

Adds the final ability mapping