com.planet_ink.coffee_mud.Items.interfaces
Interface DeadBody

All Superinterfaces:

Affectable, Behavable, java.lang.Cloneable, CloseableLockable, CMObject, java.lang.Comparable<CMObject>, Container, Contingent, DBIdentifiable, Environmental, Item, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Wearable

All Known Implementing Classes:

Corpse, GenCorpse

public interface DeadBody
extends Container

Represents a player or monster corpse, dead body, a stiff. Most of the methods either allow interesting details about the original spirit to be divined, or the player stuff to be protected.

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

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_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

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.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, 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_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Method Summary

CharStats	charStats() Returns the collection of character stats about the deceased mob.
java.lang.String	getKillerName() Gets the name of the mob that killed the deceased mob whose corpse this is.
Environmental	getKillerTool() Gets the weapon wielded by the killer at the time of death of the deceased mob.
java.lang.String	getLastMessage() Gets the last message seen by the deceased mob whose corpse this is.
java.lang.String	getMobDescription() Gets the deceased's description.
int	getMobHash() Gets the hash that uniquely identifies the deceased mob object.
java.lang.String	getMobName() Gets the deceased's name.
boolean	getMobPKFlag() Gets whether the mob, whose corpse this is, had their PlayerKill flag on at the time of death, probably denoting a duel of some sort.
MOB	getSavedMOB() Gets the mob object belonging to the deceased.
long	getTimeOfDeath() Gets the real world time, in milliseconds, that the death of this corpse occurred.
boolean	isDestroyedAfterLooting() Gets whether this corpse is automatically destroyed by the system after it has been looted.
boolean	isKillerPlayer() Gets whether the mob who killed the deceased mob whose corpse this is was a player or a mob.
boolean	isPlayerCorpse() Gets whether the deceased mob whose corpse this is was a player.
void	setCharStats(CharStats newStats) Sets the collection of character stats about the deceased mob.
void	setIsDestroyAfterLooting(boolean truefalse) Sets whether this corpse is automatically destroyed by the system after it has been looted.
void	setIsKillerPlayer(boolean trueFalse) Sets whether the mob who killed the deceased mob whose corpse this is was a player or a mob.
void	setIsPlayerCorpse(boolean truefalse) Sets whether the deceased mob whose corpse this is was a player.
void	setKillerName(java.lang.String newName) Sets the name of the mob that killed the deceased mob whose corpse this is.
void	setKillerTool(Environmental tool) Sets the weapon wielded by the killer at the time of death of the deceased mob.
void	setLastMessage(java.lang.String lastMsg) Sets the last message seen by the deceased mob whose corpse this is.
void	setMobDescription(java.lang.String newDescription) Sets the deceased's description.
void	setMobHash(int newHash) Sets the hash that uniquely identifies the deceased mob object.
void	setMobName(java.lang.String newName) Sets the deceased's name.
void	setMobPKFlag(boolean truefalse) Sets whether the mob, whose corpse this is, had their PlayerKill flag on at the time of death, probably denoting a duel of some sort.
void	setSavedMOB(MOB mob, boolean preserve) Sets the mob object belonging to the deceased.
void	setTimeOfDeath(long time) Sets the real world time, in milliseconds, that the death of this corpse occurred.

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

canContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasContent, isInside, setCapacity, setContainTypes

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

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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.Physical

description, displayText, name

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.MsgListener

executeMsg, okMessage

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, ID, 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

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

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, 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.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

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

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

isReadable, readableText, setReadable, setReadableText

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

defaultsClosed, defaultsLocked, hasADoor, hasALock, isLocked, isOpen, keyName, openDelayTicks, setDoorsNLocks, setKeyName, setOpenDelayTicks

Method Detail

charStats

CharStats charStats()

Returns the collection of character stats about the deceased mob. This is stuff like strength and race.

Returns:

the collection of character stats

See Also:

CharStats, setCharStats(CharStats)

setCharStats

void setCharStats(CharStats newStats)

Sets the collection of character stats about the deceased mob. This is stuff like strength and race.

Parameters:

newStats - the collection of character stats

See Also:

CharStats, charStats()

getMobName

java.lang.String getMobName()

Gets the deceased's name. Not the display name of the corpse, but the original dudes plain old name.

Returns:

the deceased's name

See Also:

setMobName(String)

setMobName

void setMobName(java.lang.String newName)

Sets the deceased's name. Not the display name of the corpse, but the original dudes plain old name.

Parameters:

newName - the deceased's name

See Also:

getMobName()

getMobHash

int getMobHash()

Gets the hash that uniquely identifies the deceased mob object.

Returns:

hash that uniquely identifies the deceased mob object.

See Also:

setMobHash(int)

setMobHash

void setMobHash(int newHash)

Sets the hash that uniquely identifies the deceased mob object.

Parameters:

newHash - hash that uniquely identifies the deceased mob object.

See Also:

