Package com.planet_ink.coffee_mud.Exits.interfaces

Interface Exit

All Superinterfaces:

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

All Known Subinterfaces:

PrepositionExit

All Known Implementing Classes:

AjarDoor, ClimbableExit, Door, FlyingExit, GapExit, Gate, GenAirLock, GenBoardable, GenCaravan, GenCastle, GenClanCastle, GenCurtain, GenDoor, GenExit, GenGrapples, GenMobilePortal, GenNavigableBoardable, GenPortal, GenSailingShip, GenSiegableBoardable, GenSpaceShip, Grate, HiddenClosedDoorway, HiddenWalkway, Impassable, LockedDoor, LockedGate, NamedRedirectable, NeedleDoor, Open, OpenDescriptable, OpenNameable, OpenPrepositional, PitOpen, Skyway, StdBoardable, StdClosedDoorway, StdExit, StdGrapples, StdLockedDoorway, StdNavigableBoardable, StdOpenDoorway, StdPortal, StdPortalWrapper, StdSiegableBoardable, TrappedDoor, TrappedLockedDoor, UnseenWalkway

public interface Exit
extends PhysicalAgent, Readable, CloseableLockable

An interface for all mechanisms or pathways through which a mob may travel when trying to get from one Room to another.

See Also:

Room

Field Summary

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

idConverter

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

Method Summary

Modifier and Type	Method	Description
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.
java.lang.String	doorName()	Returns the short name of this door, e.g.
short	exitUsage(short change)	Both reads and optionally modifies an internal reference counter for this exit.
Room	lastRoomUsedFrom(Room fromRoom)	Returns the very last room from or to which this exit was used.
java.lang.String	openWord()	Returns the verb used for describing opening this exit, e.g.
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	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.StringBuilder	viewableText(MOB mob, Room myRoom)	Returns the modified and qualified player-viewed description of this exit.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CloseableLockable

defaultsClosed, defaultsLocked, hasADoor, hasALock, isLocked, isOpen, keyName, openDelayTicks, setDoorsNLocks, setKeyName, setOpenDelayTicks

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable

expirationDate, setExpirationDate

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener

executeMsg, okMessage

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical

description, displayText, genericName, name

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable

isReadable, readableText, setReadable, setReadableText

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name, tick

Method Detail

exitUsage

short exitUsage(short change)

Both reads and optionally modifies an internal reference counter for this exit. Not currently functional.

Parameters:

change - 0 to make no change, or a positive or negative number

Returns:

the value of the usage counter after the change is applied

viewableText

java.lang.StringBuilder viewableText(MOB mob,
                                     Room myRoom)

Returns the modified and qualified player-viewed description of this exit.

Parameters:

mob - the mob doing the viewing

myRoom - the room from which the mob sees the exit

Returns:

the description of this exit from the given player pov

doorName

java.lang.String doorName()

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

Returns:

the short name of this door.

See Also:

setExitParams(String, String, String, String)

closeWord

java.lang.String closeWord()

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

Returns:

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

See Also:

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

openWord

java.lang.String openWord()

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

Returns:

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

See Also:

closeWord(), CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed(), setExitParams(String, String, String, String)

closedText

java.lang.String closedText()

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

Returns:

A description of this exit when closed.

See Also:

CloseableLockable.hasADoor(), CloseableLockable.defaultsClosed()

setExitParams

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.

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:

closeWord(), openWord(), doorName(), closedText()

temporaryDoorLink

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.

Returns:

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

See Also:

setTemporaryDoorLink(String)

setTemporaryDoorLink

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.

Parameters:

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

See Also:

temporaryDoorLink()

lastRoomUsedFrom

Room lastRoomUsedFrom(Room fromRoom)

Returns the very last room from or to which this exit was used.

Parameters:

fromRoom - the room from which a perspective is desired

Returns:

the last room that mattered to this exit