Package com.planet_ink.coffee_mud.Items.Basic

Class StdBoardable

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Basic.StdContainer

com.planet_ink.coffee_mud.Items.Basic.StdPortal

com.planet_ink.coffee_mud.Items.Basic.StdBoardable

All Implemented Interfaces:

Affectable, Behavable, CloseableLockable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, PrivateProperty, Readable, Rideable, Rider, StatsAffecting, Tickable, Exit, Boardable, Container, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenBoardable, StdSiegableBoardable

public class StdBoardable
extends StdPortal
implements PrivateProperty, Boardable

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rideable

Rideable.Basis

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected Area	area
protected java.lang.String	head_offTheDeck
protected java.lang.String	homePortID
protected int	internalPrice
protected java.lang.String	noun_word
protected java.lang.String	ownerName
protected int	price
protected java.lang.String	readableText

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Boardable

NAME_REPL_MARKERS, NAME_REPL_STRINGS

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

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_EATABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_RAWMATERIALS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SHIELDS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containType, defaultsClosed, defaultsLocked, hasALid, hasALock, isLocked, isOpen, openDelayTicks

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdPortal

closedText, dismountString, doorName, mountString, putString, rideString, stateString, stateSubjectStr, tempExitPairs

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

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
StdBoardable()

Method Summary

Modifier and Type	Method	Description
protected boolean	abilityImbuesMagic()
protected void	announceToAllAboard(java.lang.String msgStr)
protected void	announceToNonOuterViewers(MOB mob, java.lang.String msgStr)
protected void	announceToOuterViewers(CMMsg msg)
protected void	announceToOuterViewers(MOB mob, Environmental target, Environmental tool, java.lang.String msgStr)
protected void	announceToOuterViewers(MOB mob, java.lang.String msgStr)
protected void	announceToOuterViewers(java.lang.String msgStr)
protected boolean	canViewOuterRoom(Room R)
protected void	cleanMsgForRepeat(CMMsg msg)
protected boolean	confirmAreaMessage(CMMsg msg, boolean outerViewersOnly)
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
protected Room	createFirstRoom()
void	destroy()	Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
protected void	destroyThisBoardable()
java.lang.String	dismountString(Rider R)	Returns a string grammatically correct for the given rider when they are dismounting this Rideable
void	dockHere(Room R)	Designates that this ship is landed and docked in the given planetary room.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
long	expirationDate()	If this object expires, it should have a timestamp saying when it expires, in real time.
protected Room	findNearestDocks(Room R)
Area	getArea()	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
protected java.lang.String	getAreaClassType()
Item	getBoardableItem()	Ships are unique in having an Item stand-in for port-side access, as well as an Area object.
protected Room	getDestinationRoom(Room fromRoom)
java.lang.String	getHomePortID()	Returns the room ID of the ships home port.
Room	getIsDocked()	Returns the Room where this ship is docked, or NULL if in space.
java.lang.String	getOwnerName()	Get the owner of the property, usually a clan name or a player name.
int	getPrice()	The value of the property in base currency values
protected Room	getRandomOutsideRoom()
java.lang.String	getTitleID()	Returns a unique id for this particular title and the purchase-able lot it represents.
protected void	haveEveryoneLookOutside()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isProperlyOwned()	Returns whether the owner actually exists.
boolean	isSavable()	Whether, if this object is in a room, whether it is appropriate to save this object to the database as a permanent feature of its container.
java.lang.String	keyName()	For things with doors and locks, this returns the unique string representing the key code required to unlock/lock it.
java.lang.String	mountString(int commandType, Rider R)	Returns a string grammatically correct for the given rider when they are mounting this Rideable
CMObject	newInstance()	Returns a new instance of this class.
protected boolean	okAreaMessage(CMMsg msg, boolean outdoorOnly)
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
java.lang.String	putString(Rider R)	Returns a string grammatically correct for the given rider when they are putting something on this Rideable
java.lang.String	readableText()	For things that are readable, this returns the readable string for this thing.
void	rename(java.lang.String newName)	Renames the boardable to something else
protected void	renameDestinationRooms(java.lang.String from, java.lang.String to)
boolean	securityCheck(MOB mob)	Returns whether the given mob has control privileges for this boardable item
protected void	sendAreaMessage(CMMsg msg, boolean outerViewersOnly)
protected void	sendAreaMessage(MOB mob, CMMsg msg, boolean outerViewerStatus)
void	setArea(java.lang.String xml)	Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object.
void	setDatabaseID(java.lang.String id)	Set the unique contextual database ID for this object.
void	setDockableItem(Item dockableItem)	When a boardable ship area is created, it is bound to an item that resides in a room when docked, or possibly, always.
void	setExpirationDate(long time)	If this object expires, it should have a timestamp saying when it expires, in real time.
void	setHomePortID(java.lang.String portID)	Sets the room ID of the ships home port
void	setKeyName(java.lang.String newKeyName)	For things with doors and locks, this sets the unique string representing the key code required to unlock/lock it.
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	setOwnerName(java.lang.String owner)	Set the owner of the property, usually a clan name or a player name.
void	setPrice(int price)	set the value of the property in base currency values
void	setReadableText(java.lang.String text)	For things that are readable, this set the readable string for this thing.
void	stopTicking()	If this Item is current Ticking due to its having Behaviors or other properties which might grant it the ability to Tick, this method will cause that ticking to cease and desist.
boolean	subjectToWearAndTear()	Whether the usesRemaining() number above is used to determine the percentage health of the item.
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.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
protected void	transferOwnership(MOB buyer, boolean clanSale)
Room	unDock(boolean moveToOutside)	Designates that this ship is no longer docked, and whether it should also be moved into its na
int	value()	The default value of the item, represented in the base CoffeeMud currency.

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

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, 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

