com.planet_ink.coffee_mud.core.interfaces
Interface PrivateProperty

All Superinterfaces:
java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Modifiable, MsgListener, StatsAffecting, Tickable
All Known Subinterfaces:
LandTitle
All Known Implementing Classes:
Branding, GenSailingShip, GenSpaceShip, GenTitle, Prop_AreaForSale, Prop_LotForSale, Prop_LotsForSale, Prop_PrivateProperty, Prop_RoomForSale, Prop_RoomPlusForSale, Prop_RoomsForSale, StdBoardable, StdBoardableShip, StdSpaceShip, StdTitle

public interface PrivateProperty
extends Environmental

Interface for objects which represents property 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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET
 
Method Summary
 java.lang.String getOwnerName()
          Get the owner of the property, usually a clan name or a player name.
 CMObject getOwnerObject()
          Get the actual clan or mob owner of the property, or null if it can not.
 int getPrice()
          The value of the property in base currency values
 java.lang.String getTitleID()
          Returns a unique id for this particular title and the rooms is represents, even if the contents change.
 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
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental
description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
getTickStatus, name, 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

getPrice

int getPrice()
The value of the property in base currency values

Returns:
the price of the property

setPrice

void setPrice(int price)
set the value of the property in base currency values

Parameters:
price - the price of the property

getOwnerName

java.lang.String getOwnerName()
Get the owner of the property, usually a clan name or a player name.

Returns:
the name of the owner of the property

setOwnerName

void setOwnerName(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

getOwnerObject

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

Returns:
the owner of the property

getTitleID

java.lang.String getTitleID()
Returns a unique id for this particular title and the rooms is represents, even if the contents change.

Returns:
a unique id