Package com.planet_ink.coffee_mud.MOBS

Class GenCow

java.lang.Object

com.planet_ink.coffee_mud.MOBS.StdMOB

com.planet_ink.coffee_mud.MOBS.StdRideable

com.planet_ink.coffee_mud.MOBS.GenRideable

com.planet_ink.coffee_mud.MOBS.GenCow

All Implemented Interfaces:

AbilityContainer, Affectable, Behavable, CMObject, Combatant, Contingent, DBIdentifiable, Decayable, Drink, Environmental, Expireable, FactionMember, Followable<MOB>, ItemCollection, ItemPossessor, LiquidHolder, Modifiable, MsgListener, MUDCmdProcessor, Physical, PhysicalAgent, Rideable, Rider, StatsAffecting, Tattooable, Tickable, MOB, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenCow
extends GenRideable
implements Drink

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor

ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

MOB.Attrib

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

Rideable.Basis

Nested classes/interfaces inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

StdMOB.ApplyAffectCharState<T extends StatsAffecting>, StdMOB.ApplyAffectCharStats<T extends StatsAffecting>, StdMOB.ApplyRecAffectPhyStats<T extends StatsAffecting>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	amountOfLiquidHeld
protected int	amountOfLiquidRemaining
protected int	amountOfThirstQuenched
protected int	liquidType
protected double	refill

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

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.MOB

AGE_MILLIS_THRESHOLD, END_SHEATH_TIME, START_SHEATH_TIME

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

METAFLAG_AS, METAFLAG_ASMESSAGE, METAFLAG_FORCED, METAFLAG_INORDER, METAFLAG_MPFORCED, METAFLAG_ORDER, METAFLAG_POSSESSED, METAFLAG_QUIETLY, METAFLAG_REVERSED, METAFLAG_SNOOPED

Fields inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

_name, abilitys, abilityUseCache, abilityUseTrig, affectCharState, affectCharStats, affectPhyStats, affects, ageMinutes, amDead, amDestroyed, amFollowing, atRange, attributesBitmap, baseCharStats, basePhyStats, baseState, behaviors, cachedImageName, charStats, clanAffects, clans, CODES, commandQue, curState, databaseID, description, displayText, experience, expertises, factions, followers, inventory, kickFlag, lastLocation, liegeID, location, maxState, me, miscText, money, moneyVariation, mySession, peaceTime, phyStats, playerStats, possHeldItem, possStartRoom, possWieldedItem, practices, questPoint, racialAffects, rawImageName, recoverAffectP, recoverTickCter, removeFromGame, riding, scripts, soulMate, speedAdj, tattoos, tickAgeCounter, tickStatus, trains, triggerer, validChkCounter, victim, wimpHitPoint, xtraValues

Fields inherited from class com.planet_ink.coffee_mud.MOBS.StdRideable

dismountString, mountString, putString, rideBasis, riderCapacity, riders, rideString, stateString, stateSubjectStr

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

Method Summary

Modifier and Type	Method	Description
int	amountTakenToFillMe(LiquidHolder theSource)	Given the liquid source, the amount of liquid which would need to be taken from the source liquid source to fill up THIS liquid source.
boolean	containsLiquid()	Whether this liquid container still contains any liquid.
long	decayTime()	The time, in milliseconds, when this will rot.
boolean	disappearsAfterDrinking()	Settable only internally, this method returns whether this entire object is destroyed immediately after it is drank from -- like a potion.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
protected int	getCodeNum(java.lang.String code)
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	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
int	liquidHeld()	The total amount of liquid possible to be contained in this liquid container.
int	liquidRemaining()	The amount of liquid remaining in this liquid container.
int	liquidType()	The material type of the liquid in this container.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
void	setDecayTime(long time)	Sets the time, in milliseconds, when this will rot.
void	setLiquidHeld(int amount)	Sets the total amount of liquid possible to be contained in this liquid container.
void	setLiquidRemaining(int amount)	Sets the amount of liquid remaining in this liquid container.
void	setLiquidType(int newLiquidType)	Sets the material type of the liquid in this container.
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	setThirstQuenched(int amount)	Set the amount of thirst points quenched every time this item is drank from.
int	thirstQuenched()	The amount of thirst points quenched every time this item is drank from.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, setBasePhyStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable

expirationDate, setExpirationDate

Methods inherited from class com.planet_ink.coffee_mud.MOBS.GenRideable

isGeneric, setMiscText, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, isStat

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical

description, genericName, name

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB

abilities, actions, addAbility, addBehavior, addEffect, addExpertise, addFaction, addFollower, addItem, addItem, addNonUninvokableEffect, addPriorityEffect, addScript, addTattoo, addTattoo, addTattoo, adjustFaction, allAbilities, amActive, amDead, amDestroyed, amFollowing, amUltimatelyFollowing, baseCharStats, basePhyStats, baseState, baseWeight, behaviors, bringToLife, bringToLife, calculateActionCost, canSaveDatabaseID, charStats, checkCommandCancel, clanEffects, clans, clearCommandQueue, commandQueSize, compareTo, confirmLocation, copyFactions, copyOf, counItemsWornAt, curState, databaseID, delAbility, delAllAbilities, delAllBehaviors, delAllEffects, delAllExpertises, delAllItems, delAllScripts, delBehavior, delEffect, delExpertise, delFollower, delItem, delScript, delTattoo, delTattoo, dequeCommand, description, description, displayText, dispossess, doCommand, doCommand, eachBehavior, eachEffect, eachItem, eachScript, effects, enqueCommand, enqueCommands, expertises, expirationDate, factions, fetchAbility, fetchAbility, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchExpertise, fetchFaction, fetchFactionData, fetchFactionRanges, fetchFirstWornItem, fetchFollower, fetchFollower, fetchFollowerOrder, fetchFromInventory, fetchHeldItem, fetchItem, fetchRandomAbility, fetchScript, fetchWieldedItem, fetchWornItems, findAbility, findItem, findItem, findItems, findItems, findTattoo, findTattooStartsWith, fixChannelColors, flagVariableEq, followers, freeWearPositions, genericName, getAbilityUsageCache, getAgeMinutes, getAttributesBitmap, getClanRole, getCombatant, getContextName, getDirectionToTarget, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getFactionListing, getGroupMembers, getGroupMembersAndRideables, getItem, getLiegeID, getMoney, getMoneyVariation, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getRandomItem, getSaveStatIndex, getStartRoom, getTickStatus, getTopCommand, getTrains, getVictim, getWearPositions, getWimpHitPoint, hasFaction, hasOnlyGoldInInventory, healthText, image, initializeClass, isAttributeSet, isContent, isEitherOfUsDead, isFollowedBy, isInCombat, isMarriedToLiege, isMine, isMonster, isPermissableToFight, isPlayer, isPossessing, isRacialAbility, isStat, items, L, lastTickedDateTime, location, makePeace, maxCarry, maxFollowers, maxItems, maxRange, maxState, mayIFight, mayPhysicallyAttack, minRange, miscTextFormat, moveItemTo, moveItemTo, name, name, Name, newInstance, numAbilities, numAllAbilities, numAllEffects, numBehaviors, numEffects, numFollowers, numItems, numScripts, personalEffects, phyStats, playerStats, prequeCommand, prequeCommands, racialEffects, rangeToTarget, rawImage, recoverCharStats, recoverMaxState, removeFaction, removeFromGame, resetToMaxState, riding, scripts, session, setActions, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBasePhyStats, setBaseState, setClan, setCombatant, setDatabaseID, setDescription, setDestroyed, setDisplayText, setExperience, setExpirationDate, setFollowing, setImage, setLiegeID, setLocation, setMoney, setMoneyVariation, setName, setPlayerStats, setPractices, setQuestPoint, setRangeToTarget, setRiding, setSavable, setSession, setSoulMate, setStartRoom, setTrains, setTriggerer, setVictim, setWimpHitPoint, soulMate, tattoos, tell, tell, titledName, titledName, totalFollowers, triggerer, willFollowOrdersOf

Methods inherited from class com.planet_ink.coffee_mud.MOBS.StdRideable

addRider, affectCharState, affectCharStats, affectPhyStats, amRiding, cloneFix, delRider, destroy, dismountString, displayText, fetchRider, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, isMobileRideBasis, isSavable, killMeDead, mobileRideBasis, mountString, numRiders, putString, recoverPhyStats, rideBasis, riderCapacity, riders, rideString, setDismountString, setMountString, setPutString, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, stateString, stateStringSubject

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

getTickStatus, name

Field Detail

amountOfThirstQuenched

protected int amountOfThirstQuenched

amountOfLiquidHeld

protected int amountOfLiquidHeld

amountOfLiquidRemaining

protected int amountOfLiquidRemaining

liquidType

protected int liquidType

refill

protected volatile double refill

Constructor Detail

GenCow

public GenCow()

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 GenRideable

Returns:

the name of this class

decayTime

public long decayTime()

Description copied from interface: Decayable

The time, in milliseconds, when this will rot. 0=never

Specified by:

decayTime in interface Decayable

Returns:

the time in milliseconds when this will rot. 0=never

See Also:

Decayable.setDecayTime(long)

