com.planet_ink.coffee_mud.core.interfaces
Interface LandTitle

All Superinterfaces:

java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Modifiable, MsgListener, StatsAffecting, Tickable

All Known Implementing Classes:

GenTitle, Prop_AreaForSale, Prop_LotsForSale, Prop_RoomForSale, Prop_RoomsForSale, StdTitle

public interface LandTitle
extends Environmental

Interface for objects which represents real estate purchasable by players. May be found implemented by Abilities which are placed as effects on the room objects for sale, or implemented as Items representing the sellable title.

Field Summary

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

Method Summary

int	backTaxes() If back taxes is owned on this property, this is how the value is retreived.
java.util.List<Room>	getPropertyRooms() The complete set of room objects represented by this title
java.lang.String	landOwner() Get the owner of the property, usually a clan name or a player name.
CMObject	landOwnerObject() Get the actual clan or mob owner of the property, or null if it can not.
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	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	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.List 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.

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

description, displayText, expirationDate, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, rawImage, sameAs, 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.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

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

amDestroyed, destroy, isSavable, setSavable

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Method Detail

landPrice

int landPrice()

The value of the property in base currency values

Returns:

the price of the property

setLandPrice

void setLandPrice(int price)

set the value of the property in base currency values

Parameters:

price - the price of the property

landOwner

java.lang.String landOwner()

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

Returns:

the name of the owner of the property

setLandOwner

void setLandOwner(java.lang.String owner)

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

Parameters:

owner - the name of the owner of the property

landOwnerObject

CMObject landOwnerObject()

Get the actual clan or mob owner of the property, or null if it can not.

Returns:

the owner of the property

landPropertyID

java.lang.String landPropertyID()

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

Returns:

the roomID or the Area name of the property for sale

setLandPropertyID

void setLandPropertyID(java.lang.String landID)

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

Parameters:

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

updateLot

void updateLot(java.util.List 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.

Parameters:

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

See Also:

updateTitle()

updateTitle

void updateTitle()

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.

See Also:

updateLot(List)

getPropertyRooms

java.util.List<Room> getPropertyRooms()

The complete set of room objects represented by this title

Returns:

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

See Also:

Room

rentalProperty

boolean rentalProperty()

Whether this property is a rental.

Returns:

true if the property is rental, false if ownable outright

setRentalProperty

void setRentalProperty(boolean truefalse)

Sets whether this property is a rental.

Parameters:

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

setBackTaxes

void setBackTaxes(int amount)

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

Parameters:

amount - the back taxes owed

backTaxes

int backTaxes()

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

Returns:

amount the back taxes owed