com.planet_ink.coffee_mud.Races
Class PlayerRace

java.lang.Object
  com.planet_ink.coffee_mud.Races.StdRace
      com.planet_ink.coffee_mud.Races.Human
          com.planet_ink.coffee_mud.Races.PlayerRace

All Implemented Interfaces:

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

public class PlayerRace
extends Human

Field Summary

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

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

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_ANTENEA, 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 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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

PlayerRace()

Method Summary

void	affectCharStats(MOB affectedMOB, CharStats affectableStats) This method is called by the recoverCharStats() method on other MOB objects.
int	availabilityCode() Returns one or a combination of the Area.THEME_* constants from the Area interface.
int[]	bodyMask() Returns an array indexed by body part codes as defined by the BODY_* constants in the Race interface.
java.lang.String[]	culturalAbilityNames()
int[]	culturalAbilityProficiencies()
long	forbiddenWornBits() A bitmap showing which on locations a member of this race can not wear clothing, even if the members have one or more of the required limbs.
int[]	getAgingChart() Returns an integer array equal in size and index to the Race.AGE_* constants in the Race interface.
java.lang.String	healthText(MOB viewer, MOB mob) Returns a description of the given mobs description, by consulting the mobs curState().getHitPoints method.
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
Weapon	myNaturalWeapon() Returns a Weapon object representing what a member of this race fights with when unarmed.
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
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 race just starting out.
java.lang.String	racialCategory() Which racial category this race falls in.
protected int[]	racialEffectLevels()
protected java.lang.String[]	racialEffectNames()
protected java.lang.String[]	racialEffectParms()
int	shortestFemale() The minimum height of females of this race.
int	shortestMale() The minimum height of males of this race.
protected int	trainsAtFirstLevel()
int	weightVariance() The amount from 0-this to add to the minumum weight to achieve a random weight.

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

abilityImmunities, adjustExperienceGain, affectCharState, affectPhyStats, agingAffects, arriveStr, canBreedWith, classless, clrStatChgDesc, compareTo, copyOf, culturalAbilities, culturalAbilityAutoGains, culturalAbilityLevels, destroyBodyAfterUse, executeMsg, expless, fertile, funHumanoidWeapon, getAbilitiesDesc, getBreathables, getCodeNum, getCorpseContainer, getDispositionChgDesc, getLanguagesDesc, getPracAdjDesc, getSaveStatIndex, getSensesChgDesc, getStat, getStatAdjDesc, getStatCodes, getTickStatus, getTrainAdjDesc, getXPAdjustment, giveMobAbility, giveMobAbility, grantAbilities, grantAbilities, healthBuddy, infatigueable, initializeClass, isGeneric, isStat, L, leaveStr, level, leveless, makeGenRace, makeMobName, makeResource, makeResource, makeStatChgDesc, mapCulturalAbilities, mixRace, newInstance, numRacialEffects, okMessage, practicesAtFirstLevel, racialAbilities, racialAbilityLevels, racialAbilityNames, racialAbilityParms, racialAbilityProficiencies, racialAbilityQuals, racialEffects, racialEffectsList, racialParms, sameAs, setHeightWeight, setRacialParms, setStat, startRacing, tick, uncharmable, usageCount, useRideClass

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerRace

public PlayerRace()

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 Human

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 Tickable

Specified by:

name in interface Race

Overrides:

name in class Human

Returns:

the races name

See Also:

Environmental.Name()

culturalAbilityNames

public java.lang.String[] culturalAbilityNames()

Overrides:

culturalAbilityNames in class Human

culturalAbilityProficiencies

public int[] culturalAbilityProficiencies()

Overrides:

culturalAbilityProficiencies in class Human

availabilityCode

public int availabilityCode()

Description copied from interface: Race

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 race is available for selection by users at char creation time, whether they can change to this race via spells, or whether the race is utterly unavailable to them.

Specified by:

availabilityCode in interface Race

Overrides:

availabilityCode in class Human

Returns:

the availability/theme of this race

See Also:

Area

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 Human

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 Human

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 Human

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 Human

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 Human

Returns:

a range of pounds to add to the minimum weight

forbiddenWornBits

public long forbiddenWornBits()

Description copied from interface: Race

A bitmap showing which on locations a member of this race can not wear clothing, even if the members have one or more of the required limbs. The bitmap is made from Wearable.WORN_* constant values.

Specified by:

forbiddenWornBits in interface Race

Overrides:

forbiddenWornBits in class Human

Returns:

the illegal wear location bitmap

See Also:

Item

trainsAtFirstLevel

protected int trainsAtFirstLevel()

Overrides:

trainsAtFirstLevel in class Human

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 Human

Returns:

racial category

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 Human

Returns:

an array of body parts

getAgingChart

public int[] getAgingChart()

Description copied from interface: Race

Returns an integer array equal in size and index to the Race.AGE_* constants in the Race interface. Each value in the index represents the first mudyear age of that age category.

Specified by:

getAgingChart in interface Race

Overrides:

getAgingChart in class Human

Returns:

an integer array mapping ages to age categories

See Also:

Race

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 Human

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

racialEffectNames

protected java.lang.String[] racialEffectNames()

Overrides:

racialEffectNames in class Human

racialEffectLevels

protected int[] racialEffectLevels()

Overrides:

racialEffectLevels in class Human

racialEffectParms

protected java.lang.String[] racialEffectParms()

Overrides:

racialEffectParms in class Human

outfit

public java.util.List<Item> outfit(MOB myChar)

Description copied from interface: Race

Returns a vector of Item objects representing the standard clothing, weapons, or other objects commonly given to players of this race just starting out.

Specified by:

outfit in interface Race

Overrides:

outfit in class Human

Parameters:

myChar - one who will receive the objects

Returns:

a vector of Item objects

myNaturalWeapon

public Weapon myNaturalWeapon()

Description copied from interface: Race

Returns a Weapon object representing what a member of this race fights with when unarmed. This method may change what it returns on every call to mix things up a bit.

Specified by:

myNaturalWeapon in interface Race

Overrides:

myNaturalWeapon in class Human

Returns:

a Weapon object representing claws or teeth, etc..

See Also:

Weapon

healthText

public java.lang.String healthText(MOB viewer,
                                   MOB mob)

Description copied from interface: Race

Returns a description of the given mobs description, by consulting the mobs curState().getHitPoints method.

Specified by:

healthText in interface Race

Overrides:

healthText in class Human

Parameters:

viewer - the mob observing the health of this one

mob - the mob whose health to check

Returns:

a string describing his health

See Also:

MOB.curState(), CharState.getHitPoints()

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 Human

Returns:

a list of rawmaterial objects

See Also:

RawMaterial