setDecayTime

public void setDecayTime(long time)

Description copied from interface: Decayable

Sets the time, in milliseconds, when this will rot. 0=never

Specified by:

setDecayTime in interface Decayable

Parameters:

time - in milliseconds, when this will rot. 0=never

See Also:

Decayable.decayTime()

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

Overrides:

okMessage in class StdRideable

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

Overrides:

executeMsg in class StdRideable

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

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

Overrides:

tick in class StdMOB

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

thirstQuenched

public int thirstQuenched()

Description copied from interface: Drink

The amount of thirst points quenched every time this item is drank from.

Specified by:

thirstQuenched in interface Drink

Returns:

amount of thirst quenched

See Also:

CharState

liquidHeld

public int liquidHeld()

Description copied from interface: LiquidHolder

The total amount of liquid possible to be contained in this liquid container.

Specified by:

liquidHeld in interface LiquidHolder

Returns:

total liquid contained herein.

liquidRemaining

public int liquidRemaining()

Description copied from interface: LiquidHolder

The amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:

liquidRemaining in interface LiquidHolder

Returns:

amount of liquid remaining in this liquid container.

See Also:

LiquidHolder.liquidHeld()

disappearsAfterDrinking

public boolean disappearsAfterDrinking()

Description copied from interface: Drink

Settable only internally, this method returns whether this entire object is destroyed immediately after it is drank from -- like a potion.

Specified by:

disappearsAfterDrinking in interface Drink

Returns:

Whether the item survives after drinking.

liquidType

public int liquidType()

Description copied from interface: LiquidHolder

The material type of the liquid in this container. Although a class implementing the LiquidHolder interface can sometimes be a liquid itself (like GenLiquidResource), most often, a Drink interface implementing class is a mob without a material to draw from or an Item having its own non-liquid material (like a leather waterskin containing milk). Either way, this is necessary. The material types are constants in RawMaterial.

Specified by:

liquidType in interface LiquidHolder

Returns:

the type of liquid contained herein

See Also:

RawMaterial

setLiquidType

public void setLiquidType(int newLiquidType)

Description copied from interface: LiquidHolder

Sets the material type of the liquid in this container. Although a class implementing the LiquidHolder interface can sometimes be a liquid itself (like GenLiquidResource), most often, a Drink interface implementing class is a mob without a material to draw from or an Item having its own non-liquid material (like a leather waterskin containing milk). Either way, this is necessary. The material types are constants in RawMaterial.

Specified by:

setLiquidType in interface LiquidHolder

Parameters:

newLiquidType - the type of liquid contained herein

See Also:

RawMaterial

setThirstQuenched

public void setThirstQuenched(int amount)

Description copied from interface: Drink

Set the amount of thirst points quenched every time this item is drank from.

Specified by:

setThirstQuenched in interface Drink

Parameters:

amount - of thirst quenched

See Also:

CharState

setLiquidHeld

public void setLiquidHeld(int amount)

Description copied from interface: LiquidHolder

Sets the total amount of liquid possible to be contained in this liquid container.

Specified by:

setLiquidHeld in interface LiquidHolder

Parameters:

amount - total liquid contained herein.

setLiquidRemaining

public void setLiquidRemaining(int amount)

Description copied from interface: LiquidHolder

Sets the amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:

setLiquidRemaining in interface LiquidHolder

Parameters:

amount - amount of liquid remaining in this liquid container.

See Also:

LiquidHolder.setLiquidHeld(int)

containsLiquid

public boolean containsLiquid()

Description copied from interface: LiquidHolder

Whether this liquid container still contains any liquid.

Specified by:

containsLiquid in interface LiquidHolder

Returns:

whether any liquid is left.

amountTakenToFillMe

public int amountTakenToFillMe(LiquidHolder theSource)

Description copied from interface: LiquidHolder

Given the liquid source, the amount of liquid which would need to be taken from the source liquid source to fill up THIS liquid source.

Specified by:

amountTakenToFillMe in interface LiquidHolder

Parameters:

theSource - the liquid source to fill up from

Returns:

the amount to take from the liquid source

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

Overrides:

getStat in class GenRideable

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

Overrides:

setStat in class GenRideable

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()

getCodeNum

protected int getCodeNum(java.lang.String code)

Overrides:

getCodeNum in class GenRideable

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

Overrides:

getStatCodes in class GenRideable

Returns:

list of the fields which may be set.

See Also:

Modifiable.getStat(String), Modifiable.setStat(String, String)

sameAs

public boolean sameAs(Environmental E)

Description copied from interface: Environmental

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:

sameAs in interface Environmental

Overrides:

sameAs in class GenRideable

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)