StdCharClass

java.lang.Object
- com.planet_ink.coffee_mud.CharClasses.StdCharClass

All Implemented Interfaces:

CharClass, CMObject, Modifiable, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

Apprentice, Archon, Artisan, Barbarian, Bard, Beastmaster, Cavalier, Charlatan, Cleric, Delver, Druid, Fighter, Gaian, Gaoler, GenCharClass, Jester, Mage, Mer, Minstrel, Monk, Paladin, PlayerClass, Prancer, Qualifier, Ranger, Sailor, Scholar, SkyWatcher, Thief
```
public class StdCharClass
extends java.lang.Object
implements CharClass
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.CharClasses.interfaces.CharClass
  CharClass.SubClassRule

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`cachedRaceQualList`
`protected static java.lang.String[]`	`CODES`
`protected java.util.Map<Race,java.lang.Boolean>`	`finalAllowedRaceSet`
`protected static java.lang.String[][]`	`hitPointDescReplacePairs`
`java.lang.String`	`hitPointsDesc`
`protected long`	`lastPropsCheckTime`
`java.lang.String`	`manaDesc`
`protected java.lang.String[][]`	`manaDescReplacePairs`
`protected int[]`	`maxStatAdj`
`java.lang.String`	`movementDesc`
`protected static java.lang.String[][]`	`movementDescReplacePairs`
`protected java.lang.String[]`	`names`
`protected java.util.List<Item>`	`outfitChoices`
`protected long`	`previousRaceListHash`

Fields inherited from interface com.planet_ink.coffee_mud.CharClasses.interfaces.CharClass
ARMOR_ANY, ARMOR_CLOTH, ARMOR_DESCS, ARMOR_LEATHER, ARMOR_LONGDESC, ARMOR_METALONLY, ARMOR_NONMETAL, ARMOR_OREONLY, ARMOR_VEGAN, ARMOR_WEARMASK, GENFLAG_DESCS, GENFLAG_NOEXP, GENFLAG_NOLEVELS, GENFLAG_NORACE, GENFLAG_THINQUALLIST, WEAPONS_ALLCLERIC, WEAPONS_ANY, WEAPONS_BURGLAR, WEAPONS_DAGGERONLY, WEAPONS_EVILCLERIC, WEAPONS_FLAILONLY, WEAPONS_GOODCLERIC, WEAPONS_LONGDESC, WEAPONS_MAGELIKE, WEAPONS_MERLIKE, WEAPONS_NATURAL, WEAPONS_NEUTRALCLERIC, WEAPONS_ROCKY, WEAPONS_SETS, WEAPONS_STAFFONLY, WEAPONS_THIEFLIKE

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors
Constructor Description

StdCharClass()

Constructors
Constructor	Description
`StdCharClass()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`addedExpertise(MOB host, ExpertiseLibrary.XType expertiseCode, java.lang.String abilityID)`	Whenever a uses a skill, this method can return any additional expertise granted explicitly by the class.
`int`	`adjustExperienceGain(MOB host, MOB mob, MOB victim, int amount)`	Whenever a player or mob of this race gains experience, this method gets a chance to modify the amount before the gain actually occurs.
`void`	`affectCharState(MOB affectedMob, CharState affectableMaxState)`	This method is called by the recoverCharState() method on other MOB objects.
`void`	`affectCharStats(MOB affectedMob, CharStats affectableStats)`	This method is called by the recoverCharStats() method on other MOB objects.
`void`	`affectPhyStats(Physical affected, PhyStats affectableStats)`	This method is called by the recoverPhyStats() method on other Environmental objects.
`int`	`allowedArmorLevel()`	A code designating what kind of armor can be used by this class without affecting their skills.
`protected boolean`	`allowedToAutoGain(MOB mob, Ability A)`
`int`	`allowedWeaponLevel()`	A code designating what kind of weapons can be used by this class without fumbling their usage.
`protected boolean`	`armorCheck(MOB mob, int sourceCode, Environmental E)`
`protected java.lang.String`	`armorFailMessage()`
`int`	`availabilityCode()`	Returns one or a combination of the Area.THEME_* constants from the Area interface.
`java.lang.String`	`baseClass()`	Returns the base-class of this class.
`protected java.util.Set<java.lang.Integer>`	`buildDisallowedWeaponClasses()`
`protected java.util.Set<java.lang.Integer>`	`buildDisallowedWeaponClasses(int lvl)`
`protected java.util.HashSet<java.lang.Integer>`	`buildRequiredWeaponMaterials()`
`boolean`	`canBeABenificiary(MOB killer, MOB killed, MOB mob, java.util.Set<MOB> followers)`	Returns whether this class, for the given mob of this class, should share in the experience gained by the killer for having killed the killed.
`boolean`	`canBeADivider(MOB killer, MOB killed, MOB mob, java.util.Set<MOB> followers)`	Returns whether this class, for the given mob of this class, should count in the division of experience gained by the killer for having killed the killed.
`protected void`	`checkRaceQualifierChanges()`
`int`	`classDurationModifier(MOB myChar, Ability skill, int duration)`	This method is called whenever a player casts a spell which has a lasting effect on the target.
`int`	`classLevelModifier(MOB myChar, Ability skill, int level)`	This method is called whenever a player casts a spell which has an affect that is level dependent.
`java.lang.String`	`classParms()`	Returns any boot-time parameters that are required to fully define this instance of a charclass.
`protected void`	`cleanOutfit(java.util.List<Item> items)`
`void`	`cloneFix(CharClass C)`
`int`	`compareTo(CMObject o)`
`CMObject`	`copyOf()`	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
`protected java.util.Set<java.lang.Integer>`	`disallowedWeaponClasses(MOB mob)`
`void`	`endCharacter(MOB mob)`	Called when a class is no longer the current dominant class of a player or mob, usually during class training.
`void`	`executeMsg(Environmental myHost, CMMsg msg)`	The general message event handler for the object.
`boolean`	`expless()`	Whether players of this class can gain or lose experience points.
`java.lang.String`	`getArmorLimitDesc()`	Returns a text description of any armor restrictions imposed by this class upon its members.
`int`	`getAttackAttribute()`	Returns which of the CharStats.STAT_* constants should be used to calculate the standard attack prowess points given when a member of this class gains a level.
`java.lang.String`	`getAttackDesc()`	Returns a text description of the attack bonuses gained by members of this class.
`int`	`getBonusAttackLevel()`	Returns the number of bonus attack points received by members of this class when they gain a level.
`int`	`getBonusPracLevel()`	Returns the number of bonus practices received by members of this class when they gain a level.
`protected int`	`getCodeNum(java.lang.String code)`
`java.lang.String`	`getDamageDesc()`	Returns a text description of the damage bonuses gained by members of this class.
`java.lang.String`	`getHitPointDesc()`	Returns a text description of the hit point bonuses gained by members of this class.
`java.lang.String`	`getHitPointsFormula()`	Returns the formula used every time a player of this class gains a level as this class.
`int`	`getLevelCap()`	Returns the highest class level that can be achieved by a player who has this class.
`int`	`getLevelsPerBonusDamage()`	Returns the number of levels which must be gained by a member of this class before they gain 1 more point of default damage per hit.
`java.lang.String`	`getManaDesc()`	Returns a text description of the mana bonuses gained by members of this class.
`java.lang.String`	`getManaFormula()`	Returns the formula used every time a player of this class gains a level as this class.
`java.lang.String`	`getMaxStatDesc()`	Returns the list of max stats for members of this class.
`Pair<java.lang.String,java.lang.Integer>[]`	`getMinimumStatRequirements()`	Returns pairings of stat names and the minimum a player must have in the state in order to learn this class.
`java.lang.String`	`getMovementDesc()`	Returns a text description of the movement bonuses gained by members of this class.
`java.lang.String`	`getMovementFormula()`	Returns the formula used every time a player of this class gains a level as this class.
`java.lang.String`	`getOtherBonusDesc()`	Returns a text description of any bonus properties granted by this class to its members.
`java.lang.String`	`getOtherLimitsDesc()`	Returns a text description of any misc restrictions imposed by this class upon its members.
`int`	`getPracsFirstLevel()`	Returns the number of practices received by members of this class when they are first created.
`java.lang.String`	`getPracticeDesc()`	Returns a text description of the practice bonuses gained by members of this class.
`java.lang.String`	`getPrimeStatDesc()`	Returns the prime statistic of this class
`java.lang.String`	`getRaceQualDesc()`	Returns a text description of the race requirements required to become a member of this character class
`java.lang.String[]`	`getRequiredRaceList()`	Returns an array of Strings containing either the names of particular races, racial categories, or the word "ANY" to mean any class is OK.
`int`	`getSaveStatIndex()`	Returns the index into the stat codes array where extra savable fields begins.
`CMSecurity.SecGroup`	`getSecurityFlags(int classLevel)`	Returns a read only set of security flags granted to all mobs/players who are this class, and the given class level or lower.
`protected java.lang.String`	`getShortAttackAttribute()`
`java.lang.String`	`getStartingMoney()`	Returns a text string for amount of money for characters starting as this character.
`java.lang.String`	`getStat(java.lang.String code)`	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
`java.lang.String[]`	`getStatCodes()`	Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
`java.lang.String`	`getStatQualDesc()`	Returns a text description of the stat qualifications required to become a member of this character class
`CharClass.SubClassRule`	`getSubClassRule()`	This defines how this class fits into the SUB subclassing class system.
`int`	`getTickStatus()`	A coded status for this object during the period where its tick method is being called.
`java.lang.String`	`getTrainDesc()`	Returns a text description of the train bonuses gained by members of this class.
`int`	`getTrainsFirstLevel()`	Returns the number of training sessions received by members of this class when they are first created.
`java.lang.String`	`getWeaponLimitDesc()`	Returns a text description of any weapon restrictions imposed by this class upon its members.
`protected boolean`	`giveMobAbility(MOB mob, Ability A, int proficiency, java.lang.String defaultParm, boolean isBorrowedClass)`
`protected boolean`	`giveMobAbility(MOB mob, Ability A, int proficiency, java.lang.String defaultParm, boolean isBorrowedClass, boolean autoInvoke)`
`void`	`grantAbilities(MOB mob, boolean isBorrowedClass)`	Typically called when a mob gains a level in this class, to allow the class to assign any new skills.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`void`	`initializeClass()`	Called ONCE after all objects are loaded, but before the map is read in during initialization.
`boolean`	`isAllowedRace(Race R)`	Returns whether the given race matches the required race list rules.
`boolean`	`isGeneric()`	Returns whether this class is fully defined using the setParms method, as opposed to being defined by its Java code.
`protected boolean`	`isQualifyingAuthority(MOB mob, Ability A)`
`boolean`	`isStat(java.lang.String code)`	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
`boolean`	`isValidClassBeneficiary(MOB killer, MOB killed, MOB mob, java.util.Set<MOB> followers)`	Returns whether the given mob should share in the experience gained by the killer for having killed the killed.
`boolean`	`isValidClassDivider(MOB killer, MOB killed, MOB mob, java.util.Set<MOB> followers)`	Returns whether the given mob should count in the division of experience gained by the killer for having killed the killed.
`java.lang.String`	`L(java.lang.String str, java.lang.String... xs)`	Localize an internal string -- shortcut.
`void`	`level(MOB mob, java.util.List<java.lang.String> gainedAbilityIDs)`	This method is called whenever a player gains a level while a member of this class.
`boolean`	`leveless()`	Whether players of this class can be associated with an experience level.
`CharClass`	`makeGenCharClass()`	Converts this class into a generic one, if it is not already.
`int`	`maxCommonSkills()`	Max number of common skills (both crafting and non-crafting) this class can learn.
`int`	`maxCraftingSkills()`	Max number of common crafting skills this class can learn.
`int`	`maxLanguages()`	Max number of languages this class can learn.
`int`	`maxNonCraftingSkills()`	Max number of common gathering/non-crafting skills this class can learn.
`int[]`	`maxStatAdjustments()`	Returns a bonus or negative adjustments to the base maximum for the CharStats.STAT_* base statistics.
`java.lang.String`	`name()`	Returns the generally displayable name of this class.
`java.lang.String`	`name(int classLevel)`	Returns the displayable name of this class, when the mob is the given class level.
`java.lang.String[]`	`nameSet()`	Returns all of the displayable names of this class.
`CMObject`	`newInstance()`	Returns a new instance of this class.
`boolean`	`okMessage(Environmental myHost, CMMsg msg)`	The general message event previewer for the object.
`java.util.List<Item>`	`outfit(MOB myChar)`	Returns a vector of Item objects representing the standard clothing, weapons, or other objects commonly given to players of this class just starting out.
`boolean`	`qualifiesForThisClass(MOB mob, boolean quiet)`	Returns whether this given mob qualifies for this class, and optionally gives them an error message.
`boolean`	`raceless()`	Whether this class can be associated with a race.
`protected int`	`requiredArmorSourceMinor()`
`protected java.util.Set<java.lang.Integer>`	`requiredWeaponMaterials()`
`boolean`	`sameAs(CharClass E)`
`void`	`setClassParms(java.lang.String parms)`	Sets any boot-time parameters that are required to fully define this instance of a charclass.
`void`	`setStat(java.lang.String code, java.lang.String val)`	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
`boolean`	`showThinQualifyList()`	Whether players of this class see qualifying skills only if they meet all prereqs.
`void`	`startCharacter(MOB mob, boolean isBorrowedClass, boolean verifyOnly)`	This method should be called whenever a mob has this class added to their charStats list.
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`void`	`unLevel(MOB mob)`	This method is called whenever a player loses a level while a member of this class.
`protected boolean`	`weaponCheck(MOB mob, int sourceCode, Environmental E)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - movementDesc
```
public java.lang.String movementDesc
```
  - hitPointsDesc
```
public java.lang.String hitPointsDesc
```
  - manaDesc
```
public java.lang.String manaDesc
```
  - names
```
protected java.lang.String[] names
```
  - maxStatAdj
```
protected int[] maxStatAdj
```
  - outfitChoices
```
protected java.util.List<Item> outfitChoices
```
  - lastPropsCheckTime
```
protected long lastPropsCheckTime
```
  - previousRaceListHash
```
protected long previousRaceListHash
```
  - cachedRaceQualList
```
protected java.lang.String cachedRaceQualList
```
  - finalAllowedRaceSet
```
protected java.util.Map<Race,java.lang.Boolean> finalAllowedRaceSet
```
  - hitPointDescReplacePairs
```
protected static final java.lang.String[][] hitPointDescReplacePairs
```
  - manaDescReplacePairs
```
protected final java.lang.String[][] manaDescReplacePairs
```
  - movementDescReplacePairs
```
protected static final java.lang.String[][] movementDescReplacePairs
```
  - CODES
```
protected static java.lang.String[] CODES
```
- Constructor Detail
  - StdCharClass
```
public StdCharClass()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Returns:
    
    the name of this class
  - name
```
public java.lang.String name()
```
    Description copied from interface: CharClass
    
    Returns the generally displayable name of this class. Usually deferred to by name(int), which is more often called.
    
    Specified by:
    
    name in interface CharClass
    
    Specified by:
    
    name in interface CMObject
    
    Specified by:
    
    name in interface Tickable
    
    Returns:
    
    the displayable name of this object instance
    
    See Also:
    
    CharClass.name(int), CharClass.nameSet()
  - name
```
public java.lang.String name(int classLevel)
```
    Description copied from interface: CharClass
    
    Returns the displayable name of this class, when the mob is the given class level. Usually defers to name()
    
    Specified by:
    
    name in interface CharClass
    
    Parameters:
    
    classLevel - the level to look up a name for
    
    Returns:
    
    the displayable name of this class
    
    See Also:
    
    CharClass.name(), CharClass.nameSet()
  - baseClass
```
public java.lang.String baseClass()
```
    Description copied from interface: CharClass
    
    Returns the base-class of this class. Typically only important in multi-classing systems that restrict class changing to those classes part of the same base class. True multi-classing systems don't need to worry about this value. Can be the same as the ID() method.
    
    Specified by:
    
    baseClass in interface CharClass
    
    Returns:
    
    the base-class of this class
  - getLevelCap
