com.planet_ink.coffee_mud.Libraries
Class MUDLaw

java.lang.Object
  extended by com.planet_ink.coffee_mud.Libraries.StdLibrary
      extended by com.planet_ink.coffee_mud.Libraries.MUDLaw
All Implemented Interfaces:
CMObject, Tickable, CMLibrary, LegalLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class MUDLaw
extends StdLibrary
implements LegalLibrary


Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus
 
Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.LegalLibrary
INDOORSTR, OUTDOORSTR, RENTSTR, SALESTR
 
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
 
Constructor Summary
MUDLaw()
           
 
Method Summary
 boolean canAttackThisProperty(MOB mob, PrivateProperty record)
           
 void colorRoomForSale(Room R, LandTitle title, boolean reset)
           
 boolean doesAnyoneHavePrivilegesHere(MOB mob, java.lang.String overrideID, Room R)
           
 boolean doesHavePriviledgesHere(MOB mob, Room room)
           
 boolean doesHavePriviledgesInThisDirection(MOB mob, Room room, Exit exit)
           
 boolean doesHavePrivilegesWith(MOB mob, PrivateProperty record)
           
 boolean doesHaveWeakPriviledgesHere(MOB mob, Room room)
           
 boolean doesHaveWeakPrivilegesWith(MOB mob, PrivateProperty record)
           
 boolean doesOwnThisLand(MOB mob, Room room)
           
 boolean doesOwnThisLand(java.lang.String name, Room room)
           
 boolean doesOwnThisProperty(MOB mob, PrivateProperty record)
           
 boolean doesOwnThisProperty(MOB mob, Room room)
           
 boolean doesOwnThisProperty(java.lang.String name, Room room)
           
 java.util.List<LandTitle> getAllUniqueLandTitles(java.util.Enumeration<Room> e, java.lang.String owner, boolean includeRentals)
           
 Deity getClericInfused(Room room)
           
 Ability getClericInfusion(Physical room)
           
 java.util.Set<Room> getHomePeersOnThisFloor(Room room, java.util.Set<Room> doneRooms)
           
 java.lang.String getLandOwnerName(Room room)
           
 LandTitle getLandTitle(Area area)
           
 LandTitle getLandTitle(Room room)
           
 LegalBehavior getLegalBehavior(Area A)
           
 LegalBehavior getLegalBehavior(Room R)
           
 Area getLegalObject(Area A)
           
 Area getLegalObject(Room R)
           
 MOB getPropertyOwner(PrivateProperty record)
           
 java.lang.String getPropertyOwnerName(Room room)
           
 PrivateProperty getPropertyRecord(Area area)
           
 PrivateProperty getPropertyRecord(Item item)
           
 PrivateProperty getPropertyRecord(Room room)
           
 Law getTheLaw(Room R, MOB mob)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 LandTitle ifHomePeerLandTitle(Room R)
           
 LandTitle ifLandTitle(Room R)
           
 boolean isACity(Area A)
           
 boolean isHomePeerRoom(Room R)
           
 boolean isHomeRoomDownstairs(Room room)
           
 boolean isHomeRoomUpstairs(Room room)
           
 boolean isLandOwnable(Room room)
           
 boolean isLegalJudgeHere(MOB mob)
           
 boolean isLegalOfficerHere(MOB mob)
           
 boolean isLegalOfficialHere(MOB mob)
           
 boolean isRoomSimilarlyTitled(LandTitle title, Room R)
           
 boolean mayOwnThisItem(MOB mob, Item item)
           
 boolean robberyCheck(PrivateProperty record, CMMsg msg, boolean quiet)
           
protected  boolean shopkeeperMobPresent(Room R)
           
 
Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick
 
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.Libraries.interfaces.CMLibrary
activate, getServiceClient, L, propertiesLoaded, shutdown
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, name, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

MUDLaw

public MUDLaw()
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 StdLibrary
Returns:
the name of this class

getTheLaw

public Law getTheLaw(Room R,
                     MOB mob)
Specified by:
getTheLaw in interface LegalLibrary

getLegalBehavior

public LegalBehavior getLegalBehavior(Area A)
Specified by:
getLegalBehavior in interface LegalLibrary

getLegalBehavior

public LegalBehavior getLegalBehavior(Room R)
Specified by:
getLegalBehavior in interface LegalLibrary

getLegalObject

public Area getLegalObject(Area A)
Specified by:
getLegalObject in interface LegalLibrary

getLegalObject

public Area getLegalObject(Room R)
Specified by:
getLegalObject in interface LegalLibrary

isACity

public boolean isACity(Area A)
Specified by:
isACity in interface LegalLibrary

getAllUniqueLandTitles

public java.util.List<LandTitle> getAllUniqueLandTitles(java.util.Enumeration<Room> e,
                                                        java.lang.String owner,
                                                        boolean includeRentals)
Specified by:
getAllUniqueLandTitles in interface LegalLibrary

getLandTitle

public LandTitle getLandTitle(Area area)
Specified by:
getLandTitle in interface LegalLibrary

getPropertyRecord

public PrivateProperty getPropertyRecord(Area area)
Specified by:
getPropertyRecord in interface LegalLibrary

getLandTitle

public LandTitle getLandTitle(Room room)
Specified by:
getLandTitle in interface LegalLibrary

getPropertyRecord

public PrivateProperty getPropertyRecord(Room room)
Specified by:
getPropertyRecord in interface LegalLibrary

