com.planet_ink.coffee_mud.Exits
Class GenExit

java.lang.Object
  com.planet_ink.coffee_mud.Exits.StdExit
      com.planet_ink.coffee_mud.Exits.GenExit

All Implemented Interfaces:

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

Direct Known Subclasses:

GenAirLock, GenDoor, Impassable

public class GenExit
extends StdExit

Field Summary

protected java.lang.String	closedText
protected java.lang.String	closeName
protected java.lang.String	description
protected java.lang.String	displayText
protected boolean	doorDefaultsClosed
protected boolean	doorDefaultsLocked
protected java.lang.String	doorName
protected boolean	hasADoor
protected boolean	hasALock
protected boolean	isReadable
protected java.lang.String	keyName
protected java.lang.String	name
protected int	openDelayTicks
protected java.lang.String	openName

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

GenExit()

Method Summary

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.
boolean	defaultsClosed() For exits with a door, this returns whether the door defaults in a closed state.
boolean	defaultsLocked() For exits with a door and lock, this returns whether the door 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.
java.lang.String	doorName() Returns the short name of this door, e.g.
boolean	hasADoor() Returns whether this exit has a door, and must be opened before being used.
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.
boolean	isGeneric() Whether the fields of this item are set in code, or set by builders.
boolean	isReadable() Returns whether this exit is readable when the player uses the READ command and targets it.
java.lang.String	keyName() For Exits with doors and locks, this returns the unique string representing the key code required to unlock/lock the door.
java.lang.String	Name() The raw unmodified name of this object as stored in the database.
int	openDelayTicks() Returns the number of ticks that this exit remains open when a mob or player changes it from a closed to an open state, and the door defaults in a closed state.
java.lang.String	openWord() Returns the verb used for describing opening this exit, e.g.
java.lang.String	readableText() For Exits that are readable, this returns the readable string for this exit.
void	setDescription(java.lang.String newDescription) Sets the basic description of this object, as shown when the item is directly LOOKed at.
void	setDisplayText(java.lang.String newDisplayText) Sets the raw string used to show what this object looks like in the room.
void	setDoorsNLocks(boolean newHasADoor, boolean newIsOpen, boolean newDefaultsClosed, boolean newHasALock, boolean newIsLocked, boolean newDefaultsLocked) Modifies the various door/lock settings for this exit.
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	setKeyName(java.lang.String newKeyName) For Exits with doors and locks, this sets the unique string representing the key code required to unlock/lock the door.
void	setMiscText(java.lang.String newText) For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
void	setName(java.lang.String newName) Sets the raw unmodified name of this object as stored in the database.
void	setOpenDelayTicks(int numTicks) Sets the number of ticks that this exit will remain open when a mob or player changes it from a closed to an open state, and the door defaults in a closed state.
void	setReadable(boolean isTrue) Returns whether this exit is readable when the player uses the READ command and targets it.
void	setReadableText(java.lang.String text) For Exits that are readable, this set the readable string for 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.
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.String	text() For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.

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

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, amDestroyed, baseEnvStats, cloneFix, 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, isLocked, isOpen, isStat, maxRange, minRange, miscTextFormat, mountLadder, name, newInstance, numBehaviors, numEffects, numScripts, okMessage, openWordPastTense, rawImage, recoverEnvStats, sameAs, savable, setBaseEnvStats, setExpirationDate, setImage, setStat, tick, viewableText

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

description

protected java.lang.String description

displayText

protected java.lang.String displayText

closedText

protected java.lang.String closedText

doorName

protected java.lang.String doorName

closeName

protected java.lang.String closeName

openName

protected java.lang.String openName

hasADoor

protected boolean hasADoor

doorDefaultsClosed

protected boolean doorDefaultsClosed

hasALock

protected boolean hasALock

doorDefaultsLocked

protected boolean doorDefaultsLocked

isReadable

protected boolean isReadable

openDelayTicks

protected int openDelayTicks

keyName

protected java.lang.String keyName

Constructor Detail

GenExit

public GenExit()

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 StdExit

Returns:

the name of this class

isGeneric

public boolean isGeneric()

Description copied from interface: Environmental

Whether the fields of this item are set in code, or set by builders. Generic means that they are set by builders, in which case XML is returned by the text() method containing all of the values for all the fields.

Specified by:

isGeneric in interface Environmental

Overrides:

isGeneric in class StdExit

Returns:

whether this item is modifiable by builders

See Also:

Environmental.text()

text

public java.lang.String text()

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

text in interface Environmental

Overrides:

text in class StdExit

Returns:

either an open internal text string, or XML

setMiscText

public void setMiscText(java.lang.String newText)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class StdExit

Parameters:

newText - either an open internal text string, or XML

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:

Environmental.name()

setName

public void setName(java.lang.String newName)

Description copied from interface: Environmental

Sets 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:

setName in interface Environmental

Overrides:

setName in class StdExit

Parameters:

newName - the raw base name of this object on the map.

See Also:

Environmental.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

setDisplayText

public void setDisplayText(java.lang.String newDisplayText)

Description copied from interface: Environmental

Sets 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:

setDisplayText in interface Environmental

Overrides:

setDisplayText in class StdExit

Parameters:

newDisplayText - 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

setDescription

public void setDescription(java.lang.String newDescription)

Description copied from interface: Environmental

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

Specified by:

setDescription in interface Environmental

Overrides:

setDescription in class StdExit

Parameters:

newDescription - the basic detail description of this object

hasADoor

public boolean hasADoor()

Description copied from interface: Exit

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

Specified by:

hasADoor in interface Exit

Overrides:

hasADoor in class StdExit

Returns:

true if a door is present, false otherwise.

See Also:

Exit.isOpen(), Exit.isLocked()

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 StdExit

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 StdExit

Returns:

true if defaults closed and locked, false otherwise

See Also:

Exit.hasADoor(), Exit.defaultsClosed()

defaultsClosed

public boolean defaultsClosed()

Description copied from interface: Exit

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

Specified by:

defaultsClosed in interface Exit

Overrides:

defaultsClosed in class StdExit

Returns:

true if defaults closed, false otherwise

See Also:

Exit.hasADoor(), Exit.defaultsLocked()

setDoorsNLocks

public void setDoorsNLocks(boolean newHasADoor,
                           boolean newIsOpen,
                           boolean newDefaultsClosed,
                           boolean newHasALock,
                           boolean newIsLocked,
                           boolean newDefaultsLocked)

Description copied from interface: Exit

Modifies the various door/lock settings for this exit.

Specified by:

setDoorsNLocks in interface Exit

Overrides:

setDoorsNLocks in class StdExit

Parameters:

newHasADoor - whether this exit has a door

newIsOpen - whether this exit is open for travel

newDefaultsClosed - whether this exit defaults closed

newHasALock - whether this exit has a door lock

newIsLocked - whether this exit is presently locked

newDefaultsLocked - whether this exit defaults closed and locked.

See Also:

Exit.isOpen(), Exit.isLocked(), Exit.hasADoor(), Exit.hasALock(), Exit.defaultsClosed(), Exit.defaultsLocked()

isReadable

public boolean isReadable()

Description copied from interface: Exit

Returns whether this exit is readable when the player uses the READ command and targets it.

Specified by:

isReadable in interface Exit

Overrides:

isReadable in class StdExit

Returns:

true if the exit is readable.

See Also:

Exit.readableText(), Exit.setReadable(boolean), Exit.setReadableText(String)

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)

closeWord

public java.lang.String closeWord()

Description copied from interface: Exit

Returns the verb used for describing closing this exit, e.g. close, lower, drop, etc..

Specified by:

closeWord in interface Exit

Overrides:

closeWord in class StdExit

Returns:

the short name of a verb used when closing this door.

See Also:

Exit.openWord(), Exit.hasADoor(), Exit.defaultsClosed(), Exit.setExitParams(String, String, String, String)

openWord

public java.lang.String openWord()

Description copied from interface: Exit

Returns the verb used for describing opening this exit, e.g. open, raise, lift, etc..

Specified by:

openWord in interface Exit

Overrides:

openWord in class StdExit

Returns:

the short name of a verb used when opening this door.

See Also:

Exit.closeWord(), Exit.hasADoor(), Exit.defaultsClosed(), 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 StdExit

Returns:

A description of this exit when closed.

See Also:

