|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Environmental
The core of most object types in CoffeeMud. Much of the most common fields and data are derived from this.
| Field Summary |
|---|
| Method Summary | |
|---|---|
boolean |
amDestroyed()
Whether the destroy() method has been previousy called on this object. |
java.lang.String |
description()
The basic description of this object, as shown when the item is directly LOOKed at. |
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. |
java.lang.String |
displayText()
Gets the raw string used to show what this object looks like in the room. |
long |
expirationDate()
If this object expires, it should have a timestamp saying when it expires, in real time. |
java.lang.String |
image()
Returns the fully qualified and determined name of the image file displayed for this object when MXP is used. |
boolean |
isGeneric()
Whether the fields of this item are set in code, or set by builders. |
int |
maxRange()
the maximum range of this object, if applicable. |
int |
minRange()
the minimum range of this object, if applicable. |
java.lang.String |
miscTextFormat()
Unimplemented as of yet, but will hold a string telling the system what the proper format of any miscText data. |
java.lang.String |
name()
The displayable name of this object. |
java.lang.String |
Name()
The raw unmodified name of this object as stored in the database. |
java.lang.String |
rawImage()
Returns the raw name of the image file to display for this object when MXP is used. |
boolean |
sameAs(Environmental E)
Whether this object instance is functionally identical to the object passed in. |
boolean |
savable()
Whether, if this object is in a room, whether it is appropriate to save this object to the database as a permanent feature of its container. |
void |
setDescription(java.lang.String newDescription)
Sets the basic description of this object, as shown when the item is directly LOOKed at. |
void |
setDisplayText(java.lang.String newDisplayText)
Sets the raw string used to show what this object looks like in the room. |
void |
setExpirationDate(long dateTime)
If this object expires, it should have a timestamp saying when it expires, in real time. |
void |
setImage(java.lang.String newImage)
Sets the raw name of the image file to display for this object when MXP is used. |
void |
setMiscText(java.lang.String newMiscText)
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 |
setName(java.lang.String newName)
Sets the raw unmodified name of this object as stored in the database. |
java.lang.String |
text()
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. |
| Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable |
|---|
getTickStatus, tick |
| 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.Affectable |
|---|
addEffect, addNonUninvokableEffect, baseEnvStats, delEffect, envStats, fetchEffect, fetchEffect, numEffects, recoverEnvStats, setBaseEnvStats |
| Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting |
|---|
affectCharState, affectCharStats, affectEnvStats |
| 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.CMModifiable |
|---|
getSaveStatIndex, getStat, getStatCodes, isStat, setStat |
| Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable |
|---|
addBehavior, addScript, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts |
| Method Detail |
|---|
java.lang.String name()
name in interface TickableName()java.lang.String Name()
name()void setName(java.lang.String newName)
newName - the raw base name of this object on the map.Name()java.lang.String displayText()
void setDisplayText(java.lang.String newDisplayText)
newDisplayText - the string describing how this object looks in the roomjava.lang.String description()
void setDescription(java.lang.String newDescription)
newDescription - the basic detail description of this objectvoid destroy()
boolean savable()
boolean amDestroyed()
java.lang.String image()
java.lang.String rawImage()
void setImage(java.lang.String newImage)
newImage - the raw name of the mxp image fileboolean isGeneric()
text()void setMiscText(java.lang.String newMiscText)
newMiscText - either an open internal text string, or XMLjava.lang.String text()
java.lang.String miscTextFormat()
CMParms,
text(),
setMiscText(String)boolean sameAs(Environmental E)
E - the object to compare this one to
CMModifiable.getStatCodes(),
CMModifiable.getStat(String)long expirationDate()
setExpirationDate(long)void setExpirationDate(long dateTime)
dateTime - the time stamp when this thing expiresexpirationDate()int maxRange()
int minRange()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||