hasALock, isLocked, isOpen

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

initializeClass

Methods inherited from interface java.lang.Comparable

compareTo

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

amDestroyed, setSavable

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

canSaveDatabaseID, databaseID

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, setName

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, owner, rawSecretIdentity, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, ultimateContainer, usesRemaining

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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, name

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

riding, setRiding

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

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

canContain, capacity, containTypes, emptyPlease, getContents, getDeepContents, hasALock, hasContent, isInside, isLocked, isOpen, numberOfItems, recursiveWeight, setCapacity, setContainTypes

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, displayText, eachBehavior, eachEffect, eachScript, effects, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, numBehaviors, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDescription, setDisplayText, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, tackOns, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdPortal

addRider, amRiding, closedText, closeWord, defaultsClosed, defaultsLocked, delRider, displayText, doorName, exitUsage, fetchRider, genericName, getDismountString, getMountString, getPutString, getRideBuddies, getRideString, getStateString, getStateStringSubject, getTemporaryExits, hasADoor, isMobileRideBasis, isReadable, lastRoomUsedFrom, mobileRideBasis, numRiders, openDelayTicks, openWord, recoverPhyStats, rideBasis, riderCapacity, riders, rideString, setDismountString, setDoorsNLocks, setExitParams, setMountString, setOpenDelayTicks, setPutString, setReadable, setRideBasis, setRiderCapacity, setRideString, setStateString, setStateStringSubject, setTemporaryDoorLink, stateString, stateStringSubject, temporaryDoorLink, viewableText

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

getTickStatus, name

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

readableText

protected java.lang.String readableText

ownerName

protected java.lang.String ownerName

price

protected int price

internalPrice

protected int internalPrice

area

protected Area area

homePortID

protected java.lang.String homePortID

noun_word

protected java.lang.String noun_word

head_offTheDeck

protected java.lang.String head_offTheDeck

Constructor Detail

StdBoardable

public StdBoardable()

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 StdPortal

Returns:

the name of this class

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Overrides:

newInstance in class StdItem

Returns:

a new instance of this class

subjectToWearAndTear

public boolean subjectToWearAndTear()

Description copied from interface: Item

Whether the usesRemaining() number above is used to determine the percentage health of the item. If this method returns false, then health or condition is irrelevant to this Item. If true is returned, then usesRemaining is a number from 100 to 0, where 100 means perfect condition, and 0 means imminent disintegration.

Specified by:

subjectToWearAndTear in interface Item

Overrides:

subjectToWearAndTear in class StdItem

Returns:

whether this item has a valid condition

getBoardableItem

public Item getBoardableItem()

Description copied from interface: Boardable

Ships are unique in having an Item stand-in for port-side access, as well as an Area object. This method returns that Item.

Specified by:

getBoardableItem in interface Boardable

Returns:

the official item version of this ship

getAreaClassType

protected java.lang.String getAreaClassType()

abilityImbuesMagic

protected boolean abilityImbuesMagic()

Overrides:

abilityImbuesMagic in class StdItem

createFirstRoom

protected Room createFirstRoom()

setDockableItem

public void setDockableItem(Item dockableItem)

Description copied from interface: Boardable

When a boardable ship area is created, it is bound to an item that resides in a room when docked, or possibly, always.

Specified by:

setDockableItem in interface Boardable

Parameters:

dockableItem - the item that acts as dockable item

getArea

public Area getArea()

Description copied from interface: Boardable

Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method returns the area object that represents the contents of the ship.

Specified by:

getArea in interface Boardable

Returns:

the official area version of this ship

setArea

public void setArea(java.lang.String xml)

Description copied from interface: Boardable

Ships are unique in having an Item stand-in for dirt-side access, as well as an Area object. This method sets the area object that represents the contents of the ship.

Specified by:

setArea in interface Boardable

Parameters:

xml - area xml for the ship

dockHere

public void dockHere(Room R)

Description copied from interface: Boardable

Designates that this ship is landed and docked in the given planetary room.

Specified by:

dockHere in interface Boardable

Parameters:

R - the coordinate toom in which the ship is docked.

unDock

public Room unDock(boolean moveToOutside)

Description copied from interface: Boardable

Designates that this ship is no longer docked, and whether it should also be moved into its na

Specified by:

unDock in interface Boardable

Parameters:

moveToOutside - true to put in space/ocean, or false to leave in limbo

Returns:

one of the internal rooms that was connected to the dock

getIsDocked

public Room getIsDocked()

Description copied from interface: Boardable

Returns the Room where this ship is docked, or NULL if in space.

Specified by:

getIsDocked in interface Boardable

Returns:

the Room where this ship is docked, or NULL if in space.

getHomePortID

public java.lang.String getHomePortID()

Description copied from interface: Boardable

Returns the room ID of the ships home port.

Specified by:

getHomePortID in interface Boardable

Returns:

the ships home port

setHomePortID

public void setHomePortID(java.lang.String portID)

Description copied from interface: Boardable

Sets the room ID of the ships home port

Specified by:

setHomePortID in interface Boardable

Parameters:

portID - the ships home port

keyName

public java.lang.String keyName()

Description copied from interface: CloseableLockable

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

Specified by:

keyName in interface CloseableLockable

Overrides:

keyName in class StdContainer

Returns:

the key code

See Also:

CloseableLockable.setKeyName(String)

setDatabaseID

public void setDatabaseID(java.lang.String id)

Description copied from interface: DBIdentifiable

Set the unique contextual database ID for this object.

Specified by:

setDatabaseID in interface DBIdentifiable

Overrides:

setDatabaseID in class StdItem

Parameters:

id - the unique contextual database ID for this object.

See Also:

DBIdentifiable.canSaveDatabaseID(), DBIdentifiable.databaseID()

setKeyName

public void setKeyName(java.lang.String newKeyName)

Description copied from interface: CloseableLockable

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

Specified by:

setKeyName in interface CloseableLockable

Overrides:

setKeyName in class StdContainer

Parameters:

newKeyName - the new key code

See Also:

CloseableLockable.keyName()

readableText

public java.lang.String readableText()

Description copied from interface: Readable

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

Specified by:

readableText in interface Readable

Overrides:

readableText in class StdItem

Returns:

the readable string

See Also:

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

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Readable

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

Specified by:

setReadableText in interface Readable

Overrides:

setReadableText in class StdItem

Parameters:

text - the readable text

See Also:

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

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 StdItem

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 StdContainer

Parameters:

newText - either an open internal text string, or XML

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Overrides:

copyOf in class StdItem

Returns:

a clone of this object

stopTicking

public void stopTicking()

Description copied from interface: Item

If this Item is current Ticking due to its having Behaviors or other properties which might grant it the ability to Tick, this method will cause that ticking to cease and desist. This means that it will lose its periodic thread calls to its tick() method. This method also makes the item appear destroyed without actually being destroyed. The whole idea is to make the item 'dormant' for storage.

Specified by:

stopTicking in interface Item

Overrides:

stopTicking in class StdItem

getDestinationRoom

protected Room getDestinationRoom(Room fromRoom)

Overrides:

getDestinationRoom in class StdPortal

renameDestinationRooms

protected void renameDestinationRooms(java.lang.String from,
                                      java.lang.String to)

destroy

public void destroy()

Description copied from interface: Contingent

Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java. Containers, rooms. and mobs who have their destroy() method called will also call the destroy() methods on all items and other objects listed as content, recursively.

Specified by:

destroy in interface Contingent

Overrides:

destroy in class StdItem

getPrice

public int getPrice()

Description copied from interface: PrivateProperty

The value of the property in base currency values

Specified by:

getPrice in interface PrivateProperty

Returns:

the price of the property

setPrice

public void setPrice(int price)

Description copied from interface: PrivateProperty

set the value of the property in base currency values

Specified by:

setPrice in interface PrivateProperty

Parameters:

price - the price of the property

value

public int value()

Description copied from interface: Item

The default value of the item, represented in the base CoffeeMud currency. This method starts with baseGoldValue, which is a user-entered value, and adjusts according to magical enhancements and the condition of the item.

Specified by:

value in interface Item

Overrides:

value in class StdItem

Returns:

the adjusted value of the item in the base currency.

getOwnerName

public java.lang.String getOwnerName()

Description copied from interface: PrivateProperty

Get the owner of the property, usually a clan name or a player name.

Specified by:

getOwnerName in interface PrivateProperty

Returns:

the name of the owner of the property

setOwnerName

public void setOwnerName(java.lang.String owner)

Description copied from interface: PrivateProperty

Set the owner of the property, usually a clan name or a player name.

Specified by:

setOwnerName in interface PrivateProperty

Parameters:

owner - the name of the owner of the property

expirationDate

public long expirationDate()

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

expirationDate in interface Expireable

Overrides:

expirationDate in class StdItem

Returns:

the time stamp when this thing expires

See Also:

Expireable.setExpirationDate(long)

setExpirationDate

public void setExpirationDate(long time)

Description copied from interface: Expireable

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

setExpirationDate in interface Expireable

Overrides:

setExpirationDate in class StdItem

Parameters:

time - the time stamp when this thing expires

See Also:

Expireable.expirationDate()

isProperlyOwned

public boolean isProperlyOwned()

Description copied from interface: PrivateProperty

Returns whether the owner actually exists.

Specified by:

isProperlyOwned in interface PrivateProperty

Returns:

true if this property is owned.

getTitleID

public java.lang.String getTitleID()

Description copied from interface: PrivateProperty

Returns a unique id for this particular title and the purchase-able lot it represents. Could be a single item when items are purchased separately, or represent a group or items in other cases.

Specified by:

getTitleID in interface PrivateProperty

Returns:

a unique id

rename

public void rename(java.lang.String newName)

Description copied from interface: Boardable

Renames the boardable to something else

Specified by:

rename in interface Boardable

Parameters:

newName - the new name

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdContainer

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

destroyThisBoardable

protected void destroyThisBoardable()

okAreaMessage

protected boolean okAreaMessage(CMMsg msg,
                                boolean outdoorOnly)

securityCheck

public boolean securityCheck(MOB mob)

Description copied from interface: Boardable

Returns whether the given mob has control privileges for this boardable item

Specified by:

securityCheck in interface Boardable

Parameters:

mob - the mob to check

Returns:

true if the mob is a captain

announceToOuterViewers

protected void announceToOuterViewers(java.lang.String msgStr)

canViewOuterRoom

protected boolean canViewOuterRoom(Room R)

announceToOuterViewers

protected void announceToOuterViewers(CMMsg msg)

announceToOuterViewers

protected void announceToOuterViewers(MOB mob,
                                      java.lang.String msgStr)

announceToOuterViewers

protected void announceToOuterViewers(MOB mob,
                                      Environmental target,
                                      Environmental tool,
                                      java.lang.String msgStr)

announceToNonOuterViewers

protected void announceToNonOuterViewers(MOB mob,
                                         java.lang.String msgStr)

announceToAllAboard

protected void announceToAllAboard(java.lang.String msgStr)

sendAreaMessage

protected void sendAreaMessage(MOB mob,
                               CMMsg msg,
                               boolean outerViewerStatus)

sendAreaMessage

protected void sendAreaMessage(CMMsg msg,
                               boolean outerViewersOnly)

confirmAreaMessage

protected boolean confirmAreaMessage(CMMsg msg,
                                     boolean outerViewersOnly)

cleanMsgForRepeat

protected void cleanMsgForRepeat(CMMsg msg)

haveEveryoneLookOutside

protected void haveEveryoneLookOutside()

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdPortal

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class StdPortal

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

transferOwnership

protected void transferOwnership(MOB buyer,
                                 boolean clanSale)

getRandomOutsideRoom

protected Room getRandomOutsideRoom()

findNearestDocks

protected Room findNearestDocks(Room R)

putString

public java.lang.String putString(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are putting something on this Rideable

Specified by:

putString in interface Rideable

Overrides:

putString in class StdPortal

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of putting something on this Rideable

See Also:

Rider, Rideable.setPutString(String), Rideable.getPutString()

mountString

public java.lang.String mountString(int commandType,
                                    Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are mounting this Rideable

Specified by:

mountString in interface Rideable

Overrides:

mountString in class StdPortal

Parameters:

commandType - one of the RIDEABLE_ constants as a type

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of mounting this Rideable

See Also:

Rider, Rideable.setMountString(String), Rideable.getMountString()

dismountString

public java.lang.String dismountString(Rider R)

Description copied from interface: Rideable

Returns a string grammatically correct for the given rider when they are dismounting this Rideable

Specified by:

dismountString in interface Rideable

Overrides:

dismountString in class StdPortal

Parameters:

R - The rider object to make grammatically correct.

Returns:

a string describing the riders state of dismounting this Rideable

See Also:

Rider, Rideable.setDismountString(String), Rideable.getDismountString()

isSavable

public boolean isSavable()

Description copied from interface: Contingent

Whether, if this object is in a room, whether it is appropriate to save this object to the database as a permanent feature of its container. It always returns true except under unique circumstances.

Specified by:

isSavable in interface Contingent

Overrides:

isSavable in class StdItem

Returns:

true, usually.