```
public int getLevelCap()
```
    Description copied from interface: CharClass
    
    Returns the highest class level that can be achieved by a player who has this class. Once this level is reached, the class behaves as it is were levelless. Default is -1, meaning the cap does not exist.
    
    Specified by:
    
    getLevelCap in interface CharClass
    
    Returns:
    
    highest class level for this class;
  - getBonusPracLevel
```
public int getBonusPracLevel()
```
    Description copied from interface: CharClass
    
    Returns the number of bonus practices received by members of this class when they gain a level. This is over and above the normal formula applied during the leveling process.
    
    Specified by:
    
    getBonusPracLevel in interface CharClass
    
    Returns:
    
    the number of bonus practices to grant
  - getBonusAttackLevel
```
public int getBonusAttackLevel()
```
    Description copied from interface: CharClass
    
    Returns the number of bonus attack points received by members of this class when they gain a level. This is over and above the normal formula applied during the leveling process.
    
    Specified by:
    
    getBonusAttackLevel in interface CharClass
    
    Returns:
    
    the number of bonus attack points to grant
  - getAttackAttribute
```
public int getAttackAttribute()
```
    Description copied from interface: CharClass
    
    Returns which of the CharStats.STAT_* constants should be used to calculate the standard attack prowess points given when a member of this class gains a level.
    
    Specified by:
    
    getAttackAttribute in interface CharClass
    
    Returns:
    
    a CharStats.STAT_* attribute constant code
    
    See Also:
    
    CharStats
  - getPracsFirstLevel
```
public int getPracsFirstLevel()
```
    Description copied from interface: CharClass
    
    Returns the number of practices received by members of this class when they are first created.
    
    Specified by:
    
    getPracsFirstLevel in interface CharClass
    
    Returns:
    
    the number of initial practices to grant
  - getTrainsFirstLevel
```
public int getTrainsFirstLevel()
```
    Description copied from interface: CharClass
    
    Returns the number of training sessions received by members of this class when they are first created.
    
    Specified by:
    
    getTrainsFirstLevel in interface CharClass
    
    Returns:
    
    the number of initial trains to grant
  - getLevelsPerBonusDamage
```
public int getLevelsPerBonusDamage()
```
    Description copied from interface: CharClass
    
    Returns the number of levels which must be gained by a member of this class before they gain 1 more point of default damage per hit.
    
    Specified by:
    
    getLevelsPerBonusDamage in interface CharClass
    
    Returns:
    
    the number of levels between damage gains
  - getMovementFormula
```
public java.lang.String getMovementFormula()
```
    Description copied from interface: CharClass
    
    Returns the formula used every time a player of this class gains a level as this class. The total is added (or removed on unlevel) from the players movement score. Variables may be included in the formula, which are: @x1: Players current class level @x2: Players adjusted Strength @x3: Players Max adjusted Strength @x4: Players adjusted Dexterity @x5: Players Max adjusted Dexterity @x6: Players adjusted Constitution @x7: Players Max adjusted Constitution @x8: Players adjusted Wisdom @x9: Players adjusted Intelligence
    
    Specified by:
    
    getMovementFormula in interface CharClass
    
    Returns:
    
    the formula that causes a gain or loss in movement
    
    See Also:
    
    CharClass.getMovementDesc()
  - getHitPointsFormula