Exit.hasADoor(), Exit.defaultsClosed()

setExitParams

public void setExitParams(java.lang.String newDoorName,
                          java.lang.String newCloseWord,
                          java.lang.String newOpenWord,
                          java.lang.String newClosedText)

Description copied from interface: Exit

Sets various word descriptions used when doing some dynamic manipulations of this exit.

Specified by:

setExitParams in interface Exit

Overrides:

setExitParams in class StdExit

Parameters:

newDoorName - short name of this door, e.g. door, gate

newCloseWord - verb used to close this door, e.g. close, lower

newOpenWord - verb used to open this door, e.g. open, raise

newClosedText - description of this exit when in a closed state

See Also:

Exit.closeWord(), Exit.openWord(), Exit.doorName(), Exit.closedText()

readableText

public java.lang.String readableText()

Description copied from interface: Exit

For Exits that are readable, this returns the readable string for this exit. That is to say, what the player sees when they read the door.

Specified by:

readableText in interface Exit

Overrides:

readableText in class StdExit

Returns:

the readable string

See Also:

Exit.isReadable(), Exit.setReadable(boolean), Exit.setReadableText(String)

setReadable

public void setReadable(boolean isTrue)

Description copied from interface: Exit

Returns whether this exit is readable when the player uses the READ command and targets it. Readable text should also be set or unset.

Specified by:

setReadable in interface Exit

Overrides:

setReadable in class StdExit

Parameters:

isTrue - true if the exit is readable, and false otherwise

See Also:

Exit.readableText(), Exit.isReadable(), Exit.setReadableText(String)

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Exit

For Exits that are readable, this set the readable string for this exit. That is to say, what the player sees when they read the door.

Specified by:

setReadableText in interface Exit

Overrides:

setReadableText in class StdExit

Parameters:

text - the readable text

See Also:

Exit.isReadable(), Exit.setReadable(boolean), Exit.readableText()

keyName

public java.lang.String keyName()

Description copied from interface: Exit

For Exits with doors and locks, this returns the unique string representing the key code required to unlock/lock the door.

Specified by:

keyName in interface Exit

Overrides:

keyName in class StdExit

Returns:

the key code

See Also:

Exit.setKeyName(String)

setKeyName

public void setKeyName(java.lang.String newKeyName)

Description copied from interface: Exit

For Exits with doors and locks, this sets the unique string representing the key code required to unlock/lock the door.

Specified by:

setKeyName in interface Exit

Overrides:

setKeyName in class StdExit

Parameters:

newKeyName - the new key code

See Also:

Exit.keyName()

openDelayTicks

public int openDelayTicks()

Description copied from interface: Exit

Returns the number of ticks that this exit remains open when a mob or player changes it from a closed to an open state, and the door defaults in a closed state.

Specified by:

openDelayTicks in interface Exit

Overrides:

openDelayTicks in class StdExit

Returns:

the number of ticks this exit remains open

See Also:

Exit.setOpenDelayTicks(int), Tickable.TICKID_EXIT_REOPEN

setOpenDelayTicks

public void setOpenDelayTicks(int numTicks)

Description copied from interface: Exit

Sets the number of ticks that this exit will remain open when a mob or player changes it from a closed to an open state, and the door defaults in a closed state.

Specified by:

setOpenDelayTicks in interface Exit

Overrides:

setOpenDelayTicks in class StdExit

Parameters:

numTicks - the number of ticks this exit will remain open

See Also:

Exit.openDelayTicks(), Tickable.TICKID_EXIT_REOPEN

temporaryDoorLink

public java.lang.String temporaryDoorLink()

Description copied from interface: Exit

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.

Specified by:

temporaryDoorLink in interface Exit

Overrides:

temporaryDoorLink in class StdExit

Returns:

the room id of the room that will be linked in later

See Also:

Exit.setTemporaryDoorLink(String)

setTemporaryDoorLink

public void setTemporaryDoorLink(java.lang.String link)

Description copied from interface: Exit

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.

Specified by:

setTemporaryDoorLink in interface Exit

Overrides:

setTemporaryDoorLink in class StdExit

Parameters:

link - the room id of the room that will be linked in later

See Also:

Exit.temporaryDoorLink()