|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.planet_ink.coffee_mud.CharClasses.StdCharClass
com.planet_ink.coffee_mud.CharClasses.GenCharClass
public class GenCharClass
| Field Summary | |
|---|---|
protected EnvStats |
adjEStats
|
protected CharState |
adjState
|
protected CharStats |
adjStats
|
protected int |
allowedArmorLevel
|
protected int |
attackAttribute
|
protected java.lang.String |
baseClass
|
protected int |
bonusAttackLevel
|
protected int |
bonusPracLevel
|
protected static java.lang.String[] |
CODES
|
protected int |
disableFlags
|
protected java.util.HashSet |
disallowedWeaponSet
|
protected CharClass |
eventBuddy
|
protected java.lang.String |
helpEntry
|
protected int |
hpDice
|
protected int |
hpDie
|
protected int |
hpDivisor
|
protected java.lang.String |
ID
|
protected int |
levelCap
|
protected int |
levelsPerBonusDamage
|
protected int |
manaDice
|
protected int |
manaDie
|
protected int |
manaDivisor
|
protected int |
movementMultiplier
|
protected java.lang.Integer[] |
nameLevels
|
protected java.lang.String |
otherBonuses
|
protected java.lang.String |
otherLimitations
|
protected int |
pracsFirstLevel
|
protected java.lang.String |
qualifications
|
protected int |
requiredArmorSourceMinor
|
protected java.util.Hashtable |
securityGroupCache
|
protected java.lang.Integer[] |
securityGroupLevels
|
protected java.util.Vector[] |
securityGroups
|
protected int |
selectability
|
protected CharStats |
setStats
|
protected CharState |
startAdjState
|
protected CharClass |
statBuddy
|
protected java.lang.String[] |
tempables
|
protected int |
trainsFirstLevel
|
protected java.lang.String[] |
xtraValues
|
| Fields inherited from class com.planet_ink.coffee_mud.CharClasses.StdCharClass |
|---|
maxStatAdj, names, outfitChoices |
| 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, WEAPONS_ALLCLERIC, WEAPONS_ANY, WEAPONS_BURGLAR, WEAPONS_DAGGERONLY, WEAPONS_EVILCLERIC, WEAPONS_FLAILONLY, WEAPONS_GOODCLERIC, WEAPONS_LONGDESC, WEAPONS_MAGELIKE, WEAPONS_NATURAL, WEAPONS_NEUTRALCLERIC, WEAPONS_ROCKY, WEAPONS_SETS, WEAPONS_THIEFLIKE |
| Constructor Summary | |
|---|---|
GenCharClass()
|
|
| Method Summary | |
|---|---|
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 |
affectEnvStats(Environmental affected,
EnvStats affectableStats)
This method is called by the recoverEnvStats() method on other Environmental objects. |
int |
allowedArmorLevel()
|
int |
allowedWeaponLevel()
|
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. |
java.lang.String |
classParms()
Returns any boot-time parameters that are required to fully define this instance of a charclass. |
void |
cloneFix(CharClass C)
|
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.HashSet |
disallowedWeaponClasses(MOB mob)
|
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. |
protected DVector |
getAbleSet()
|
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. |
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 java.lang.String |
getCharClassLocatorID(CharClass C)
|
protected int |
getCodeNum(java.lang.String code)
|
int |
getHPDice()
Hit points gained upon level is calculated by multiplying this stat by getHPDie(). |
int |
getHPDie()
Hit points gained upon level is calculated by multiplying this stat by getHPDice(). |
int |
getHPDivisor()
This number is used to generate the hit point bonus for mobs/players when they gain levels by dividing their hit point stat (constitution) by this number. |
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. |
int |
getManaDice()
mana gained upon level is calculated by multiplying this stat by getManaDie(). |
int |
getManaDie()
mana gained upon level is calculated by multiplying this stat by getManaDice(). |
int |
getManaDivisor()
This number is used to generate the mana bonus for mobs/players when they gain levels by dividing their mana stat (intelligence) by this number. |
int |
getMovementMultiplier()
The number multiplied by this classes movement-related character stat (Strength, Int, etc) in order to determine the BASE movement gained every level. |
int |
getPracsFirstLevel()
Returns the number of practices received by members of this class when they are first created. |
int |
getSaveStatIndex()
Returns the index into the stat codes array where extra savable fields begins. |
java.util.Vector |
getSecurityGroups(int classLevel)
Returns a Vector of security flag strings granted to all mobs/players who are this class, and the given class level or lower. |
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. |
int |
getTrainsFirstLevel()
Returns the number of training points received by members of this class when they are first created. |
java.lang.String |
ID()
The CoffeeMud Java Class ID shared by all instances of this object. |
boolean |
isGeneric()
Returns whether this class is fully defined using the setParms method, as opposed to being defined by its Java code. |
boolean |
leveless()
Whether players of this class can be associated with an experience level. |
boolean |
loaded()
|
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. |
CMObject |
newInstance()
Returns a new instance of this class. |
boolean |
okMessage(Environmental myHost,
CMMsg msg)
The general message event previewer for the object. |
java.lang.String |
otherBonuses()
Returns a text description of any bonus properties granted by this class to its members. |
java.lang.String |
otherLimitations()
Returns a text description of any misc restrictions imposed by this class upon its members. |
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. |
int |
requiredArmorSourceMinor()
|
protected java.util.HashSet |
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 |
setLoaded(boolean truefalse)
|
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. |
void |
startCharacter(MOB mob,
boolean isBorrowedClass,
boolean verifyOnly)
This method should be called whenever a mob has this class added to their charStats list. |
java.lang.String |
statQualifications()
Returns a text description of the stat qualifications required to become a member of this character class |
boolean |
tick(Tickable myChar,
int tickID)
this is the method which is called periodically by the threading engine. |
java.lang.String |
weaponLimitations()
Returns a text description of any weapon restrictions imposed by this class upon its members. |
| Methods inherited from class com.planet_ink.coffee_mud.CharClasses.StdCharClass |
|---|
adjustExperienceGain, armorCheck, armorFailMessage, armorLimitations, buildDisallowedWeaponClasses, buildDisallowedWeaponClasses, buildRequiredWeaponMaterials, classDurationModifier, compareTo, endCharacter, fillOutMOB, getLevelArmor, getLevelAttack, getLevelCap, getLevelDamage, getLevelMana, getLevelMove, getLevelPlayerHP, getLevelSpeed, getTickStatus, giveMobAbility, giveMobAbility, grantAbilities, initializeClass, isQualifyingAuthority, isStat, isValidClassBeneficiary, isValidClassDivider, level, makeGenCharClass, maxStatAdjustments, nameSet, outfit, unLevel, weaponCheck |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.lang.String ID
protected java.lang.Integer[] nameLevels
protected java.lang.String baseClass
protected int hpDivisor
protected int hpDice
protected int hpDie
protected int manaDivisor
protected int manaDice
protected int manaDie
protected int levelCap
protected int bonusPracLevel
protected int bonusAttackLevel
protected int attackAttribute
protected int pracsFirstLevel
protected int trainsFirstLevel
protected int levelsPerBonusDamage
protected int movementMultiplier
protected int allowedArmorLevel
protected java.lang.String otherLimitations
protected java.lang.String otherBonuses
protected java.lang.String qualifications
protected java.lang.String[] xtraValues
protected int selectability
protected int requiredArmorSourceMinor
protected java.util.HashSet disallowedWeaponSet
protected CharStats setStats
protected CharStats adjStats
protected EnvStats adjEStats
protected CharState adjState
protected CharState startAdjState
protected CharClass statBuddy
protected CharClass eventBuddy
protected int disableFlags
protected java.util.Vector[] securityGroups
protected java.lang.Integer[] securityGroupLevels
protected java.util.Hashtable securityGroupCache
protected java.lang.String helpEntry
protected static java.lang.String[] CODES
protected java.lang.String[] tempables
| Constructor Detail |
|---|
public GenCharClass()
| Method Detail |
|---|
public int getHPDivisor()
CharClass
getHPDivisor in interface CharClassgetHPDivisor in class StdCharClassCharClass.getHPDice(),
CharClass.getHPDie()public int getHPDice()
CharClass
getHPDice in interface CharClassgetHPDice in class StdCharClassCharClass.getHPDie()public int getHPDie()
CharClass
getHPDie in interface CharClassgetHPDie in class StdCharClassCharClass.getHPDice()public int getManaDivisor()
CharClass
getManaDivisor in interface CharClassgetManaDivisor in class StdCharClassCharClass.getManaDice(),
CharClass.getManaDie()public int getManaDice()
CharClass
getManaDice in interface CharClassgetManaDice in class StdCharClassCharClass.getManaDie()public int getManaDie()
CharClass
getManaDie in interface CharClassgetManaDie in class StdCharClassCharClass.getManaDice()public int allowedWeaponLevel()
allowedWeaponLevel in class StdCharClassprotected java.util.HashSet requiredWeaponMaterials()
requiredWeaponMaterials in class StdCharClasspublic int requiredArmorSourceMinor()
requiredArmorSourceMinor in class StdCharClassprotected java.util.HashSet disallowedWeaponClasses(MOB mob)
disallowedWeaponClasses in class StdCharClasspublic boolean raceless()
CharClass
raceless in interface CharClassraceless in class StdCharClassRacepublic boolean leveless()
CharClass
leveless in interface CharClassleveless in class StdCharClasspublic boolean expless()
CharClass
expless in interface CharClassexpless in class StdCharClasspublic java.util.Vector getSecurityGroups(int classLevel)
CharClass
getSecurityGroups in interface CharClassgetSecurityGroups in class StdCharClassclassLevel - the class level of the mob
public boolean isGeneric()
CharClass
isGeneric in interface CharClassisGeneric in class StdCharClassCharClass.classParms(),
CharClass.makeGenCharClass(),
CharClass.setClassParms(String)public java.lang.String ID()
CMObject
ID in interface CMObjectID in class StdCharClasspublic java.lang.String name()
CharClass
name in interface CharClassname in interface Tickablename in class StdCharClassCharClass.name(int),
CharClass.nameSet()public java.lang.String name(int classLevel)
CharClass
name in interface CharClassname in class StdCharClassCharClass.name(),
CharClass.nameSet()public java.lang.String baseClass()
CharClass
baseClass in interface CharClassbaseClass in class StdCharClasspublic int getBonusPracLevel()
CharClass
getBonusPracLevel in interface CharClassgetBonusPracLevel in class StdCharClasspublic int getBonusAttackLevel()
CharClass
getBonusAttackLevel in interface CharClassgetBonusAttackLevel in class StdCharClasspublic int getAttackAttribute()
CharClass
getAttackAttribute in interface CharClassgetAttackAttribute in class StdCharClassCharStatspublic int getPracsFirstLevel()
CharClass
getPracsFirstLevel in interface CharClassgetPracsFirstLevel in class StdCharClasspublic int getTrainsFirstLevel()
CharClass
getTrainsFirstLevel in interface CharClassgetTrainsFirstLevel in class StdCharClasspublic int getLevelsPerBonusDamage()
CharClass
getLevelsPerBonusDamage in interface CharClassgetLevelsPerBonusDamage in class StdCharClasspublic int getMovementMultiplier()
CharClass
getMovementMultiplier in interface CharClassgetMovementMultiplier in class StdCharClasspublic int allowedArmorLevel()
allowedArmorLevel in class StdCharClasspublic java.lang.String otherLimitations()
CharClass
otherLimitations in interface CharClassotherLimitations in class StdCharClasspublic java.lang.String otherBonuses()
CharClass
otherBonuses in interface CharClassotherBonuses in class StdCharClasspublic int availabilityCode()
CharClass
availabilityCode in interface CharClassavailabilityCode in class StdCharClassAreapublic java.lang.String weaponLimitations()
CharClass
weaponLimitations in interface CharClassweaponLimitations in class StdCharClasspublic void cloneFix(CharClass C)
cloneFix in class StdCharClasspublic CMObject newInstance()
CMObject
newInstance in interface CMObjectnewInstance in class StdCharClasspublic CMObject copyOf()
CMObject
copyOf in interface CMObjectcopyOf in class StdCharClasspublic boolean loaded()
public void setLoaded(boolean truefalse)
public boolean qualifiesForThisClass(MOB mob,
boolean quiet)
CharClass
qualifiesForThisClass in interface CharClassqualifiesForThisClass in class StdCharClassmob - the mob to evaluate the worthiness ofquiet - false to give the mob error messages, true for silence
public java.lang.String statQualifications()
CharClass
statQualifications in interface CharClassstatQualifications in class StdCharClassprotected java.lang.String getCharClassLocatorID(CharClass C)
public void affectEnvStats(Environmental affected,
EnvStats affectableStats)
StatsAffecting
affectEnvStats in interface StatsAffectingaffectEnvStats in class StdCharClassaffected - the host of the EnvStats object being affectedaffectableStats - the particular EnvStats object being affectedEnvStats,
Environmental,
Environmental.baseEnvStats(),
Environmental.envStats(),
Environmental.recoverEnvStats()
public boolean tick(Tickable myChar,
int tickID)
Tickable
tick in interface Tickabletick in class StdCharClassmyChar - a reference to this Tickable objecttickID - the TICKID_ constant describing this periodic call, as defined in Tickable
Tickable,
ServiceEngine,
TickableGroup
public void executeMsg(Environmental myHost,
CMMsg msg)
MsgListener