```
public java.lang.String getHitPointsFormula()
```
    Description copied from interface: CharClass
    
    Returns the formula used every time a player of this class gains a level as this class. The total is added (or removed on unlevel) from the players hit points score. Variables may be included in the formula, which are: \@x1: Players current class level \@x2: Players adjusted Strength @x3: Players Max adjusted Strength \@x4: Players adjusted Dexterity @x5: Players Max adjusted Dexterity @x6: Players adjusted Constitution @x7: Players Max adjusted Constitution @x8: Players adjusted Wisdom @x9: Players adjusted Intelligence
    
    Specified by:
    
    getHitPointsFormula in interface CharClass
    
    Returns:
    
    the formula that causes a gain or loss in hit points
    
    See Also:
    
    CharClass.getHitPointDesc()
  - getManaFormula
```
public java.lang.String getManaFormula()
```
    Description copied from interface: CharClass
    
    Returns the formula used every time a player of this class gains a level as this class. The total is added (or removed on unlevel) from the players mana score. Variables may be included in the formula, which are: @x1: Players current class level @x2: Players adjusted Wisdom @x3: Players Max adjusted Wisdom @x4: Players adjusted Intelligence @x5: Players Max adjusted Intelligence @x6: Players adjusted Attack Attr @x7: Players Max adjusted Attack Attr @x8: Players adjusted Charisma @x9: Players adjusted Constitution
    
    Specified by:
    
    getManaFormula in interface CharClass
    
    Returns:
    
    the formula that causes a gain or loss in mana
    
    See Also:
    
    CharClass.getManaDesc(), CharClass.getAttackAttribute()
  - allowedArmorLevel
```
public int allowedArmorLevel()
```
    Description copied from interface: CharClass
    
    A code designating what kind of armor can be used by this class without affecting their skills. The worn locations this coded type refers to locations defined by ARMOR_WEARMASK
    
    Specified by:
    
    allowedArmorLevel in interface CharClass
    
    Returns:
    
    the encoded allowed armor type
    
    See Also:
    
    CharClass.ARMOR_WEARMASK, CharClass.ARMOR_ANY
  - allowedWeaponLevel
```
public int allowedWeaponLevel()
```
    Description copied from interface: CharClass
    
    A code designating what kind of weapons can be used by this class without fumbling their usage.
    
    Specified by:
    
    allowedWeaponLevel in interface CharClass
    
    Returns:
    
    the encoded allowed weapon type
    
    See Also:
    
    CharClass.WEAPONS_ANY
  - disallowedWeaponClasses
```
protected java.util.Set<java.lang.Integer> disallowedWeaponClasses(MOB mob)
```
  - requiredWeaponMaterials
```
protected java.util.Set<java.lang.Integer> requiredWeaponMaterials()
```
  - requiredArmorSourceMinor
```
protected int requiredArmorSourceMinor()
```
  - armorFailMessage
```
protected java.lang.String armorFailMessage()
```
  - raceless
```
public boolean raceless()
```
    Description copied from interface: CharClass
    
    Whether this class can be associated with a race.
    
    Specified by:
    
    raceless in interface CharClass
    
    Returns:
    
    whether this class can have a class
    
    See Also:
    
    Race
  - leveless
```
public boolean leveless()
```
    Description copied from interface: CharClass
    
    Whether players of this class can be associated with an experience level.
    
    Specified by:
    
    leveless in interface CharClass
    
    Returns:
    
    whether players of this class can have a level
  - expless
```
public boolean expless()
```
    Description copied from interface: CharClass
    
    Whether players of this class can gain or lose experience points.
    
    Specified by:
    
    expless in interface CharClass
    
    Returns:
    
    whether players of this class can gain or lose experience points
  - getSubClassRule
```
public CharClass.SubClassRule getSubClassRule()
```
    Description copied from interface: CharClass
    
    This defines how this class fits into the SUB subclassing class system. A class may be one that can change to any class, or only another class if it is the same base class, or many no class at all.
    
    Specified by:
    
    getSubClassRule in interface CharClass
    
    Returns:
    
    the rule to use in the subclassing system
  - showThinQualifyList
```
public boolean showThinQualifyList()
```
    Description copied from interface: CharClass
    
    Whether players of this class see qualifying skills only if they meet all prereqs.
    
    Specified by:
    
    showThinQualifyList in interface CharClass
    
    Returns:
    
    whether players of this class see qualifying skills only if they meet all prereqs
  - maxNonCraftingSkills
```
public int maxNonCraftingSkills()
```
    Description copied from interface: CharClass
    
    Max number of common gathering/non-crafting skills this class can learn. 0 means unlimited. Skills directly qualified for by the class are excepted.
    
    Specified by:
    
    maxNonCraftingSkills in interface CharClass
    
    Returns:
    
    Max number of common gathering/non-crafting skills this class can learn.
  - maxCraftingSkills
```
public int maxCraftingSkills()
```
    Description copied from interface: CharClass
    
    Max number of common crafting skills this class can learn. 0 means unlimited. Skills directly qualified for by the class are excepted.
    
    Specified by:
    
    maxCraftingSkills in interface CharClass
    
    Returns:
    
    Max number of common crafting skills this class can learn.
  - maxCommonSkills
```
public int maxCommonSkills()
```
    Description copied from interface: CharClass
    
    Max number of common skills (both crafting and non-crafting) this class can learn. 0 means unlimited. Skills directly qualified for by the class are excepted.
    
    Specified by:
    
    maxCommonSkills in interface CharClass
    
    Returns:
    
    Max number of common skills this class can learn.
  - maxLanguages
```
public int maxLanguages()
```
    Description copied from interface: CharClass
    
    Max number of languages this class can learn. 0 means unlimited. Languages directly qualified for by the class or race are excepted.
    
    Specified by:
    
    maxLanguages in interface CharClass
    
    Returns:
    
    Max number of languages this class can learn.
  - getSecurityFlags
```
public CMSecurity.SecGroup getSecurityFlags(int classLevel)
```
    Description copied from interface: CharClass
    
    Returns a read only set of security flags granted to all mobs/players who are this class, and the given class level or lower.
    
    Specified by:
    
    getSecurityFlags in interface CharClass
    
    Parameters:
    
    classLevel - the class level of the mob
    
    Returns:
    
    a vector of security flags
  - getRequiredRaceList
```
public java.lang.String[] getRequiredRaceList()
```
    Description copied from interface: CharClass
    
    Returns an array of Strings containing either the names of particular races, racial categories, or the word "ANY" to mean any class is OK. All others are not permitted to be this class.
    
    Specified by:
    
    getRequiredRaceList in interface CharClass
    
    Returns:
    
    a list of races, racecats, or ANY
    
    See Also:
    
    CharClass.isAllowedRace(Race)
  - getMinimumStatRequirements