isHomeRoomUpstairs

public boolean isHomeRoomUpstairs(Room room)
Specified by:
isHomeRoomUpstairs in interface LegalLibrary

isHomePeerRoom

public boolean isHomePeerRoom(Room R)

ifHomePeerLandTitle

public LandTitle ifHomePeerLandTitle(Room R)

ifLandTitle

public LandTitle ifLandTitle(Room R)

isRoomSimilarlyTitled

public boolean isRoomSimilarlyTitled(LandTitle title,
                                     Room R)
Specified by:
isRoomSimilarlyTitled in interface LegalLibrary

getHomePeersOnThisFloor

public java.util.Set<Room> getHomePeersOnThisFloor(Room room,
                                                   java.util.Set<Room> doneRooms)
Specified by:
getHomePeersOnThisFloor in interface LegalLibrary

isHomeRoomDownstairs

public boolean isHomeRoomDownstairs(Room room)
Specified by:
isHomeRoomDownstairs in interface LegalLibrary

doesHavePriviledgesInThisDirection

public boolean doesHavePriviledgesInThisDirection(MOB mob,
                                                  Room room,
                                                  Exit exit)
Specified by:
doesHavePriviledgesInThisDirection in interface LegalLibrary

doesHavePrivilegesWith

public boolean doesHavePrivilegesWith(MOB mob,
                                      PrivateProperty record)
Specified by:
doesHavePrivilegesWith in interface LegalLibrary

doesHaveWeakPrivilegesWith

public boolean doesHaveWeakPrivilegesWith(MOB mob,
                                          PrivateProperty record)
Specified by:
doesHaveWeakPrivilegesWith in interface LegalLibrary

doesHavePriviledgesHere

public boolean doesHavePriviledgesHere(MOB mob,
                                       Room room)
Specified by:
doesHavePriviledgesHere in interface LegalLibrary

doesHaveWeakPriviledgesHere

public boolean doesHaveWeakPriviledgesHere(MOB mob,
                                           Room room)
Specified by:
doesHaveWeakPriviledgesHere in interface LegalLibrary

doesAnyoneHavePrivilegesHere

public boolean doesAnyoneHavePrivilegesHere(MOB mob,
                                            java.lang.String overrideID,
                                            Room R)
Specified by:
doesAnyoneHavePrivilegesHere in interface LegalLibrary

getPropertyOwnerName

public java.lang.String getPropertyOwnerName(Room room)
Specified by:
getPropertyOwnerName in interface LegalLibrary

getLandOwnerName

public java.lang.String getLandOwnerName(Room room)
Specified by:
getLandOwnerName in interface LegalLibrary

isLandOwnable

public boolean isLandOwnable(Room room)
Specified by:
isLandOwnable in interface LegalLibrary

doesOwnThisLand

public boolean doesOwnThisLand(java.lang.String name,
                               Room room)
Specified by:
doesOwnThisLand in interface LegalLibrary

doesOwnThisProperty

public boolean doesOwnThisProperty(java.lang.String name,
                                   Room room)
Specified by:
doesOwnThisProperty in interface LegalLibrary

doesOwnThisProperty

public boolean doesOwnThisProperty(MOB mob,
                                   Room room)
Specified by:
doesOwnThisProperty in interface LegalLibrary

doesOwnThisProperty

public boolean doesOwnThisProperty(MOB mob,
                                   PrivateProperty record)
Specified by:
doesOwnThisProperty in interface LegalLibrary

getPropertyOwner

public MOB getPropertyOwner(PrivateProperty record)
Specified by:
getPropertyOwner in interface LegalLibrary

canAttackThisProperty

public boolean canAttackThisProperty(MOB mob,
                                     PrivateProperty record)
Specified by:
canAttackThisProperty in interface LegalLibrary

getClericInfusion

public Ability getClericInfusion(Physical room)
Specified by:
getClericInfusion in interface LegalLibrary

getClericInfused

public Deity getClericInfused(Room room)
Specified by:
getClericInfused in interface LegalLibrary

doesOwnThisLand

public boolean doesOwnThisLand(MOB mob,
                               Room room)
Specified by:
doesOwnThisLand in interface LegalLibrary

isLegalOfficerHere

public boolean isLegalOfficerHere(MOB mob)
Specified by:
isLegalOfficerHere in interface LegalLibrary

isLegalJudgeHere

public boolean isLegalJudgeHere(MOB mob)
Specified by:
isLegalJudgeHere in interface LegalLibrary

isLegalOfficialHere

public boolean isLegalOfficialHere(MOB mob)
Specified by:
isLegalOfficialHere in interface LegalLibrary

colorRoomForSale

public void colorRoomForSale(Room R,
                             LandTitle title,
                             boolean reset)
Specified by:
colorRoomForSale in interface LegalLibrary

shopkeeperMobPresent

protected boolean shopkeeperMobPresent(Room R)

robberyCheck

public boolean robberyCheck(PrivateProperty record,
                            CMMsg msg,
                            boolean quiet)
Specified by:
robberyCheck in interface LegalLibrary

getPropertyRecord

public PrivateProperty getPropertyRecord(Item item)
Specified by:
getPropertyRecord in interface LegalLibrary

mayOwnThisItem

public boolean mayOwnThisItem(MOB mob,
                              Item item)
Specified by:
mayOwnThisItem in interface LegalLibrary