com.planet_ink.coffee_mud.Exits
Class LockedGate

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

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, MsgListener, StatsAffecting, Tickable, Exit, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class LockedGate
extends Gate

Field Summary

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

affects, amDestroyed, baseEnvStats, behaviors, envStats, imageName, isLocked, isOpen, miscText, 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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY, TICKS_PER_RLMIN, TIME_MILIS_PER_MUDHOUR, TIME_TICK, TIME_TICK_DOUBLE

Constructor Summary

LockedGate()

Method Summary

java.lang.String	closedText() Returns a text description of what this exit looks like when closed.
boolean	defaultsLocked() For exits with a door and lock, this returns whether the door defaults in a closed and locked state.
boolean	hasALock() Returns whether this exit has a lock on its door, and, if locked, must be unlocked before being used.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.

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

doorName, Name

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

defaultsClosed, description, displayText, hasADoor

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

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, amDestroyed, baseEnvStats, cloneFix, closeWord, closeWordPastTense, compareTo, copyOf, delBehavior, delEffect, delScript, destroy, envStats, executeMsg, exitUsage, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, findALadder, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isLocked, isOpen, isReadable, isStat, keyName, maxRange, minRange, miscTextFormat, mountLadder, name, newInstance, numBehaviors, numEffects, numScripts, okMessage, openDelayTicks, openWord, openWordPastTense, rawImage, readableText, recoverEnvStats, sameAs, savable, setBaseEnvStats, setDescription, setDisplayText, setDoorsNLocks, setExitParams, setExpirationDate, setImage, setKeyName, setMiscText, setName, setOpenDelayTicks, setReadable, setReadableText, setStat, setTemporaryDoorLink, temporaryDoorLink, text, tick, viewableText

Methods inherited from class java.lang.Object

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

Constructor Detail

LockedGate

public LockedGate()

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, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class Gate

Returns:

the name of this class

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 Gate

Returns:

A description of this exit when closed.

See Also:

Exit.hasADoor(), Exit.defaultsClosed()

hasALock

public boolean hasALock()

Description copied from interface: Exit

Returns whether this exit has a lock on its door, and, if locked, must be unlocked before being used.

Specified by:

hasALock in interface Exit

Overrides:

hasALock in class StdClosedDoorway

Returns:

whether a lock is present

See Also:

Exit.isOpen(), Exit.isLocked(), Exit.hasADoor()

defaultsLocked

public boolean defaultsLocked()

Description copied from interface: Exit

For exits with a door and lock, this returns whether the door defaults in a closed and locked state.

Specified by:

defaultsLocked in interface Exit

Overrides:

defaultsLocked in class StdClosedDoorway

Returns:

true if defaults closed and locked, false otherwise

See Also:

Exit.hasADoor(), Exit.defaultsClosed()