Package com.planet_ink.coffee_mud.Races

Class Rat

java.lang.Object

com.planet_ink.coffee_mud.Races.StdRace

com.planet_ink.coffee_mud.Races.Rodent

com.planet_ink.coffee_mud.Races.Rat

All Implemented Interfaces:

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

Direct Known Subclasses:

GiantRat

public class Rat
extends Rodent

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Races.interfaces.Race

AGE_ANCIENT, AGE_CHILD, AGE_DESCS, AGE_INFANT, AGE_MATURE, AGE_MIDDLEAGED, AGE_OLD, AGE_TODDLER, AGE_VENERABLE, AGE_YOUNGADULT, BODY_ANTENNA, BODY_ARM, BODY_EAR, BODY_EYE, BODY_FOOT, BODY_GILL, BODY_HAND, BODY_HEAD, BODY_LEG, BODY_MOUTH, BODY_NECK, BODY_NOSE, BODY_PARTS, BODY_TAIL, BODY_TORSO, BODY_WAIST, BODY_WEARGRID, BODY_WEARVECTOR, BODY_WING, BODYPARTHASH, BODYPARTHASH_RL_LOWER, BODYPARTSTR, GENFLAG_DESCS, GENFLAG_INFATIGUEABLE, GENFLAG_NOCHARM, GENFLAG_NOCLASS, GENFLAG_NOEXP, GENFLAG_NOFERTILE, GENFLAG_NOLEVELS, YEARS_AGE_LIVES_FOREVER

Fields inherited from class com.planet_ink.coffee_mud.Races.StdRace

abilitiesDesc, baseStatChgDesc, breatheAirArray, breatheAirWaterArray, breatheAnythingArray, breatheWaterArray, CODES, dispChgDesc, empty, emptyIDs, languagesDesc, mappedCulturalAbilities, naturalAbilImmunities, naturalWeaponChoices, outfitChoices, racialAbilityMap, racialEffectMap, sensesChgDesc, usageCount

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
Rat()

Method Summary

Modifier and Type	Method	Description
void	affectCharStats(MOB affectedMOB, CharStats affectableStats)	This method is called by the recoverCharStats() method on other MOB objects.
int[]	bodyMask()	Returns an array indexed by body part codes as defined by the BODY_* constants in the Race interface.
int	heightVariance()	The amount from 0-this to add to the minimum height to achieve a random height.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
int	lightestWeight()	The lightest weight for a member of this race
java.util.List<RawMaterial>	myResources()	Returns a list of RawMaterial objects (usually GenFoodResource, GenLiquidResource, or GenResource items) representing what is left over of a member of this race after they've been butchered and cut up.
java.lang.String	name()	Return a nice, displayable name for this race
protected int[]	racialAbilityLevels()
protected java.lang.String[]	racialAbilityNames()
java.lang.String[]	racialAbilityParms()
protected int[]	racialAbilityProficiencies()
protected boolean[]	racialAbilityQuals()
java.lang.String	racialCategory()	Which racial category this race falls in.
int	shortestFemale()	The minimum height of females of this race.
int	shortestMale()	The minimum height of males of this race.
void	unaffectCharStats(MOB affectedMOB, CharStats affectableStats)	This method is called by the recoverCharStats() method on other Stats Affecting objects, when those objects are altering the Race away from this current race object to something else.
int	weightVariance()	The amount from 0-this to add to the minumum weight to achieve a random weight.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Races.Rodent

affectPhyStats, arriveStr, availabilityCode, forbiddenWornBits, getAgingChart, getNaturalWeapons, healthText, leaveStr, makeMobName

Methods inherited from class com.planet_ink.coffee_mud.Races.StdRace

abilityImmunities, adjustExperienceGain, affectCharState, agingAffects, canBreedWith, classless, cleanOutfit, clrStatChgDesc, compareTo, copyOf, culturalAbilities, culturalAbilityAutoGains, culturalAbilityLevels, culturalAbilityNames, culturalAbilityProficiencies, destroyBodyAfterUse, executeMsg, expless, fertile, getAbilitiesDesc, getBreathables, getCodeNum, getCorpseContainer, getDispositionChgDesc, getHumanoidWeapons, getLanguagesDesc, getNaturalWeapon, getPracAdjDesc, getSaveStatIndex, getSensesChgDesc, getStat, getStatAdjDesc, getStatCodes, getTickStatus, getTrainAdjDesc, getXPAdjustment, giveMobAbility, giveMobAbility, grantAbilities, grantAbilities, healthBuddy, infatigueable, initializeClass, isGeneric, isStat, L, level, leveless, makeGenRace, makeResource, makeResource, makeStatChgDesc, mapCulturalAbilities, mixRace, newInstance, numRacialEffects, okMessage, outfit, practicesAtFirstLevel, racialAbilities, racialEffectLevels, racialEffectNames, racialEffectParms, racialEffects, racialEffectsList, racialParms, sameAs, setHeightWeight, setRacialParms, setStat, startRacing, tick, trainsAtFirstLevel, uncharmable, usageCount, useRideClass

Constructor Detail

Rat

public Rat()

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

Overrides:

ID in class Rodent

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Race

Return a nice, displayable name for this race

Specified by:

name in interface CMObject

Specified by:

name in interface Race

Specified by:

name in interface Tickable

Overrides:

name in class Rodent

Returns:

the races name

See Also:

Environmental.Name()

shortestMale

public int shortestMale()

Description copied from interface: Race

The minimum height of males of this race.

Specified by:

shortestMale in interface Race

Overrides:

shortestMale in class Rodent

Returns:

minimum height of males in inches

shortestFemale

public int shortestFemale()

Description copied from interface: Race

The minimum height of females of this race.

Specified by:

shortestFemale in interface Race

Overrides:

shortestFemale in class Rodent

Returns:

minimum height of females in inches

heightVariance

public int heightVariance()

Description copied from interface: Race

The amount from 0-this to add to the minimum height to achieve a random height.

Specified by:

heightVariance in interface Race

Overrides:

heightVariance in class Rodent

Returns:

a range of inches to add to the mimiumum height

lightestWeight

public int lightestWeight()

Description copied from interface: Race

The lightest weight for a member of this race

Specified by:

lightestWeight in interface Race

Overrides:

lightestWeight in class Rodent

Returns:

the lightest weight for something of this race

weightVariance

public int weightVariance()

Description copied from interface: Race

The amount from 0-this to add to the minumum weight to achieve a random weight.

Specified by:

weightVariance in interface Race

Overrides:

weightVariance in class Rodent

Returns:

a range of pounds to add to the minimum weight

racialCategory

public java.lang.String racialCategory()

Description copied from interface: Race

Which racial category this race falls in.

Specified by:

racialCategory in interface Race

Overrides:

racialCategory in class Rodent

Returns:

racial category

racialAbilityNames

protected java.lang.String[] racialAbilityNames()

Overrides:

racialAbilityNames in class Rodent

racialAbilityLevels

protected int[] racialAbilityLevels()

Overrides:

racialAbilityLevels in class Rodent

racialAbilityProficiencies

protected int[] racialAbilityProficiencies()

Overrides:

racialAbilityProficiencies in class Rodent

racialAbilityQuals

protected boolean[] racialAbilityQuals()

Overrides:

racialAbilityQuals in class Rodent

racialAbilityParms

public java.lang.String[] racialAbilityParms()

Overrides:

racialAbilityParms in class Rodent

bodyMask

public int[] bodyMask()

Description copied from interface: Race

Returns an array indexed by body part codes as defined by the BODY_* constants in the Race interface. Each value is either -1 to show that the body part does not apply, 0 to show that the body part is not found on this race, and 1 or more to show how many of that part this race normally has.

Specified by:

bodyMask in interface Race

Overrides:

bodyMask in class Rodent

Returns:

an array of body parts

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

Overrides:

affectCharStats in class Rodent

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()

unaffectCharStats

public void unaffectCharStats(MOB affectedMOB,
                              CharStats affectableStats)

Description copied from interface: Race

This method is called by the recoverCharStats() method on other Stats Affecting objects, when those objects are altering the Race away from this current race object to something else. This gives the race an opportunity to undo any stat changes.

Specified by:

unaffectCharStats in interface Race

Overrides:

unaffectCharStats in class Rodent

Parameters:

affectedMOB - the mob of the CharStats object being affected

affectableStats - the particular CharStats object being affected

See Also:

CharStats, StatsAffecting, StatsAffecting.affectCharStats(MOB, CharStats)

myResources

public java.util.List<RawMaterial> myResources()

Description copied from interface: Race

Returns a list of RawMaterial objects (usually GenFoodResource, GenLiquidResource, or GenResource items) representing what is left over of a member of this race after they've been butchered and cut up.

Specified by:

myResources in interface Race

Overrides:

myResources in class Rodent

Returns:

a list of rawmaterial objects

See Also:

RawMaterial