com.planet_ink.coffee_mud.Items.Basic
Class StdTitle

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdTitle

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, LandTitle, MsgListener, Rider, StatsAffecting, Tickable, Item, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenTitle

public class StdTitle
extends StdItem
implements LandTitle

Field Summary

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

affects, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

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

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

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, 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_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

Constructor Summary

StdTitle()

Method Summary

int	backTaxes() If back taxes is owned on this property, this is how the value is retreived.
int	baseGoldValue() The user/builder-entered value of the item, represented in base CoffeeMud currency.
java.lang.String	displayText() Gets the raw string used to show what this object looks like in the room.
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
LandTitle	fetchALandTitle()
java.util.Vector	getPropertyRooms() The complete set of room objects represented by this title
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	landOwner() Get the owner of the property, usually a clan name or a player name.
int	landPrice() The value of the property in base currency values
java.lang.String	landPropertyID() Get the roomID or the Area name of the property for sale
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
void	recoverEnvStats() This method copies the baseEnvStats() object into the envStats() object, then makes repeated calls to all surrounding objects with affectEnvStats(Environmental,EnvStats) method.
boolean	rentalProperty() Whether this property is a rental.
void	setBackTaxes(int amount) If back taxes is owned on this property, this is how the value is set.
void	setBaseGoldValue(int newValue)
void	setLandOwner(java.lang.String owner) Set the owner of the property, usually a clan name or a player name.
void	setLandPrice(int price) set the value of the property in base currency values
void	setLandPropertyID(java.lang.String landID) Set the roomID or the Area name of the property for sale
void	setRentalProperty(boolean truefalse) Sets whether this property is a rental.
void	updateLot(java.util.Vector optPlayerList) Checks for changes in the content or condition of the rooms represented by this title and saves the changes to the database, if necessary.
void	updateTitle() Simply resaves the rooms represented by this title to reflect change in ownership or price.
void	updateTitleName()
int	value() The default value of the item, represented in the base CoffeeMud currency.

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

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, riding, sameAs, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, setRiding, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

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

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

addEffect, addNonUninvokableEffect, amDestroyed, baseEnvStats, delEffect, description, destroy, envStats, expirationDate, fetchEffect, fetchEffect, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, numEffects, rawImage, sameAs, savable, setBaseEnvStats, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

getTickStatus, tick

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

affectCharState, affectCharStats, affectEnvStats

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

addBehavior, addScript, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts

Constructor Detail

StdTitle

public StdTitle()

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 StdItem

Returns:

the name of this class

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 StdItem

Returns:

the string describing how this object looks in the room

baseGoldValue

public int baseGoldValue()

Description copied from interface: Item

The user/builder-entered value of the item, represented in base CoffeeMud currency. It is used as a basis for the value returned by the value() method.

Specified by:

baseGoldValue in interface Item

Overrides:

baseGoldValue in class StdItem

Returns:

the raw user-entered value of item.

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.

setBaseGoldValue

public void setBaseGoldValue(int newValue)

landPrice

public int landPrice()

Description copied from interface: LandTitle

The value of the property in base currency values

Specified by:

landPrice in interface LandTitle

Returns:

the price of the property

setLandPrice

public void setLandPrice(int price)

Description copied from interface: LandTitle

set the value of the property in base currency values

Specified by:

setLandPrice in interface LandTitle

Parameters:

price - the price of the property

setBackTaxes

public void setBackTaxes(int amount)

Description copied from interface: LandTitle

If back taxes is owned on this property, this is how the value is set. The value should be in base coffeemud currency

Specified by:

setBackTaxes in interface LandTitle

Parameters:

amount - the back taxes owed

backTaxes

public int backTaxes()

Description copied from interface: LandTitle

If back taxes is owned on this property, this is how the value is retreived. The value should be in base coffeemud currency

Specified by:

backTaxes in interface LandTitle

Returns:

amount the back taxes owed

rentalProperty

public boolean rentalProperty()

Description copied from interface: LandTitle

Whether this property is a rental.

Specified by:

rentalProperty in interface LandTitle

Returns:

true if the property is rental, false if ownable outright

setRentalProperty

public void setRentalProperty(boolean truefalse)

Description copied from interface: LandTitle

Sets whether this property is a rental.

Specified by:

setRentalProperty in interface LandTitle

Parameters:

truefalse - true if the property is rental, false if ownable outright

landOwner

public java.lang.String landOwner()

Description copied from interface: LandTitle

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

Specified by:

landOwner in interface LandTitle

Returns:

the name of the owner of the property

setLandOwner

public void setLandOwner(java.lang.String owner)

Description copied from interface: LandTitle

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

Specified by:

setLandOwner in interface LandTitle

Parameters:

owner - the name of the owner of the property

fetchALandTitle

public LandTitle fetchALandTitle()

landPropertyID

public java.lang.String landPropertyID()

Description copied from interface: LandTitle

Get the roomID or the Area name of the property for sale

Specified by:

landPropertyID in interface LandTitle

Returns:

the roomID or the Area name of the property for sale

updateTitleName

public void updateTitleName()

setLandPropertyID

public void setLandPropertyID(java.lang.String landID)

Description copied from interface: LandTitle

Set the roomID or the Area name of the property for sale

Specified by:

setLandPropertyID in interface LandTitle

Parameters:

landID - the roomID or the Area name of the property for sale

updateLot

public void updateLot(java.util.Vector optPlayerList)

Description copied from interface: LandTitle

Checks for changes in the content or condition of the rooms represented by this title and saves the changes to the database, if necessary.

Specified by:

updateLot in interface LandTitle

Parameters:

optPlayerList - - null, or a vector of player names for quick confirms

See Also:

LandTitle.updateTitle()

updateTitle

public void updateTitle()

Description copied from interface: LandTitle

Simply resaves the rooms represented by this title to reflect change in ownership or price. The state of the rooms is not inspected or updated as in updateLot.

Specified by:

updateTitle in interface LandTitle

See Also:

LandTitle.updateLot(Vector)

getPropertyRooms

public java.util.Vector getPropertyRooms()

Description copied from interface: LandTitle

The complete set of room objects represented by this title

Specified by:

getPropertyRooms in interface LandTitle

Returns:

a Vector of the complete set of Room objects represented by this title

See Also:

Room

recoverEnvStats

public void recoverEnvStats()

Description copied from interface: Environmental

This method copies the baseEnvStats() object into the envStats() object, then makes repeated calls to all surrounding objects with affectEnvStats(Environmental,EnvStats) method. Surrounding objects include the room where the object is located, the Ability objects in the Effects list, the Behaviors in the behaviors list, and race/charclass/area if applicable. Those methods will then make all necessary adjustments to the values in the new envStats() object. When it returns, envStats() will have a totally updated object. This method must be called in code whenever the object is placed on the map, or when anything changes in its environment, such as location, effects, or other states.

Specified by:

recoverEnvStats in interface Environmental

Overrides:

recoverEnvStats in class StdItem

See Also:

Environmental.baseEnvStats(), Environmental.envStats(), Environmental.addEffect(Ability), Behavable.addBehavior(Behavior), EnvStats

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 StdItem

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 StdItem

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