com.planet_ink.coffee_mud.Exits
Class Impassable

java.lang.Object
  extended by com.planet_ink.coffee_mud.Exits.StdExit
      extended by com.planet_ink.coffee_mud.Exits.GenExit
          extended by com.planet_ink.coffee_mud.Exits.Impassable
All Implemented Interfaces:
Affectable, Behavable, CloseableLockable, CMObject, Contingent, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, StatsAffecting, Tickable, Exit, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Impassable
extends GenExit


Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Exits.GenExit
closedText, closeName, description, displayText, doorDefaultsClosed, doorDefaultsLocked, doorName, hasADoor, hasALock, isReadable, keyName, name, openDelayTicks, openName
 
Fields inherited from class com.planet_ink.coffee_mud.Exits.StdExit
affectPhyStats, affects, amDestroyed, basePhyStats, behaviors, cachedImageName, isLocked, isOpen, lastRoomID, me, miscText, phyStats, rawImageName, scripts, usage
 
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
 
Constructor Summary
Impassable()
           
 
Method Summary
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 boolean okMessage(Environmental myHost, CMMsg msg)
          The general message event previewer for the object.
 
Methods inherited from class com.planet_ink.coffee_mud.Exits.GenExit
closedText, closeWord, defaultsClosed, defaultsLocked, description, displayText, doorName, getCodeNum, getSaveStatIndex, getStat, getStatCodes, hasADoor, hasALock, isGeneric, isReadable, isStat, keyName, Name, openDelayTicks, openWord, readableText, sameAs, setDescription, setDisplayText, setDoorsNLocks, setExitParams, setKeyName, setMiscText, setName, setOpenDelayTicks, setReadable, setReadableText, setStat, setTemporaryDoorLink, temporaryDoorLink, text
 
Methods inherited from class com.planet_ink.coffee_mud.Exits.StdExit
addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amDestroyed, basePhyStats, behaviors, cloneFix, closeWordPastTense, compareTo, copyOf, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, destroy, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, exitUsage, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, getTickStatus, image, initializeClass, isLocked, isOpen, isSavable, L, lastRoomUsedFrom, maxRange, minRange, miscTextFormat, name, name, newInstance, numBehaviors, numEffects, numScripts, openWordPastTense, phyStats, rawImage, recoverPhyStats, scripts, setBasePhyStats, setExpirationDate, setImage, setSavable, tick, viewableText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Impassable

public Impassable()
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 GenExit
Returns:
the name of this class

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