Package com.planet_ink.coffee_mud.Exits

Class OpenPrepositional

java.lang.Object

com.planet_ink.coffee_mud.Exits.StdExit

com.planet_ink.coffee_mud.Exits.StdOpenDoorway

com.planet_ink.coffee_mud.Exits.OpenPrepositional

All Implemented Interfaces:

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

public class OpenPrepositional
extends StdOpenDoorway
implements PrepositionExit

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
OpenPrepositional()

Method Summary

Modifier and Type	Method	Description
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	getEntryPreposition()	Returns the preposition phrase seen by entering this exit.
java.lang.String	getExitPreposition()	Returns the preposition phrase seen by leaving this exit.
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.
void	setEntryPreposition(java.lang.String phrase)	Sets the preposition phrase seen by entering this exit.
void	setExitPreposition(java.lang.String phrase)	Sets the preposition phrase seen by leaving this exit.
void	setMiscText(java.lang.String newMiscText)	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 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, 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

image, isGeneric, L, maxRange, minRange, miscTextFormat, rawImage, sameAs, setDescription, setDisplayText, setImage, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.Exits.interfaces.Exit

closedText, closeWord, doorName, exitUsage, lastRoomUsedFrom, openWord, setExitParams, setTemporaryDoorLink, temporaryDoorLink, viewableText

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 class java.lang.Object

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

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 class com.planet_ink.coffee_mud.Exits.StdExit

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amDestroyed, basePhyStats, behaviors, cloneFix, closedText, closeWord, closeWordPastTense, compareTo, copyOf, defaultsClosed, defaultsLocked, 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, hasADoor, hasALock, 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, setName, setOpenDelayTicks, setReadable, setReadableText, setSavable, setStat, setTemporaryDoorLink, temporaryDoorLink, text, tick, viewableText

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

getTickStatus, name, tick

Constructor Detail

OpenPrepositional

public OpenPrepositional()

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 StdOpenDoorway

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 StdOpenDoorway

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 StdOpenDoorway

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 StdOpenDoorway

Returns:

the basic detail description of this object

setMiscText

public void setMiscText(java.lang.String newMiscText)

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:

newMiscText - either an open internal text string, or XML

getEntryPreposition

public java.lang.String getEntryPreposition()

Description copied from interface: PrepositionExit

Returns the preposition phrase seen by entering this exit.

Specified by:

getEntryPreposition in interface PrepositionExit

Returns:

the preposition phrase seen by entering this exit.

See Also:

PrepositionExit.setEntryPreposition(String)

getExitPreposition

public java.lang.String getExitPreposition()

Description copied from interface: PrepositionExit

Returns the preposition phrase seen by leaving this exit.

Specified by:

getExitPreposition in interface PrepositionExit

Returns:

the preposition phrase seen by leaving this exit.

See Also:

PrepositionExit.setExitPreposition(String)

setEntryPreposition

public void setEntryPreposition(java.lang.String phrase)

Description copied from interface: PrepositionExit

Sets the preposition phrase seen by entering this exit.

Specified by:

setEntryPreposition in interface PrepositionExit

Parameters:

phrase - the preposition phrase seen by entering this exit.

See Also:

PrepositionExit.getEntryPreposition()

setExitPreposition

public void setExitPreposition(java.lang.String phrase)

Description copied from interface: PrepositionExit

Sets the preposition phrase seen by leaving this exit.

Specified by:

setExitPreposition in interface PrepositionExit

Parameters:

phrase - the preposition phrase seen by leaving this exit.

See Also:

PrepositionExit.getExitPreposition()