setMobHash(int)

getMobDescription

java.lang.String getMobDescription()

Gets the deceased's description. Not the display name of the corpse, but the original dudes description text.

Returns:

the deceased's description

See Also:

setMobDescription(String)

setMobDescription

void setMobDescription(java.lang.String newDescription)

Sets the deceased's description. Not the display name of the corpse, but the original dudes description text.

Parameters:

newDescription - the deceased's description

See Also:

getMobDescription()

getKillerName

java.lang.String getKillerName()

Gets the name of the mob that killed the deceased mob whose corpse this is.

Returns:

the name of the mob that killed the deceased mob whose corpse this is.

See Also:

setKillerName(String)

setKillerName

void setKillerName(java.lang.String newName)

Sets the name of the mob that killed the deceased mob whose corpse this is.

Parameters:

newName - the name of the mob that killed the deceased mob whose corpse this is.

See Also:

setKillerName(String)

isKillerPlayer

boolean isKillerPlayer()

Gets whether the mob who killed the deceased mob whose corpse this is was a player or a mob.

Returns:

true if the killer was a player, false otherwise

See Also:

setIsKillerPlayer(boolean)

setIsKillerPlayer

void setIsKillerPlayer(boolean trueFalse)

Sets whether the mob who killed the deceased mob whose corpse this is was a player or a mob.

Parameters:

trueFalse - true if the killer was a player, false otherwise

See Also:

isKillerPlayer()

getLastMessage

java.lang.String getLastMessage()

Gets the last message seen by the deceased mob whose corpse this is. Usually this would be the killing blow.

Returns:

the last message seen by the deceased mob whose corpse this is

See Also:

setLastMessage(String)

setLastMessage

void setLastMessage(java.lang.String lastMsg)

Sets the last message seen by the deceased mob whose corpse this is. Usually this would be the killing blow.

Parameters:

lastMsg - the last message seen by the deceased mob whose corpse this is

See Also:

getLastMessage()

getKillerTool

Environmental getKillerTool()

Gets the weapon wielded by the killer at the time of death of the deceased mob.

Returns:

the weapon wielded by the killer at the time of death of the deceased mob.

See Also:

setKillerTool(Environmental)

setKillerTool

void setKillerTool(Environmental tool)

Sets the weapon wielded by the killer at the time of death of the deceased mob.

Parameters:

tool - the weapon wielded by the killer at the time of death of the deceased mob.

See Also:

getKillerTool()

isDestroyedAfterLooting

boolean isDestroyedAfterLooting()

Gets whether this corpse is automatically destroyed by the system after it has been looted.

Returns:

true to destroy after looting, false otherwise

See Also:

setIsDestroyAfterLooting(boolean)

setIsDestroyAfterLooting

void setIsDestroyAfterLooting(boolean truefalse)

Sets whether this corpse is automatically destroyed by the system after it has been looted.

Parameters:

truefalse - true to destroy after looting, false otherwise

See Also:

isDestroyedAfterLooting()

isPlayerCorpse

boolean isPlayerCorpse()

Gets whether the deceased mob whose corpse this is was a player.

Returns:

true if the deceased was a player, false if a mob

See Also:

setIsPlayerCorpse(boolean)

setIsPlayerCorpse

void setIsPlayerCorpse(boolean truefalse)

Sets whether the deceased mob whose corpse this is was a player.

Parameters:

truefalse - true if the deceased was a player, false if a mob

See Also:

isPlayerCorpse()

getMobPKFlag

boolean getMobPKFlag()

Gets whether the mob, whose corpse this is, had their PlayerKill flag on at the time of death, probably denoting a duel of some sort.

Returns:

true if the mob had their PK flag on, false otherwise

See Also:

setMobPKFlag(boolean)

setMobPKFlag

void setMobPKFlag(boolean truefalse)

Sets whether the mob, whose corpse this is, had their PlayerKill flag on at the time of death, probably denoting a duel of some sort.

Parameters:

truefalse - true if the mob had their PK flag on, false otherwise

See Also:

getMobPKFlag()

getTimeOfDeath

long getTimeOfDeath()

Gets the real world time, in milliseconds, that the death of this corpse occurred.

Returns:

the time, in milliseconds, of death

See Also:

setTimeOfDeath(long)

setTimeOfDeath

void setTimeOfDeath(long time)

Sets the real world time, in milliseconds, that the death of this corpse occurred.

Parameters:

time - the time, in milliseconds, of death

See Also:

getTimeOfDeath()

setSavedMOB

void setSavedMOB(MOB mob,
                 boolean preserve)

Sets the mob object belonging to the deceased.

Parameters:

mob - the mob object belonging to the deceased.

preserve - TODO

See Also:

getSavedMOB()

getSavedMOB

MOB getSavedMOB()

Gets the mob object belonging to the deceased.

Returns:

the mob object belonging to the deceased.

See Also:

setSavedMOB(MOB, boolean)