```
public Pair<java.lang.String,java.lang.Integer>[] getMinimumStatRequirements()
```
    Description copied from interface: CharClass
    
    Returns pairings of stat names and the minimum a player must have in the state in order to learn this class.
    
    Specified by:
    
    getMinimumStatRequirements in interface CharClass
    
    Returns:
    
    a pairs of stat names and minimum
  - newInstance
```
public CMObject newInstance()
```
    Description copied from interface: CMObject
    
    Returns a new instance of this class.
    
    Specified by:
    
    newInstance in interface CMObject
    
    Returns:
    
    a new instance of this class
  - getStartingMoney
```
public java.lang.String getStartingMoney()
```
    Description copied from interface: CharClass
    
    Returns a text string for amount of money for characters starting as this character. Can be a number, or something like "485 gold".
    
    Specified by:
    
    getStartingMoney in interface CharClass
    
    Returns:
    
    a text string for starting money.
  - getShortAttackAttribute
```
protected java.lang.String getShortAttackAttribute()
```
  - nameSet
```
public java.lang.String[] nameSet()
```
    Description copied from interface: CharClass
    
    Returns all of the displayable names of this class. Usually defers to name()
    
    Specified by:
    
    nameSet in interface CharClass
    
    Returns:
    
    all of the displayable names of this class
    
    See Also:
    
    CharClass.name(), CharClass.name(int)
  - initializeClass
```
public void initializeClass()
```
    Description copied from interface: CMObject
    
    Called ONCE after all objects are loaded, but before the map is read in during initialization.
    
    Specified by:
    
    initializeClass in interface CMObject
  - isGeneric
```
public boolean isGeneric()
```
    Description copied from interface: CharClass
    
    Returns whether this class is fully defined using the setParms method, as opposed to being defined by its Java code.
    
    Specified by:
    
    isGeneric in interface CharClass
    
    Returns:
    
    whether this class is defined fully by parameters
    
    See Also:
    
    CharClass.classParms(), CharClass.makeGenCharClass(), CharClass.setClassParms(String)
  - availabilityCode
```
public int availabilityCode()
```
    Description copied from interface: CharClass
    
    Returns one or a combination of the Area.THEME_* constants from the Area interface. This bitmap then describes the types of areas, skills, and classes which can interact. This bitmap is also used to to tell whether the class is available for selection by users at char creation time, whether they can change to this class via spells, or whether the class is utterly unavailable to them.
    
    Specified by:
    
    availabilityCode in interface CharClass
    
    Returns:
    
    the availability/theme of this class
    
    See Also:
    
    Area
  - cloneFix
```
public void cloneFix(CharClass C)
```
  - copyOf
```
public CMObject copyOf()
```
    Description copied from interface: CMObject
    
    Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
    
    Specified by:
    
    copyOf in interface CMObject
    
    Returns:
    
    a clone of this object
  - classDurationModifier
```
public int classDurationModifier(MOB myChar,
                                 Ability skill,
                                 int duration)
```
    Description copied from interface: CharClass
    
    This method is called whenever a player casts a spell which has a lasting effect on the target. This method is called even if the class is not the players CURRENT class.
    
    Specified by:
    
    classDurationModifier in interface CharClass
    
    Parameters:
    
    myChar - the caster or skill user
    
    skill - the skill or spell that was cast.
    
    duration - the default duration
    
    Returns:
    
    usually, it just returns default again
  - classLevelModifier
```
public int classLevelModifier(MOB myChar,
                              Ability skill,
                              int level)
```
    Description copied from interface: CharClass
    
    This method is called whenever a player casts a spell which has an affect that is level dependent. This method is called even if the class is not the players CURRENT class.
    
    Specified by:
    
    classLevelModifier in interface CharClass
    
    Parameters:
    
    myChar - the caster or skill user
    
    skill - the skill or spell that was cast.
    
    level - the default level
    
    Returns:
    
    usually, it just returns level again
  - getTickStatus
```
public int getTickStatus()
```
    Description copied from interface: Tickable
    
    A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.
    
    Specified by:
    
    getTickStatus in interface Tickable
    
    Returns:
    
    the numeric status of this object
    
    See Also:
    
    Tickable.tick(Tickable, int)
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - qualifiesForThisClass
```
public boolean qualifiesForThisClass(MOB mob,
                                     boolean quiet)
```
    Description copied from interface: CharClass
    
    Returns whether this given mob qualifies for this class, and optionally gives them an error message. There are strange rules here. If the mob is null, then this method returns true unless subclassing is on, and this class is not a subclass. If the mob has a class of StdCharClass, then char creation rules apply, otherwise train rules apply.
    
    Specified by:
    
    qualifiesForThisClass in interface CharClass
    
    Parameters:
    
    mob - the mob to evaluate the worthiness of
    
    quiet - false to give the mob error messages, true for silence
    
    Returns:
    
    whether the given mob is worthy of this class
  - getWeaponLimitDesc
```
public java.lang.String getWeaponLimitDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of any weapon restrictions imposed by this class upon its members.
    
    Specified by:
    
    getWeaponLimitDesc in interface CharClass
    
    Returns:
    
    a text description of weapon retrictions
  - getArmorLimitDesc
```
public java.lang.String getArmorLimitDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of any armor restrictions imposed by this class upon its members.
    
    Specified by:
    
    getArmorLimitDesc in interface CharClass
    
    Returns:
    
    a text description of armor retrictions
  - getOtherLimitsDesc
```
public java.lang.String getOtherLimitsDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of any misc restrictions imposed by this class upon its members.
    
    Specified by:
    
    getOtherLimitsDesc in interface CharClass
    
    Returns:
    
    a text description of misc retrictions
  - getOtherBonusDesc
```
public java.lang.String getOtherBonusDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of any bonus properties granted by this class to its members.
    
    Specified by:
    
    getOtherBonusDesc in interface CharClass
    
    Returns:
    
    a text description of bonus properties
  - getStatQualDesc
```
public java.lang.String getStatQualDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the stat qualifications required to become a member of this character class
    
    Specified by:
    
    getStatQualDesc in interface CharClass
    
    Returns:
    
    a txt description of stat qualifications
  - getRaceQualDesc
```
public java.lang.String getRaceQualDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the race requirements required to become a member of this character class
    
    Specified by:
    
    getRaceQualDesc in interface CharClass
    
    Returns:
    
    a txt description of race requirements
  - getMaxStatDesc
```
public java.lang.String getMaxStatDesc()
```
    Description copied from interface: CharClass
    
    Returns the list of max stats for members of this class.
    
    Specified by:
    
    getMaxStatDesc in interface CharClass
    
    Returns:
    
    the max stat values for this class.
  - getPracticeDesc
