com.planet_ink.coffee_mud.Items.Basic
Class Corpse

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdContainer
          com.planet_ink.coffee_mud.Items.Basic.GenContainer
              com.planet_ink.coffee_mud.Items.Basic.Corpse

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, MsgListener, Rider, StatsAffecting, Tickable, Container, DeadBody, Item, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenCorpse

public class Corpse
extends GenContainer
implements DeadBody

Field Summary

protected CharStats	charStats
protected boolean	destroyAfterLooting
protected java.lang.String	killerName
protected boolean	killerPlayer
protected Environmental	killingTool
protected java.lang.String	lastMessage
protected java.lang.String	mobDescription
protected java.lang.String	mobName
protected boolean	mobPKFlag
protected boolean	playerCorpse
protected MOB	savedMOB
protected long	timeOfDeath

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.GenContainer

readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containType, hasALid, hasALock, isLocked, isOpen

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

affects, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

Constructor Summary

Corpse()

Method Summary

CharStats	charStats()
void	destroy() Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
boolean	destroyAfterLooting()
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.
java.lang.String	killerName()
boolean	killerPlayer()
Environmental	killingTool()
java.lang.String	lastMessage()
java.lang.String	mobDescription()
java.lang.String	mobName()
boolean	mobPKFlag()
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
boolean	playerCorpse()
MOB	savedMOB()
void	setCharStats(CharStats newStats)
void	setDestroyAfterLooting(boolean truefalse)
void	setKillerName(java.lang.String newName)
void	setKillerPlayer(boolean trueFalse)
void	setKillingTool(Environmental tool)
void	setLastMessage(java.lang.String lastMsg)
void	setMiscText(java.lang.String newText) For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
void	setMobDescription(java.lang.String newDescription)
void	setMobName(java.lang.String newName)
void	setMobPKFlag(boolean truefalse)
void	setPlayerCorpse(boolean truefalse)
void	setSavedMOB(MOB mob)
void	setSecretIdentity(java.lang.String newIdentity) This method is used to change the string returned by rawSecretIdentity.
void	setTimeOfDeath(long time)
long	timeOfDeath()

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.GenContainer

getCodeNum, getStat, getStatCodes, isGeneric, keyName, readableText, sameAs, setKeyName, setReadableText, setStat, text

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

canContain, capacity, containTypes, emptyPlease, getContents, hasALid, hasALock, isLocked, isOpen, reallyGetContents, setCapacity, setContainTypes, setLidsNLocks, tick

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, baseGoldValue, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, displayText, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getSaveStatIndex, getTickStatus, image, initializeClass, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

canContain, capacity, containTypes, emptyPlease, getContents, hasALid, hasALock, isLocked, isOpen, keyName, setCapacity, setContainTypes, setKeyName, setLidsNLocks

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

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

riding, setRiding

Field Detail

charStats

protected CharStats charStats

mobName

protected java.lang.String mobName

mobDescription

protected java.lang.String mobDescription

killerName

protected java.lang.String killerName

killerPlayer

protected boolean killerPlayer

lastMessage

protected java.lang.String lastMessage

killingTool

protected Environmental killingTool

destroyAfterLooting

protected boolean destroyAfterLooting

playerCorpse

protected boolean playerCorpse

timeOfDeath

protected long timeOfDeath

mobPKFlag

protected boolean mobPKFlag

savedMOB

protected MOB savedMOB

Constructor Detail

Corpse

public Corpse()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class GenContainer

Returns:

the name of this class

setMiscText

public void setMiscText(java.lang.String newText)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class GenContainer

Parameters:

newText - either an open internal text string, or XML

charStats

public CharStats charStats()

Specified by:

charStats in interface DeadBody

setCharStats

public void setCharStats(CharStats newStats)

Specified by:

setCharStats in interface DeadBody

setSecretIdentity

public void setSecretIdentity(java.lang.String newIdentity)

Description copied from interface: Item

This method is used to change the string returned by rawSecretIdentity. This string is saved to the database as the items secret properties desctiption. The secretIdentity method uses this string to construct its full description.

Specified by:

setSecretIdentity in interface Item

Overrides:

setSecretIdentity in class StdItem

Parameters:

newIdentity - the secret properties of this item. Empty string means it has none.

destroy

public void destroy()

Description copied from interface: Environmental

Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java. Containers, rooms. and mobs who have their destroy() method called will also call the destroy() methods on all items and other objects listed as content, recursively.

Specified by:

destroy in interface Environmental

Overrides:

destroy in class StdItem

mobName

public java.lang.String mobName()

Specified by:

mobName in interface DeadBody

setMobName

public void setMobName(java.lang.String newName)

Specified by:

setMobName in interface DeadBody

mobDescription

public java.lang.String mobDescription()

Specified by:

mobDescription in interface DeadBody

setMobDescription

public void setMobDescription(java.lang.String newDescription)

Specified by:

setMobDescription in interface DeadBody

mobPKFlag

public boolean mobPKFlag()

Specified by:

mobPKFlag in interface DeadBody

setMobPKFlag

public void setMobPKFlag(boolean truefalse)

Specified by:

setMobPKFlag in interface DeadBody

killerName

public java.lang.String killerName()

Specified by:

killerName in interface DeadBody

setKillerName

public void setKillerName(java.lang.String newName)

Specified by:

setKillerName in interface DeadBody

killerPlayer

public boolean killerPlayer()

Specified by:

killerPlayer in interface DeadBody

setKillerPlayer

public void setKillerPlayer(boolean trueFalse)

Specified by:

setKillerPlayer in interface DeadBody

playerCorpse

public boolean playerCorpse()

Specified by:

playerCorpse in interface DeadBody

setPlayerCorpse

public void setPlayerCorpse(boolean truefalse)

Specified by:

setPlayerCorpse in interface DeadBody

lastMessage

public java.lang.String lastMessage()

Specified by:

lastMessage in interface DeadBody

setLastMessage

public void setLastMessage(java.lang.String lastMsg)

Specified by:

setLastMessage in interface DeadBody

killingTool

public Environmental killingTool()

Specified by:

killingTool in interface DeadBody

setKillingTool

public void setKillingTool(Environmental tool)

Specified by:

setKillingTool in interface DeadBody

destroyAfterLooting

public boolean destroyAfterLooting()

Specified by:

destroyAfterLooting in interface DeadBody

setDestroyAfterLooting

public void setDestroyAfterLooting(boolean truefalse)

Specified by:

setDestroyAfterLooting in interface DeadBody

timeOfDeath

public long timeOfDeath()

Specified by:

timeOfDeath in interface DeadBody

setTimeOfDeath

public void setTimeOfDeath(long time)

Specified by:

setTimeOfDeath in interface DeadBody

setSavedMOB

public void setSavedMOB(MOB mob)

Specified by:

setSavedMOB in interface DeadBody

savedMOB

public MOB savedMOB()

Specified by:

savedMOB in interface DeadBody

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 StdContainer

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

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 StdContainer

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