Package com.planet_ink.coffee_mud.Exits

Class StdClosedDoorway

java.lang.Object

com.planet_ink.coffee_mud.Exits.StdExit

com.planet_ink.coffee_mud.Exits.StdClosedDoorway

All Implemented Interfaces:

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

Direct Known Subclasses:

Door, Gate, Grate, HiddenClosedDoorway, NeedleDoor, StdLockedDoorway, TrappedDoor

public class StdClosedDoorway
extends StdExit

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
StdClosedDoorway()

Method Summary

Modifier and Type	Method	Description
java.lang.String	closedText()	Returns a text description of what this exit looks like when closed.
boolean	defaultsClosed()	For exits with a door, this returns whether this defaults in a closed state.
boolean	defaultsLocked()	For exits with a door and lock, this returns whether this defaults in a closed and locked state.
java.lang.String	description()	The basic description of this object, as shown when the item is directly LOOKed at.
java.lang.String	displayText()	Gets the raw string used to show what this object looks like in the room.
boolean	hasADoor()	Returns whether this has a door, and must be opened before being used.
boolean	hasALock()	Returns whether this has a lock on it, 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.
java.lang.String	Name()	The raw unmodified name of this object as stored in the database.

Methods inherited from class java.lang.Object

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

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, doorName, eachBehavior, eachEffect, eachScript, effects, executeMsg, exitUsage, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, genericName, 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

Constructor Detail

StdClosedDoorway

public StdClosedDoorway()

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 StdExit

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 StdExit

Returns:

the raw base name of this object on the map.

See Also:

Tickable.name()

displayText

public java.lang.String displayText()

Description copied from interface: Environmental

Gets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

displayText in interface Environmental

Overrides:

displayText in class StdExit

Returns:

the string describing how this object looks in the room

description

public java.lang.String description()

Description copied from interface: Environmental

The basic description of this object, as shown when the item is directly LOOKed at.

Specified by:

description in interface Environmental

Overrides:

description in class StdExit

Returns:

the basic detail description of this object

hasADoor

public boolean hasADoor()

Description copied from interface: CloseableLockable

Returns whether this has a door, and must be opened before being used.

Specified by:

hasADoor in interface CloseableLockable

Overrides:

hasADoor in class StdExit

Returns:

true if a door is present, false otherwise.

See Also:

CloseableLockable.isOpen(), CloseableLockable.isLocked()

hasALock

public boolean hasALock()

Description copied from interface: CloseableLockable

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

Specified by:

hasALock in interface CloseableLockable

Overrides:

hasALock in class StdExit

Returns:

whether a lock is present

See Also:

CloseableLockable.isOpen(), CloseableLockable.isLocked(), CloseableLockable.hasADoor()

defaultsLocked

public boolean defaultsLocked()

Description copied from interface: CloseableLockable

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

Specified by:

defaultsLocked in interface CloseableLockable

Overrides:

defaultsLocked in class StdExit

Returns:

true if defaults closed and locked, false otherwise

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed()

defaultsClosed

public boolean defaultsClosed()

Description copied from interface: CloseableLockable

For exits with a door, this returns whether this defaults in a closed state.

Specified by:

defaultsClosed in interface CloseableLockable

Overrides:

defaultsClosed in class StdExit

Returns:

true if defaults closed, false otherwise

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsLocked()

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 StdExit

Returns:

A description of this exit when closed.

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed()