com.planet_ink.coffee_mud.MOBS
Class GoatDoe

java.lang.Object
  extended by com.planet_ink.coffee_mud.MOBS.StdMOB
      extended by com.planet_ink.coffee_mud.MOBS.Goat
          extended by com.planet_ink.coffee_mud.MOBS.GoatDoe
All Implemented Interfaces:
AbilityContainer, Affectable, Behavable, CMObject, Combatant, Contingent, DBIdentifiable, Decayable, Drink, Environmental, FactionMember, Followable<MOB>, ItemCollection, ItemPossessor, Modifiable, MsgListener, MUDCmdProcessor, Physical, PhysicalAgent, Rider, StatsAffecting, Tattooable, Tickable, MOB, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GoatDoe
extends Goat
implements Drink


Nested Class Summary
 
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>
 
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.ItemPossessor
ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move
 
Field Summary
protected  int liquidType
           
 
Fields inherited from class com.planet_ink.coffee_mud.MOBS.StdMOB
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, tattoos, tickAgeCounter, tickStatus, trains, username, victim, wimpHitPoint, worshipCharID, xtraValues
 
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
 
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_SNOOPED
 
Constructor Summary
GoatDoe()
           
 
Method Summary
 int amountTakenToFillMe(Drink 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 containsDrink()
          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.
 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.
 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 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.
 
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, affectCharState, affectCharStats, affectPhyStats, allAbilities, amActive, amDead, amDestroyed, amFollowing, amUltimatelyFollowing, baseCharStats, basePhyStats, baseState, baseWeight, behaviors, bringToLife, bringToLife, calculateActionCost, canSaveDatabaseID, charStats, clanEffects, clans, clearCommandQueue, cloneFix, commandQueSize, compareTo, confirmLocation, copyFactions, copyOf, curState, databaseID, delAbility, delAllAbilities, delAllBehaviors, delAllEffects, delAllExpertises, delAllItems, delAllScripts, delBehavior, delEffect, delExpertise, delFollower, delItem, delScript, delTattoo, delTattoo, dequeCommand, description, description, destroy, displayText, 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, getCodeNum, getCombatant, getDirectionToTarget, getExperience, getExpNeededDelevel, getExpNeededLevel, getExpNextLevel, getExpPrevLevel, getFactionListing, getGroupMembers, getGroupMembersAndRideables, getItem, getLiegeID, getMoney, getMoneyVariation, getMyDeity, getNaturalWeapon, getPeaceTime, getPractices, getQuestPoint, getRandomItem, getRideBuddies, getSaveStatIndex, getStartRoom, getStat, getStatCodes, getTickStatus, getTrains, getVictim, getWearPositions, getWimpHitPoint, getWorshipCharID, hasFaction, hasOnlyGoldInInventory, healthText, image, initializeClass, isAttributeSet, isContent, isEitherOfUsDead, isFollowedBy, isGeneric, isInCombat, isMarriedToLiege, isMine, isMonster, isPermissableToFight, isPlayer, isPossessing, isRacialAbility, isSavable, isStat, items, killMeDead, 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, recoverPhyStats, removeFaction, removeFromGame, resetToMaxState, riding, sameAs, scripts, session, setActions, setAgeMinutes, setAttribute, setAttributesBitmap, setBaseCharStats, setBasePhyStats, setBaseState, setClan, setCombatant, setDatabaseID, setDescription, setDisplayText, setExperience, setExpirationDate, setFollowing, setImage, setLiegeID, setLocation, setMiscText, setMoney, setMoneyVariation, setName, setPlayerStats, setPractices, setQuestPoint, setRangeToTarget, setRiding, setSavable, setSession, setSoulMate, setStartRoom, setStat, setTrains, setVictim, setWimpHitPoint, setWorshipCharID, soulMate, tattoos, tell, tell, text, tick, titledName, totalFollowers, willFollowOrdersOf
 
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.Environmental
description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
getTickStatus, name, tick
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting
affectCharState, affectCharStats, affectPhyStats
 
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.CMObject
copyOf, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
 

Field Detail

liquidType

protected int liquidType
Constructor Detail

GoatDoe

public GoatDoe()
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 Goat
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 StdMOB
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 StdMOB
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

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: Drink
The total amount of liquid possible to be contained in this liquid container.

Specified by:
liquidHeld in interface Drink
Returns:
total liquid contained herein.

liquidRemaining

public int liquidRemaining()
Description copied from interface: Drink
The amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:
liquidRemaining in interface Drink
Returns:
amount of liquid remaining in this liquid container.
See Also:
Drink.liquidHeld()

liquidType

public int liquidType()
Description copied from interface: Drink
The material type of the liquid in this container. Although a class implementing the Drink 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 Drink
Returns:
the type of liquid contained herein
See Also:
RawMaterial

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.

setLiquidType

public void setLiquidType(int newLiquidType)
Description copied from interface: Drink
Sets the material type of the liquid in this container. Although a class implementing the Drink 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 Drink
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: Drink
Sets the total amount of liquid possible to be contained in this liquid container.

Specified by:
setLiquidHeld in interface Drink
Parameters:
amount - total liquid contained herein.

setLiquidRemaining

public void setLiquidRemaining(int amount)
Description copied from interface: Drink
Sets the amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:
setLiquidRemaining in interface Drink
Parameters:
amount - amount of liquid remaining in this liquid container.
See Also:
Drink.setLiquidHeld(int)

containsDrink

public boolean containsDrink()
Description copied from interface: Drink
Whether this liquid container still contains any liquid.

Specified by:
containsDrink in interface Drink
Returns:
whether any liquid is left.

amountTakenToFillMe

public int amountTakenToFillMe(Drink theSource)
Description copied from interface: Drink
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 Drink
Parameters:
theSource - the liquid source to fill up from
Returns:
the amount to take from the liquid source