```
public java.lang.String getPracticeDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the practice bonuses gained by members of this class.
    
    Specified by:
    
    getPracticeDesc in interface CharClass
    
    Returns:
    
    a text description of the practice bonuses
  - getTrainDesc
```
public java.lang.String getTrainDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the train bonuses gained by members of this class.
    
    Specified by:
    
    getTrainDesc in interface CharClass
    
    Returns:
    
    a text description of the train bonuses
  - getDamageDesc
```
public java.lang.String getDamageDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the damage bonuses gained by members of this class.
    
    Specified by:
    
    getDamageDesc in interface CharClass
    
    Returns:
    
    a text description of the damage bonuses
  - getHitPointDesc
```
public java.lang.String getHitPointDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the hit point bonuses gained by members of this class.
    
    Specified by:
    
    getHitPointDesc in interface CharClass
    
    Returns:
    
    a text description of the hit point bonuses
    
    See Also:
    
    CharClass.getHitPointsFormula()
  - getManaDesc
```
public java.lang.String getManaDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the mana bonuses gained by members of this class.
    
    Specified by:
    
    getManaDesc in interface CharClass
    
    Returns:
    
    a text description of the mana bonuses
    
    See Also:
    
    CharClass.getManaFormula()
  - getMovementDesc
```
public java.lang.String getMovementDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the movement bonuses gained by members of this class.
    
    Specified by:
    
    getMovementDesc in interface CharClass
    
    Returns:
    
    a text description of the movement bonuses
    
    See Also:
    
    CharClass.getMovementFormula()
  - getPrimeStatDesc
```
public java.lang.String getPrimeStatDesc()
```
    Description copied from interface: CharClass
    
    Returns the prime statistic of this class
    
    Specified by:
    
    getPrimeStatDesc in interface CharClass
    
    Returns:
    
    the prime statistic of this class
  - getAttackDesc
```
public java.lang.String getAttackDesc()
```
    Description copied from interface: CharClass
    
    Returns a text description of the attack bonuses gained by members of this class.
    
    Specified by:
    
    getAttackDesc in interface CharClass
    
    Returns:
    
    a text description of the attack bonuses
  - cleanOutfit
```
protected void cleanOutfit(java.util.List<Item> items)
```
  - buildDisallowedWeaponClasses
```
protected java.util.Set<java.lang.Integer> buildDisallowedWeaponClasses()
```
  - buildDisallowedWeaponClasses
```
protected java.util.Set<java.lang.Integer> buildDisallowedWeaponClasses(int lvl)
```
  - buildRequiredWeaponMaterials
```
protected java.util.HashSet<java.lang.Integer> buildRequiredWeaponMaterials()
```
  - isQualifyingAuthority
```
protected boolean isQualifyingAuthority(MOB mob,
                                        Ability A)
```
  - armorCheck
```
protected boolean armorCheck(MOB mob,
                             int sourceCode,
                             Environmental E)
```
  - weaponCheck
```
protected boolean weaponCheck(MOB mob,
                              int sourceCode,
                              Environmental E)
```
  - giveMobAbility
```
protected boolean giveMobAbility(MOB mob,
                                 Ability A,
                                 int proficiency,
                                 java.lang.String defaultParm,
                                 boolean isBorrowedClass)
```
  - giveMobAbility
```
protected boolean giveMobAbility(MOB mob,
                                 Ability A,
                                 int proficiency,
                                 java.lang.String defaultParm,
                                 boolean isBorrowedClass,
                                 boolean autoInvoke)
```
  - maxStatAdjustments
```
public int[] maxStatAdjustments()
```
    Description copied from interface: CharClass
    
    Returns a bonus or negative adjustments to the base maximum for the CharStats.STAT_* base statistics. The maximum is the most a player can train up to. The array only holds enough to the first 6 base stats.
    
    Specified by:
    
    maxStatAdjustments in interface CharClass
    
    Returns:
    
    a six element array of adjustments to max base stats
    
    See Also:
    
    CharStats
  - addedExpertise
```
public int addedExpertise(MOB host,
                          ExpertiseLibrary.XType expertiseCode,
                          java.lang.String abilityID)
```
    Description copied from interface: CharClass
    
    Whenever a uses a skill, this method can return any additional expertise granted explicitly by the class.
    
    Specified by:
    
    addedExpertise in interface CharClass
    
    Parameters:
    
    host - the player or mob whose class is being queried
    
    expertiseCode - the expertise code
    
    abilityID - the Ability ID
    
    Returns:
    
    the inherent expertise level for this
    
    See Also:
    
    ExpertiseLibrary.XType
  - allowedToAutoGain
```
protected boolean allowedToAutoGain(MOB mob,
                                    Ability A)
```
  - grantAbilities
```
public void grantAbilities(MOB mob,
                           boolean isBorrowedClass)
```
    Description copied from interface: CharClass
    
    Typically called when a mob gains a level in this class, to allow the class to assign any new skills. Can also be called just to populate a mob with class skills, so it should also confirm any lower level skills also.
    
    Specified by:
    
    grantAbilities in interface CharClass
    
    Parameters:
    
    mob - the mob to give abilities to.
    
    isBorrowedClass - whether the skills are savable (false) or temporary (true)
    
    See Also:
    
    AbilityContainer.addAbility(Ability)
  - checkRaceQualifierChanges
```
protected void checkRaceQualifierChanges()
```
  - isAllowedRace
```
public boolean isAllowedRace(Race R)
```
    Description copied from interface: CharClass
    
    Returns whether the given race matches the required race list rules.
    
    Specified by:
    
    isAllowedRace in interface CharClass
    
    Parameters:
    
    R - the race to check
    
    Returns:
    
    true if the race can be this class, false otherwse
    
    See Also:
    
    CharClass.getRequiredRaceList()
  - makeGenCharClass
```
public CharClass makeGenCharClass()
```
    Description copied from interface: CharClass
    
    Converts this class into a generic one, if it is not already. If it is generic, this method returns itself. Otherwise, the standard char class is converted to a generic one and returned.
    
    Specified by:
    
    makeGenCharClass in interface CharClass
    
    Returns:
    
    a generic version of this class.
    
    See Also:
    
    CharClass.isGeneric()
  - endCharacter
```
public void endCharacter(MOB mob)
```
    Description copied from interface: CharClass
    
    Called when a class is no longer the current dominant class of a player or mob, usually during class training.
    
    Specified by:
    
    endCharacter in interface CharClass
    
    Parameters:
    
    mob - the mob whose career to end or put aside
  - startCharacter
```
public void startCharacter(MOB mob,
                           boolean isBorrowedClass,
                           boolean verifyOnly)
```
    Description copied from interface: CharClass
    
    This method should be called whenever a mob has this class added to their charStats list. Its purpose is to outfit the mob with any necessary abilities, or perform other necessary changes to the mob to reflect the class addition or change. A character class is considered borrowed if its existence is derived from something else, or its skills/abilities should not be saved as a permanent feature of the mob.
    
    Specified by:
    
    startCharacter in interface CharClass
    
    Parameters:
    
    mob - the mob being outfitted with this class
    
    isBorrowedClass - whether the charclasses skills are borrowed(true) or permanent
    
    verifyOnly - send true if no skills or changes are to be made
  - outfit
```
public java.util.List<Item> outfit(MOB myChar)
```
    Description copied from interface: CharClass
    
    Returns a vector of Item objects representing the standard clothing, weapons, or other objects commonly given to players of this class just starting out.
    
    Specified by:
    
    outfit in interface CharClass
    
    Parameters:
    
    myChar - one who will receive the objects
    
    Returns:
    
    a vector of Item objects
  - affectPhyStats
```
public void affectPhyStats(Physical affected,
                           PhyStats affectableStats)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverPhyStats() method on other Environmental objects. It is used to transform the Environmental basePhyStats() object into a finished phyStats() object, both of which are objects implementing the PhyStats interface. See those methods for more information.
    
    Specified by:
    
    affectPhyStats in interface StatsAffecting
    
    Parameters:
    
    affected - the host of the PhyStats object being affected
    
    affectableStats - the particular PhyStats object being affected
    
    See Also:
    
    PhyStats, Environmental, Affectable.basePhyStats(), Affectable.phyStats(), Affectable.recoverPhyStats()
  - affectCharStats
```
public void affectCharStats(MOB affectedMob,
                            CharStats affectableStats)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverCharStats() method on other MOB objects. It is used to transform the MOB baseCharStats() object into a finished charStats() object, both of which are objects implementing the CharStats interface. See those methods for more information.
    
    Specified by:
    
    affectCharStats in interface StatsAffecting
    
    Parameters:
    
    affectedMob - the host of the CharStats object being affected
    
    affectableStats - the particular CharStats object being affected
    
    See Also:
    
    CharStats, MOB, MOB.baseCharStats(), MOB.charStats(), MOB.recoverCharStats()
  - affectCharState
```
public void affectCharState(MOB affectedMob,
                            CharState affectableMaxState)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverCharState() method on other MOB objects. It is used to transform the MOB baseCharState() object into a finished charState() object, both of which are objects implementing the CharState interface. See those methods for more information.
    
    Specified by:
    
    affectCharState in interface StatsAffecting
    
    Parameters:
    
    affectedMob - the host of the CharState object being affected
    
    affectableMaxState - the particular CharState object being affected
    
    See Also:
    
    CharState, MOB, MOB.baseState(), MOB.curState(), MOB.recoverMaxState()
  - okMessage
```
public boolean okMessage(Environmental myHost,
                         CMMsg msg)
```
    Description copied from interface: MsgListener
    
    The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.
    
    Specified by:
    
    okMessage in interface MsgListener
    
    Parameters:
    
    myHost - either the initiator of the event, or the host of this object
    
    msg - the CMMsg that wants to be executed
    
    Returns:
    
    whether this message is allowed to execute
    
    See Also:
    
    CMMsg, CMMsg.source()
  - executeMsg
```
public void executeMsg(Environmental myHost,
                       CMMsg msg)
```
    Description copied from interface: MsgListener
    
    The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.
    
    Specified by:
    
    executeMsg in interface MsgListener
    
    Parameters:
    
    myHost - either the initiator of the event, or the host of this object
    
    msg - the CMMsg that needs to be executed
    
    See Also:
    
    CMMsg
  - compareTo
```
public int compareTo(CMObject o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<CMObject>
  - unLevel
```
public void unLevel(MOB mob)
```
    Description copied from interface: CharClass
    
    This method is called whenever a player loses a level while a member of this class. If there are any special things which need to be done to a player who loses a level, they can be done in this method. By default, it doesn't do anything.
    
    Specified by:
    
    unLevel in interface CharClass
    
    Parameters:
    
    mob - the mob to level down
  - level
```
public void level(MOB mob,
                  java.util.List<java.lang.String> gainedAbilityIDs)
```
    Description copied from interface: CharClass
    
    This method is called whenever a player gains a level while a member of this class. If there are any special things which need to be done to a player who gains a level, they can be done in this method. By default, it doesn't do anything.
    
    Specified by:
    
    level in interface CharClass
    
    Parameters:
    
    mob - the mob to level up
    
    gainedAbilityIDs - the set of abilities/skill IDs gained during this leveling process
  - adjustExperienceGain
```
public int adjustExperienceGain(MOB host,
                                MOB mob,
                                MOB victim,
                                int amount)
```
    Description copied from interface: CharClass
    
    Whenever a player or mob of this race gains experience, this method gets a chance to modify the amount before the gain actually occurs.
    
    Specified by:
    
    adjustExperienceGain in interface CharClass
    
    Parameters:
    
    host - the player or mob whose class is being queried
    
    mob - the player or mob gaining experience
    
    victim - if applicable, the mob or player who died to give the exp
    
    amount - the amount of exp on track for gaining
    
    Returns:
    
    the adjusted amount of experience to gain
  - L
```
public java.lang.String L(java.lang.String str,
                          java.lang.String... xs)
```
    Localize an internal string -- shortcut. Same as calling:
    
    Parameters:
    
    str - the string to translate
    
    xs - the array of variables to replace
    
    Returns:
    
    the translated string, with all variables in place
    
    See Also:
    
    Call with the string to translate, which may contain variables of the form @x1, @x2, etc. The array in xs is then used to replace the variables AFTER the string is translated.
  - canBeADivider
```
public boolean canBeADivider(MOB killer,
                             MOB killed,
                             MOB mob,
                             java.util.Set<MOB> followers)
```
    Description copied from interface: CharClass
    
    Returns whether this class, for the given mob of this class, should count in the division of experience gained by the killer for having killed the killed. Assumes the mob is in the same room, and requires the followers of the killer be passed in.
    
    Specified by:
    
    canBeADivider in interface CharClass
    
    Parameters:
    
    killer - the killer mob
    
    killed - who the killer mob killed
    
    mob - the mob whose sharing capacity is being evaluated
    
    followers - the killers followers
    
    Returns:
    
    whether the mob shares in the exp gains
  - canBeABenificiary
```
public boolean canBeABenificiary(MOB killer,
                                 MOB killed,
                                 MOB mob,
                                 java.util.Set<MOB> followers)
```
    Description copied from interface: CharClass
    
    Returns whether this class, for the given mob of this class, should share in the experience gained by the killer for having killed the killed. Assumes the mob is in the same room, and requires the followers of the killer be passed in.
    
    Specified by:
    
    canBeABenificiary in interface CharClass
    
    Parameters:
    
    killer - the killer mob
    
    killed - who the killer mob killed
    
    mob - the mob whose sharing capacity is being evaluated
    
    followers - the killers followers
    
    Returns:
    
    whether the mob shares in the exp gains
  - isValidClassDivider
```
public boolean isValidClassDivider(MOB killer,
                                   MOB killed,
                                   MOB mob,
                                   java.util.Set<MOB> followers)
```
    Description copied from interface: CharClass
    
    Returns whether the given mob should count in the division of experience gained by the killer for having killed the killed. Assumes the mob is in the same room, and requires the followers of the killer be passed in. The class that determines this is usually that of the group leader.
    
    Specified by:
    
    isValidClassDivider in interface CharClass
    
    Parameters:
    
    killer - the killer mob
    
    killed - who the killer mob killed
    
    mob - the mob whose sharing capacity is being evaluated
    
    followers - the killers followers
    
    Returns:
    
    whether the mob shares in the exp gains
  - isValidClassBeneficiary
```
public boolean isValidClassBeneficiary(MOB killer,
                                       MOB killed,
                                       MOB mob,
                                       java.util.Set<MOB> followers)
```
    Description copied from interface: CharClass
    
    Returns whether the given mob should share in the experience gained by the killer for having killed the killed. Assumes the mob is in the same room, and requires the followers of the killer be passed in. The class that determines this is usually that of the group leader.
    
    Specified by:
    
    isValidClassBeneficiary in interface CharClass
    
    Parameters:
    
    killer - the killer mob
    
    killed - who the killer mob killed
    
    mob - the mob whose sharing capacity is being evaluated
    
    followers - the killers followers
    
    Returns:
    
    whether the mob shares in the exp gains
  - classParms
```
public java.lang.String classParms()
```
    Description copied from interface: CharClass
    
    Returns any boot-time parameters that are required to fully define this instance of a charclass. Charclasses are shared among mobs, but that doesn't mean mulitple instances of a single class can't generate different versions of themselves for the classloader, with different parameters. GenCharClass is an example.
    
    Specified by:
    
    classParms in interface CharClass
    
    Returns:
    
    any parameters used to define this class
    
    See Also:
    
    CharClass.setClassParms(String), CharClass.isGeneric()
  - setClassParms
```
public void setClassParms(java.lang.String parms)
```
    Description copied from interface: CharClass
    
    Sets any boot-time parameters that are required to fully define this instance of a charclass. Charclasses are shared among mobs, but that doesn't mean mulitple instances of a single class can't generate different versions of themselves for the classloader, with different parameters. GenCharClass is an example.
    
    Specified by:
    
    setClassParms in interface CharClass
    
    Parameters:
    
    parms - any parameters used to define this class
    
    See Also:
    
    CharClass.classParms(), CharClass.isGeneric()
  - getSaveStatIndex
```
public int getSaveStatIndex()
```
    Description copied from interface: Modifiable
    
    Returns the index into the stat codes array where extra savable fields begins. This number is always the same as getStatCodes().length unless there are extra fields which need to be saved in xml for generic objects. This method is used by editors for post-build user-defined fields.
    
    Specified by:
    
    getSaveStatIndex in interface Modifiable
    
    Returns:
    
    the index into getStatCodes()
    
    See Also:
    
    Modifiable.getStatCodes(), Modifiable.getStat(String), Modifiable.setStat(String, String)
  - getStat
```
public java.lang.String getStat(java.lang.String code)
```
    Description copied from interface: Modifiable
    
    An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.
    
    Specified by:
    
    getStat in interface Modifiable
    
    Parameters:
    
    code - the name of the field to read.
    
    Returns:
    
    the value of the field read
    
    See Also:
    
    Modifiable.getStatCodes()
  - setStat
```
public void setStat(java.lang.String code,
                    java.lang.String val)
```
    Description copied from interface: Modifiable
    
    An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.
    
    Specified by:
    
    setStat in interface Modifiable
    
    Parameters:
    
    code - the name of the field to set
    
    val - the value to set the field to
    
    See Also:
    
    Modifiable.getStatCodes()
  - getStatCodes
```
public java.lang.String[] getStatCodes()
```
    Description copied from interface: Modifiable
    
    Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
    
    Specified by:
    
    getStatCodes in interface Modifiable
    
    Returns:
    
    list of the fields which may be set.
    
    See Also:
    
    Modifiable.getStat(String), Modifiable.setStat(String, String)
  - isStat
```
public boolean isStat(java.lang.String code)
```
    Description copied from interface: Modifiable
    
    An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.
    
    Specified by:
    
    isStat in interface Modifiable
    
    Parameters:
    
    code - the name of the field to read.
    
    Returns:
    
    true if the code is a real value, false otherwise
    
    See Also:
    
    Modifiable.getStatCodes()
  - getCodeNum
```
protected int getCodeNum(java.lang.String code)
```
  - sameAs
```
public boolean sameAs(CharClass E)
```

Class StdCharClass

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.CharClasses.interfaces.CharClass

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.CharClasses.interfaces.CharClass

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

movementDesc

hitPointsDesc

manaDesc

names

maxStatAdj

outfitChoices

lastPropsCheckTime

previousRaceListHash

cachedRaceQualList

finalAllowedRaceSet

hitPointDescReplacePairs

manaDescReplacePairs

movementDescReplacePairs

CODES

Constructor Detail

StdCharClass

Method Detail

ID

name

name

baseClass

getLevelCap

getBonusPracLevel

getBonusAttackLevel

getAttackAttribute

getPracsFirstLevel

getTrainsFirstLevel

getLevelsPerBonusDamage

getMovementFormula

getHitPointsFormula

getManaFormula

allowedArmorLevel

allowedWeaponLevel

disallowedWeaponClasses

requiredWeaponMaterials

requiredArmorSourceMinor

armorFailMessage

raceless

leveless

expless

getSubClassRule

showThinQualifyList

maxNonCraftingSkills

maxCraftingSkills

maxCommonSkills

maxLanguages

getSecurityFlags

getRequiredRaceList

getMinimumStatRequirements

newInstance

getStartingMoney

getShortAttackAttribute

nameSet

initializeClass

isGeneric

availabilityCode

cloneFix

copyOf

classDurationModifier

classLevelModifier

getTickStatus

tick

qualifiesForThisClass

getWeaponLimitDesc

getArmorLimitDesc

getOtherLimitsDesc

getOtherBonusDesc

getStatQualDesc

getRaceQualDesc

getMaxStatDesc