Affectable, Behavable, CloseableLockable, CMObject, CMObjectWrapper, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rideable, Rider, StatsAffecting, Tickable, Exit, Container, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>public class StdPortalWrapper extends StdRideableWrapper implements Item, Container, Rideable, Exit, CMObjectWrapper
Rideable.BasisWearable.CODES| Modifier and Type | Field | Description |
|---|---|---|
protected Exit |
exit |
idConverterCONTAIN_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_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDScontaineramDestroyed, basePhyStats, isSavable, item, myContainer, owner, ridingrideableDEFAULT_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| Constructor | Description |
|---|---|
StdPortalWrapper() |
| Modifier and Type | Method | Description |
|---|---|---|
java.lang.String |
closedText() |
Returns a text description of what this exit looks like when closed.
|
java.lang.String |
closeWord() |
Returns the verb used for describing closing this exit, e.g.
|
java.lang.String |
doorName() |
Returns the short name of this door, e.g.
|
short |
exitUsage(short change) |
Both reads and optionally modifies an internal reference counter for this
exit.
|
java.lang.String |
ID() |
The CoffeeMud Java Class ID shared by all instances of
this object.
|
Room |
lastRoomUsedFrom(Room fromRoom) |
Returns the very last room from or to which this exit was used.
|
CMObject |
newInstance() |
Returns a new instance of this class.
|
java.lang.String |
openWord() |
Returns the verb used for describing opening this exit, e.g.
|
void |
setExitParams(java.lang.String newDoorName,
java.lang.String newCloseWord,
java.lang.String newOpenWord,
java.lang.String newClosedText) |
Sets various word descriptions used when doing some dynamic manipulations
of this exit.
|
void |
setTemporaryDoorLink(java.lang.String link) |
If this exit represents a route to a room not yet created, but whose room id
is already known, this will set that designated room id.
|
void |
setWrappedObject(CMObject obj) |
Set the object wrapped by this one.
|
java.lang.String |
temporaryDoorLink() |
If this exit represents a route to a room not yet created, but whose room id
is already known, this will return that designated room id.
|
java.lang.StringBuilder |
viewableText(MOB mob,
Room myRoom) |
Returns the modified and qualified player-viewed description of this exit.
|
addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scriptsdefaultsClosed, defaultsLocked, hasADoor, hasALock, isLocked, isOpen, keyName, openDelayTicks, setDoorsNLocks, setKeyName, setOpenDelayTickscopyOf, initializeClassgetWrappedObjectcanContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasContent, isInside, setCapacity, setContainTypescanSaveDatabaseID, databaseID, setDatabaseIDbaseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, valueclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisReadable, readableText, setReadable, setReadableTextaddRider, amRiding, delRider, dismountString, fetchRider, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, isMobileRideBasis, mobileRideBasis, mountString, numRiders, putString, rideBasis, riderCapacity, riders, rideString, setDismountString, setMountString, setPutString, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, stateString, stateStringSubjectcanContain, capacity, containTypes, defaultsClosed, defaultsLocked, emptyPlease, getContents, getDeepContents, hasADoor, hasALock, hasContent, isInside, isLocked, isOpen, keyName, openDelayTicks, setCapacity, setContainTypes, setDoorsNLocks, setKeyName, setOpenDelayTicksaddBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, genericName, getSaveStatIndex, getStat, getStatCodes, getTickStatus, getWrappedObject, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, numBehaviors, numberOfItems, numEffects, numScripts, okMessage, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWearaddRider, amRiding, delRider, dismountString, fetchRider, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, isMobileRideBasis, mobileRideBasis, mountString, numRiders, putString, rideBasis, riderCapacity, riders, rideString, setDismountString, setMountString, setPutString, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, stateString, stateStringSubjectamBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWearprotected Exit exit
public java.lang.String ID()
CMObjectID in interface CMObjectID in class StdRideableWrapperpublic void setWrappedObject(CMObject obj)
CMObjectWrappersetWrappedObject in interface CMObjectWrappersetWrappedObject in class StdRideableWrapperobj - the object to wrappublic CMObject newInstance()
CMObjectnewInstance in interface CMObjectnewInstance in class StdRideableWrapperpublic short exitUsage(short change)
Exitpublic java.lang.StringBuilder viewableText(MOB mob, Room myRoom)
ExitviewableText in interface Exitmob - the mob doing the viewingmyRoom - the room from which the mob sees the exitpublic java.lang.String doorName()
ExitdoorName in interface ExitExit.setExitParams(String, String, String, String)public java.lang.String closeWord()
ExitcloseWord in interface ExitExit.openWord(),
CloseableLockable.hasADoor(),
CloseableLockable.defaultsClosed(),
Exit.setExitParams(String, String, String, String)public java.lang.String openWord()
ExitopenWord in interface ExitExit.closeWord(),
CloseableLockable.hasADoor(),
CloseableLockable.defaultsClosed(),
Exit.setExitParams(String, String, String, String)public java.lang.String closedText()
ExitclosedText in interface ExitCloseableLockable.hasADoor(),
CloseableLockable.defaultsClosed()public void setExitParams(java.lang.String newDoorName,
java.lang.String newCloseWord,
java.lang.String newOpenWord,
java.lang.String newClosedText)
ExitsetExitParams in interface ExitnewDoorName - short name of this door, e.g. door, gatenewCloseWord - verb used to close this door, e.g. close, lowernewOpenWord - verb used to open this door, e.g. open, raisenewClosedText - description of this exit when in a closed stateExit.closeWord(),
Exit.openWord(),
Exit.doorName(),
Exit.closedText()public java.lang.String temporaryDoorLink()
ExittemporaryDoorLink in interface ExitExit.setTemporaryDoorLink(String)public void setTemporaryDoorLink(java.lang.String link)
ExitsetTemporaryDoorLink in interface Exitlink - the room id of the room that will be linked in laterExit.temporaryDoorLink()public Room lastRoomUsedFrom(Room fromRoom)
ExitlastRoomUsedFrom in interface ExitfromRoom - the room from which a perspective is desired