com.planet_ink.coffee_mud.Exits
Class Gate

java.lang.Object
  com.planet_ink.coffee_mud.Exits.StdExit
      com.planet_ink.coffee_mud.Exits.StdClosedDoorway
          com.planet_ink.coffee_mud.Exits.Gate

All Implemented Interfaces:

Affectable, Behavable, CloseableLockable, CMObject, Contingent, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, StatsAffecting, Tickable, Exit, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

LockedGate

public class Gate
extends StdClosedDoorway

Field Summary

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

Gate()

Method Summary

java.lang.String	closedText() Returns a text description of what this exit looks like when closed.
java.lang.String	doorName() Returns the short name of this door, e.g.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	Name() The raw unmodified name of this object as stored in the database.

Methods inherited from class com.planet_ink.coffee_mud.Exits.StdClosedDoorway

defaultsClosed, defaultsLocked, description, displayText, hasADoor, hasALock

Methods inherited from class com.planet_ink.coffee_mud.Exits.StdExit

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amDestroyed, basePhyStats, behaviors, cloneFix, closeWord, closeWordPastTense, compareTo, copyOf, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, destroy, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, exitUsage, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isLocked, isOpen, isReadable, isSavable, isStat, keyName, L, lastRoomUsedFrom, maxRange, minRange, miscTextFormat, name, name, newInstance, numBehaviors, numEffects, numScripts, okMessage, openDelayTicks, openWord, openWordPastTense, phyStats, rawImage, readableText, recoverPhyStats, sameAs, scripts, setBasePhyStats, setDescription, setDisplayText, setDoorsNLocks, setExitParams, setExpirationDate, setImage, setKeyName, setMiscText, setName, setOpenDelayTicks, setReadable, setReadableText, setSavable, setStat, setTemporaryDoorLink, temporaryDoorLink, text, tick, viewableText

Methods inherited from class java.lang.Object

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

Constructor Detail

Gate

public Gate()

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 StdClosedDoorway

Returns:

the name of this class

Name

public java.lang.String Name()

Description copied from interface: Environmental

The raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

Name in interface Environmental

Overrides:

Name in class StdClosedDoorway

Returns:

the raw base name of this object on the map.

See Also:

Tickable.name()

doorName

public java.lang.String doorName()

Description copied from interface: Exit

Returns the short name of this door, e.g. gate, door, portal, etc..

Specified by:

doorName in interface Exit

Overrides:

doorName in class StdExit

Returns:

the short name of this door.

See Also:

Exit.setExitParams(String, String, String, String)

closedText

public java.lang.String closedText()

Description copied from interface: Exit

Returns a text description of what this exit looks like when closed.

Specified by:

closedText in interface Exit

Overrides:

closedText in class StdClosedDoorway

Returns:

A description of this exit when closed.

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed()