MUDLaw

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - 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 interface com.planet_ink.coffee_mud.core.interfaces.CMObject
  idConverter
- Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.LegalLibrary
  INDOORSTR, OUTDOORSTR, RENTSTR, SALESTR
- Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
  isDebugging, name, serviceClient, tickStatus
- 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

Constructor Summary

Constructors
Constructor Description

MUDLaw()

Constructors
Constructor	Description
`MUDLaw()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canAttackThisProperty(MOB mob, PrivateProperty record)`	Property can be attacked if it is unowned, owned by the attacker, is owned by a clan whose leader the attacker may fight, or owned by a person whom the attacker may fight.
`void`	`colorRoomForSale(Room R, LandTitle title, boolean reset)`	If the given room with the given land title was recently created, or recently lost its owner and has gone back into a for-sale state, then this method will update or create its ID and fix its title and description.
`boolean`	`doesAnyoneHavePrivilegesHere(MOB mob, java.lang.String overrideID, Room R)`	Returns whether the given mob, or an optional given property owner, or literally anyone else in the room, has normal privileges in the room.
`protected boolean`	`doesHaveClanFriendlyPrivilegesHere(MOB mob, java.lang.String clanID)`
`boolean`	`doesHavePriviledgesHere(MOB mob, Room room)`	A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with.
`boolean`	`doesHavePriviledgesInThisDirection(MOB mob, Room room, Exit exit)`	Given a mob, a room the mob is currently in, and an exit in that room that the mob would enter, this will return whether the given mob has normal privileges in the room in the direction of the exit.
`boolean`	`doesHavePrivilegesWith(MOB mob, PrivateProperty record)`	A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with.
`boolean`	`doesHaveWeakPriviledgesHere(MOB mob, Room room)`	Weak privileges are had when one owns a room, is married to the owner, is following someone who is an owner, or is a member of the clan that owns the property (privileges notwithstanding).
`boolean`	`doesHaveWeakPrivilegesWith(MOB mob, PrivateProperty record)`	Weak privileges are had when one owns property, is married to the owner, or is a member of the clan that owns the property (privileges notwithstanding).
`boolean`	`doesOwnThisLand(MOB mob, Room room)`	Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
`boolean`	`doesOwnThisProperty(MOB mob, PrivateProperty record)`	Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
`boolean`	`doesOwnThisProperty(MOB mob, Room room)`	Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
`protected java.util.List<Room>`	`getAllMetroTitledRooms(Area A)`
`java.util.List<LandTitle>`	`getAllUniqueLandTitles(Area A, java.lang.String owner, boolean includeRentals)`	Scans the given area metro for property titles, returning only the unique ones (so rooms groups under one title return only the 1 title).
`java.lang.String`	`getClericInfused(Physical P)`	Cleric Infusion is actually more a part of Divine Law than the normal kind.
`Deity.DeityWorshipper`	`getClericInfusion(Physical P)`	Cleric Infusion is actually more a part of Divine Law than the normal kind.
`java.util.Set<Room>`	`getHomePeersOnThisFloor(Room room, java.util.Set<Room> doneRooms)`	Returns all interconnected rooms that are private property and ownable, even if owned by no one.
`java.lang.String`	`getLandOwnerName(Room room)`	Returns the name of the owner of the given room.
`LandTitle`	`getLandTitle(Area area)`	Returns the private property record of the given area, if one exists.
`LandTitle`	`getLandTitle(Room room)`	Returns the private property record of the given room, if one exists, or its area.
`LegalBehavior`	`getLegalBehavior(Area A)`	If an area is subject to law and order, this method will return the legal system that applies to it.
`LegalBehavior`	`getLegalBehavior(Room R)`	If a room is in an area subject to law and order, this method will return the legal system that applies to it.
`Area`	`getLegalObject(Area A)`	If an area is subject to law and order, this method will return the exact area object that the legal system directly applies to.
`Area`	`getLegalObject(Room R)`	If a room is in an area subject to law and order, this method will return the exact area object that the legal system directly applies to.
`MOB`	`getPropertyOwner(PrivateProperty record)`	If the owner of the given property record is a clan, this will return the property owner mob.
`java.lang.String`	`getPropertyOwnerName(Room room)`	Returns the name of the owner of the given room.
`PrivateProperty`	`getPropertyRecord(Area area)`	Returns the private property record of the given area, if one existsa.
`PrivateProperty`	`getPropertyRecord(Item item)`	Returns the private property record of the given item, if one exists.
`PrivateProperty`	`getPropertyRecord(Room room)`	Returns the private property record of the given room, if one exists, or its area.
`PrivateProperty`	`getPropertyRecord(MOB mob)`	Returns the private property record of the given mob, if one exists.
`Law`	`getTheLaw(Room R)`	If a room is in an area subject to law and order, this method will return the legal policy object that applies to it.
`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)`	Returns whether the stats for the given area reflect that it is legally considered a City.
`boolean`	`isHomePeerRoom(Room R)`
`boolean`	`isHomeRoomDownstairs(Room room)`	Given a room that is presumably a piece of property, this will return whether the given room is downstairs (not necc directly) of property rooms, even if owned by someone else.
`boolean`	`isHomeRoomUpstairs(Room room)`	Given a room that is presumably a piece of property, this will return whether the given room is upstairs (not necc directly) of property rooms, even if owned by someone else.
`boolean`	`isLandOwnable(Room room)`	Returns whether the given room has a land title that makes it possible to own, which might include the area.
`boolean`	`isLandOwnersName(java.lang.String name, Room room)`	Someone is considered the direct owner if they are the named owner.
`boolean`	`isLegalJudgeHere(MOB mob)`	Returns whether the given mob is legally considered a Judge in the place where the mob is presently located when this method is called.
`boolean`	`isLegalOfficerHere(MOB mob)`	Returns whether the given mob is legally considered a Police Officer in the place where the mob is presently located when this method is called.
`boolean`	`isLegalOfficialHere(MOB mob)`	Returns whether the given mob is either a police officer or a judge in the place where the mob is presently located when this is called.
`boolean`	`isPropertyOwnersName(java.lang.String name, Room room)`	Someone is considered the direct owner if they are the named owner.
`boolean`	`isRoomSimilarlyTitled(LandTitle title, Room R)`	Given a title with an owner, this will return whether the given room, or any room adjacent to the given room, is owned by the same owner.
`boolean`	`mayOwnThisItem(MOB mob, Item item)`	Given a mob and an item, this will return whether the mob has weak privileges with a property record on the item.
`boolean`	`robberyCheck(PrivateProperty record, CMMsg msg, boolean quiet)`	This method is called whenever an action occurs on private property to determine whether the action might start a "robbery" state.
`protected boolean`	`shopkeeperMobPresent(Room R)`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- 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)
```
    Description copied from interface: LegalLibrary
    
    If a room is in an area subject to law and order, this method will return the legal policy object that applies to it.
    
    Specified by:
    
    getTheLaw in interface LegalLibrary
    
    Parameters:
    
    R - the room to check
    
    Returns:
    
    null, or the legal policies
    
    See Also:
    
    LegalLibrary.getLegalObject(Area), LegalLibrary.getLegalBehavior(Area), LegalLibrary.getLegalObject(Room), LegalLibrary.getLegalBehavior(Room)
  - getLegalBehavior
```
public LegalBehavior getLegalBehavior(Area A)
```
    Description copied from interface: LegalLibrary
    
    If an area is subject to law and order, this method will return the legal system that applies to it.
    
    Specified by:
    
    getLegalBehavior in interface LegalLibrary
    
    Parameters:
    
    A - the area to check
    
    Returns:
    
    null, or the legal system
    
    See Also:
    
    LegalLibrary.getTheLaw(Room), LegalLibrary.getLegalObject(Area), LegalLibrary.getLegalObject(Room), LegalLibrary.getLegalBehavior(Room)
  - getLegalBehavior
```
public LegalBehavior getLegalBehavior(Room R)
```
    Description copied from interface: LegalLibrary
    
    If a room is in an area subject to law and order, this method will return the legal system that applies to it.
    
    Specified by:
    
    getLegalBehavior in interface LegalLibrary
    
    Parameters:
    
    R - the room to check
    
    Returns:
    
    null, or the legal system
    
    See Also:
    
    LegalLibrary.getTheLaw(Room), LegalLibrary.getLegalObject(Area), LegalLibrary.getLegalBehavior(Area), LegalLibrary.getLegalObject(Room)
  - getLegalObject
```
public Area getLegalObject(Area A)
```
    Description copied from interface: LegalLibrary
    
    If an area is subject to law and order, this method will return the exact area object that the legal system directly applies to.
    
    Specified by:
    
    getLegalObject in interface LegalLibrary
    
    Parameters:
    
    A - the area to check
    
    Returns:
    
    null, or the legal area
    
    See Also:
    
    LegalLibrary.getTheLaw(Room), LegalLibrary.getLegalBehavior(Area), LegalLibrary.getLegalObject(Room), LegalLibrary.getLegalBehavior(Room)
  - getLegalObject
```
public Area getLegalObject(Room R)
```
    Description copied from interface: LegalLibrary
    
    If a room is in an area subject to law and order, this method will return the exact area object that the legal system directly applies to.
    
    Specified by:
    
    getLegalObject in interface LegalLibrary
    
    Parameters:
    
    R - the room to check
    
    Returns:
    
    null, or the legal area
    
    See Also:
    
    LegalLibrary.getTheLaw(Room), LegalLibrary.getLegalObject(Area), LegalLibrary.getLegalBehavior(Area), LegalLibrary.getLegalBehavior(Room)
  - isACity
```
public boolean isACity(Area A)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the stats for the given area reflect that it is legally considered a City.
    
    Specified by:
    
    isACity in interface LegalLibrary
    
    Parameters:
    
    A - the area to check
    
    Returns:
    
    true if its a city, false otherwise
  - getAllMetroTitledRooms
```
protected java.util.List<Room> getAllMetroTitledRooms(Area A)
```
  - getAllUniqueLandTitles
```
public java.util.List<LandTitle> getAllUniqueLandTitles(Area A,
                                                        java.lang.String owner,
                                                        boolean includeRentals)
```
    Description copied from interface: LegalLibrary
    
    Scans the given area metro for property titles, returning only the unique ones (so rooms groups under one title return only the 1 title).
    
    Specified by:
    
    getAllUniqueLandTitles in interface LegalLibrary
    
    Parameters:
    
    A - the area whose rooms and children to scan for titles
    
    owner - null for all titles, * for all owned titles, or owner name
    
    includeRentals - true to include rental property, false otherwise
    
    Returns:
    
    the list of titles found
  - getLandTitle
```
public LandTitle getLandTitle(Area area)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given area, if one exists.
    
    Specified by:
    
    getLandTitle in interface LegalLibrary
    
    Parameters:
    
    area - the area to check
    
    Returns:
    
    null, or the LandTitle record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Room), LegalLibrary.getPropertyRecord(Area), LegalLibrary.getPropertyRecord(Item), LegalLibrary.getPropertyRecord(MOB), LegalLibrary.getLandTitle(Room)
  - getPropertyRecord
```
public PrivateProperty getPropertyRecord(Area area)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given area, if one existsa. This could also be in a boardable.
    
    Specified by:
    
    getPropertyRecord in interface LegalLibrary
    
    Parameters:
    
    area - the area to check
    
    Returns:
    
    null, or the privateproperty record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Room), LegalLibrary.getPropertyRecord(Item), LegalLibrary.getPropertyRecord(MOB), LegalLibrary.getLandTitle(Area), LegalLibrary.getLandTitle(Room)
  - getPropertyRecord
```
public PrivateProperty getPropertyRecord(MOB mob)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given mob, if one exists. Slaves happen.
    
    Specified by:
    
    getPropertyRecord in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    Returns:
    
    null, or the privateproperty record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Room), LegalLibrary.getPropertyRecord(Item), LegalLibrary.getPropertyRecord(Area), LegalLibrary.getLandTitle(Area), LegalLibrary.getLandTitle(Room)
  - getLandTitle
```
public LandTitle getLandTitle(Room room)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given room, if one exists, or its area.
    
    Specified by:
    
    getLandTitle in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    null, or the LandTitle record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Room), LegalLibrary.getPropertyRecord(Area), LegalLibrary.getPropertyRecord(Item), LegalLibrary.getPropertyRecord(MOB), LegalLibrary.getLandTitle(Area)
  - getPropertyRecord
```
public PrivateProperty getPropertyRecord(Room room)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given room, if one exists, or its area. This could also be in a boardable.
    
    Specified by:
    
    getPropertyRecord in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    null, or the privateproperty record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Area), LegalLibrary.getPropertyRecord(Item), LegalLibrary.getPropertyRecord(MOB), LegalLibrary.getLandTitle(Area), LegalLibrary.getLandTitle(Room)
  - isHomeRoomUpstairs
```
public boolean isHomeRoomUpstairs(Room room)
```
    Description copied from interface: LegalLibrary
    
    Given a room that is presumably a piece of property, this will return whether the given room is upstairs (not necc directly) of property rooms, even if owned by someone else. Caves generally don't count.
    
    Specified by:
    
    isHomeRoomUpstairs in interface LegalLibrary
    
    Parameters:
    
    room - the room to check whether it is upstairs
    
    Returns:
    
    true if the given room is upstairs
    
    See Also:
    
    LegalLibrary.isHomeRoomDownstairs(Room), LegalLibrary.getHomePeersOnThisFloor(Room, Set)
  - 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)
```
    Description copied from interface: LegalLibrary
    
    Given a title with an owner, this will return whether the given room, or any room adjacent to the given room, is owned by the same owner.
    
    Specified by:
    
    isRoomSimilarlyTitled in interface LegalLibrary
    
    Parameters:
    
    title - the title to serve as basis
    
    R - the room to start checking from
    
    Returns:
    
    true if the room has the same owner
  - getHomePeersOnThisFloor
```
public java.util.Set<Room> getHomePeersOnThisFloor(Room room,
                                                   java.util.Set<Room> doneRooms)
```
    Description copied from interface: LegalLibrary
    
    Returns all interconnected rooms that are private property and ownable, even if owned by no one. Does not return any upstairs or downstairs rooms.
    
    Specified by:
    
    getHomePeersOnThisFloor in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    doneRooms - a required set to put all peer rooms in
    
    Returns:
    
    the given set
    
    See Also:
    
    LegalLibrary.isHomeRoomUpstairs(Room), LegalLibrary.isHomeRoomDownstairs(Room)
  - isHomeRoomDownstairs
```
public boolean isHomeRoomDownstairs(Room room)
```
    Description copied from interface: LegalLibrary
    
    Given a room that is presumably a piece of property, this will return whether the given room is downstairs (not necc directly) of property rooms, even if owned by someone else. Caves generally don't count. If a room has no upstairs, it can't be downstairs.
    
    Specified by:
    
    isHomeRoomDownstairs in interface LegalLibrary
    
    Parameters:
    
    room - the room to check whether it is downstairs
    
    Returns:
    
    true if the given room is upstairs
    
    See Also:
    
    LegalLibrary.isHomeRoomUpstairs(Room), LegalLibrary.getHomePeersOnThisFloor(Room, Set)
  - doesHavePriviledgesInThisDirection
```
public boolean doesHavePriviledgesInThisDirection(MOB mob,
                                                  Room room,
                                                  Exit exit)
```
    Description copied from interface: LegalLibrary
    
    Given a mob, a room the mob is currently in, and an exit in that room that the mob would enter, this will return whether the given mob has normal privileges in the room in the direction of the exit. A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with. Followers don't matter.
    
    Specified by:
    
    doesHavePriviledgesInThisDirection in interface LegalLibrary
    
    Parameters:
    
    mob - the mob
    
    room - the mobs current room
    
    exit - the exit in the room denoting the direction
    
    Returns:
    
    true if the mob has privileges in that directions room
    
    See Also:
    
    LegalLibrary.doesHavePrivilegesWith(MOB, PrivateProperty), LegalLibrary.doesAnyoneHavePrivilegesHere(MOB, String, Room), LegalLibrary.doesHavePriviledgesHere(MOB, Room)
  - doesHavePrivilegesWith
```
public boolean doesHavePrivilegesWith(MOB mob,
                                      PrivateProperty record)
```
    Description copied from interface: LegalLibrary
    
    A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with. Followers don't matter.
    
    Specified by:
    
    doesHavePrivilegesWith in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    record - the property to check
    
    Returns:
    
    true if the mob has normal privileges with the property
    
    See Also:
    
    LegalLibrary.doesHaveWeakPrivilegesWith(MOB, PrivateProperty), LegalLibrary.doesHavePriviledgesInThisDirection(MOB, Room, Exit), LegalLibrary.doesHavePriviledgesHere(MOB, Room), LegalLibrary.doesAnyoneHavePrivilegesHere(MOB, String, Room)
  - doesHaveWeakPrivilegesWith
```
public boolean doesHaveWeakPrivilegesWith(MOB mob,
                                          PrivateProperty record)
```
    Description copied from interface: LegalLibrary
    
    Weak privileges are had when one owns property, is married to the owner, or is a member of the clan that owns the property (privileges notwithstanding).
    
    Specified by:
    
    doesHaveWeakPrivilegesWith in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    record - the record to check
    
    Returns:
    
    true if the mob has weak privileges with the property record
    
    See Also:
    
    LegalLibrary.doesHaveWeakPriviledgesHere(MOB, Room)
  - doesHavePriviledgesHere
```
public boolean doesHavePriviledgesHere(MOB mob,
                                       Room room)
```
    Description copied from interface: LegalLibrary
    
    A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with. Followers don't matter. This returns whether the given mob has normal privileges in the given room.
    
    Specified by:
    
    doesHavePriviledgesHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob
    
    room - the room
    
    Returns:
    
    true if the mob has normal privileges in the room
    
    See Also:
    
    LegalLibrary.doesHavePrivilegesWith(MOB, PrivateProperty), LegalLibrary.doesAnyoneHavePrivilegesHere(MOB, String, Room), LegalLibrary.doesHavePriviledgesInThisDirection(MOB, Room, Exit)
  - doesHaveWeakPriviledgesHere
```
public boolean doesHaveWeakPriviledgesHere(MOB mob,
                                           Room room)
```
    Description copied from interface: LegalLibrary
    
    Weak privileges are had when one owns a room, is married to the owner, is following someone who is an owner, or is a member of the clan that owns the property (privileges notwithstanding).
    
    Specified by:
    
    doesHaveWeakPriviledgesHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    room - the room to check
    
    Returns:
    
    true if the mob has weak privileges in the room
    
    See Also:
    
    LegalLibrary.doesHaveWeakPrivilegesWith(MOB, PrivateProperty)
  - doesHaveClanFriendlyPrivilegesHere
```
protected boolean doesHaveClanFriendlyPrivilegesHere(MOB mob,
                                                     java.lang.String clanID)
```
  - doesAnyoneHavePrivilegesHere
```
public boolean doesAnyoneHavePrivilegesHere(MOB mob,
                                            java.lang.String overrideID,
                                            Room R)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the given mob, or an optional given property owner, or literally anyone else in the room, has normal privileges in the room. A mob has normal privileges with record to property if they are the owner, married to the owner, has HOME_PRIVS clan privileges with clan owned property, or with the property of a clan that your clan is friendly with. Followers don't matter.
    
    Specified by:
    
    doesAnyoneHavePrivilegesHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check first
    
    overrideID - "", or another property owner
    
    R - the room with possible privileged
    
    Returns:
    
    true if there is a privileged one present
    
    See Also:
    
    LegalLibrary.doesHavePrivilegesWith(MOB, PrivateProperty), LegalLibrary.doesHavePriviledgesHere(MOB, Room), LegalLibrary.doesHavePriviledgesInThisDirection(MOB, Room, Exit)
  - getPropertyOwnerName
```
public java.lang.String getPropertyOwnerName(Room room)
```
    Description copied from interface: LegalLibrary
    
    Returns the name of the owner of the given room. This might include its area.
    
    Specified by:
    
    getPropertyOwnerName in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    "" or the name of the owner
    
    See Also:
    
    LegalLibrary.isLandOwnable(Room), LegalLibrary.getLandOwnerName(Room)
  - getLandOwnerName
```
public java.lang.String getLandOwnerName(Room room)
```
    Description copied from interface: LegalLibrary
    
    Returns the name of the owner of the given room. This might include its area.
    
    Specified by:
    
    getLandOwnerName in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    "", or the name of the owner
    
    See Also:
    
    LegalLibrary.getPropertyOwnerName(Room), LegalLibrary.isLandOwnable(Room)
  - isLandOwnable
```
public boolean isLandOwnable(Room room)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the given room has a land title that makes it possible to own, which might include the area.
    
    Specified by:
    
    isLandOwnable in interface LegalLibrary
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    true if it can be privately owned
    
    See Also:
    
    LegalLibrary.getPropertyOwnerName(Room), LegalLibrary.getLandOwnerName(Room)
  - isLandOwnersName
```
public boolean isLandOwnersName(java.lang.String name,
                                Room room)
```
    Description copied from interface: LegalLibrary
    
    Someone is considered the direct owner if they are the named owner. No other rules can make one a direct owner. Not even marriage. The property does have to be owned by someone to have a direct owner, however.
    
    Specified by:
    
    isLandOwnersName in interface LegalLibrary
    
    Parameters:
    
    name - the name (mob or clan) to check for ownership status
    
    room - the property to check
    
    Returns:
    
    true if the given name is the owner, false otherwise
    
    See Also:
    
    LegalLibrary.doesOwnThisLand(MOB, Room)
  - isPropertyOwnersName
```
public boolean isPropertyOwnersName(java.lang.String name,
                                    Room room)
```
    Description copied from interface: LegalLibrary
    
    Someone is considered the direct owner if they are the named owner. No other rules can make one a direct owner. Not even marriage. The property does have to be owned by someone to have a direct owner, however.
    
    Specified by:
    
    isPropertyOwnersName in interface LegalLibrary
    
    Parameters:
    
    name - the name (mob or clan) to check for ownership status
    
    room - the property to check
    
    Returns:
    
    true if the given name is the owner, false otherwise
    
    See Also:
    
    LegalLibrary.doesOwnThisProperty(MOB, PrivateProperty), LegalLibrary.doesOwnThisProperty(MOB, Room)
  - doesOwnThisProperty
```
public boolean doesOwnThisProperty(MOB mob,
                                   Room room)
```
    Description copied from interface: LegalLibrary
    
    Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
    
    Specified by:
    
    doesOwnThisProperty in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check for ownership status
    
    room - the property to check
    
    Returns:
    
    true if the given mob is an owner, false otherwise
    
    See Also:
    
    LegalLibrary.doesOwnThisProperty(MOB, PrivateProperty), LegalLibrary.isPropertyOwnersName(String, Room)
  - doesOwnThisProperty
```
public boolean doesOwnThisProperty(MOB mob,
                                   PrivateProperty record)
```
    Description copied from interface: LegalLibrary
    
    Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
    
    Specified by:
    
    doesOwnThisProperty in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check for ownership status
    
    record - the property record to check
    
    Returns:
    
    true if the given mob is an owner, false otherwise
    
    See Also:
    
    LegalLibrary.doesOwnThisProperty(MOB, Room), LegalLibrary.isPropertyOwnersName(String, Room)
  - getPropertyOwner
```
public MOB getPropertyOwner(PrivateProperty record)
```
    Description copied from interface: LegalLibrary
    
    If the owner of the given property record is a clan, this will return the property owner mob. If owned by a mob, it will return that mob. Either way, this may cause a player to be loaded permanently.
    
    Specified by:
    
    getPropertyOwner in interface LegalLibrary
    
    Parameters:
    
    record - the property record
    
    Returns:
    
    the property owner mob
  - canAttackThisProperty
```
public boolean canAttackThisProperty(MOB mob,
                                     PrivateProperty record)
```
    Description copied from interface: LegalLibrary
    
    Property can be attacked if it is unowned, owned by the attacker, is owned by a clan whose leader the attacker may fight, or owned by a person whom the attacker may fight.
    
    Specified by:
    
    canAttackThisProperty in interface LegalLibrary
    
    Parameters:
    
    mob - the attacker
    
    record - the property record for the given property
    
    Returns:
    
    true if the attacker is allowed to attack it
  - getClericInfusion
```
public Deity.DeityWorshipper getClericInfusion(Physical P)
```
    Description copied from interface: LegalLibrary
    
    Cleric Infusion is actually more a part of Divine Law than the normal kind. It refers to an official link between a specific deity and a particular item, place, or person.
    
    Specified by:
    
    getClericInfusion in interface LegalLibrary
    
    Parameters:
    
    P - the thing to check for infusion
    
    Returns:
    
    null, or a deityworshipper object
    
    See Also:
    
    Deity.DeityWorshipper
  - getClericInfused
```
public java.lang.String getClericInfused(Physical P)
```
    Description copied from interface: LegalLibrary
    
    Cleric Infusion is actually more a part of Divine Law than the normal kind. It refers to an official link between a specific deity and a particular item, place, or person.
    
    Specified by:
    
    getClericInfused in interface LegalLibrary
    
    Parameters:
    
    P - the thing to check for infusion
    
    Returns:
    
    null, or the name of a deity
  - doesOwnThisLand
```
public boolean doesOwnThisLand(MOB mob,
                               Room room)
```
    Description copied from interface: LegalLibrary
    
    Someone is considered the owner if they are the named owner, married to the named owner, with property ownership privileges to clan owned property, or are Following someone who is otherwise an owner of some sort.
    
    Specified by:
    
    doesOwnThisLand in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check for ownership status
    
    room - the property to check
    
    Returns:
    
    true if the given mob is an owner, false otherwise
    
    See Also:
    
    LegalLibrary.isLandOwnersName(String, Room)
  - isLegalOfficerHere
```
public boolean isLegalOfficerHere(MOB mob)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the given mob is legally considered a Police Officer in the place where the mob is presently located when this method is called.
    
    Specified by:
    
    isLegalOfficerHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    Returns:
    
    true if a Police Officer, false otherwise
    
    See Also:
    
    LegalLibrary.isLegalJudgeHere(MOB), LegalLibrary.isLegalOfficialHere(MOB)
  - isLegalJudgeHere
```
public boolean isLegalJudgeHere(MOB mob)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the given mob is legally considered a Judge in the place where the mob is presently located when this method is called.
    
    Specified by:
    
    isLegalJudgeHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    Returns:
    
    true if a judge, false otherwise
    
    See Also:
    
    LegalLibrary.isLegalOfficerHere(MOB), LegalLibrary.isLegalOfficialHere(MOB)
  - isLegalOfficialHere
```
public boolean isLegalOfficialHere(MOB mob)
```
    Description copied from interface: LegalLibrary
    
    Returns whether the given mob is either a police officer or a judge in the place where the mob is presently located when this is called.
    
    Specified by:
    
    isLegalOfficialHere in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check
    
    Returns:
    
    true if judge/officer, false otherwise
    
    See Also:
    
    LegalLibrary.isLegalJudgeHere(MOB), LegalLibrary.isLegalOfficerHere(MOB)
  - colorRoomForSale
```
public void colorRoomForSale(Room R,
                             LandTitle title,
                             boolean reset)
```
    Description copied from interface: LegalLibrary
    
    If the given room with the given land title was recently created, or recently lost its owner and has gone back into a for-sale state, then this method will update or create its ID and fix its title and description. Will save the room info to the DB.
    
    Specified by:
    
    colorRoomForSale in interface LegalLibrary
    
    Parameters:
    
    R - the room that's for sale
    
    title - the rooms land title
    
    reset - reset the room description
  - shopkeeperMobPresent
```
protected boolean shopkeeperMobPresent(Room R)
```
  - robberyCheck
```
public boolean robberyCheck(PrivateProperty record,
                            CMMsg msg,
                            boolean quiet)
```
    Description copied from interface: LegalLibrary
    
    This method is called whenever an action occurs on private property to determine whether the action might start a "robbery" state. Robbery might occur when an item on private property is picked up by someone who lacks privileges to do so. This method can cancel the given event by returning false if need be. If a robbery seems to occur, and there is a witness, then a crime may be added. The stolen item itself will also attain a property that makes it unsellable.
    
    Specified by:
    
    robberyCheck in interface LegalLibrary
    
    Parameters:
    
    record - the property record for the room
    
    msg - the event to check
    
    quiet - true to not report anything to the source of the event
    
    Returns:
    
    true to allow the event to occur, false to immediately cancel it
    
    See Also:
    
    LegalLibrary.doesHavePriviledgesHere(MOB, Room)
  - getPropertyRecord
```
public PrivateProperty getPropertyRecord(Item item)
```
    Description copied from interface: LegalLibrary
    
    Returns the private property record of the given item, if one exists. This could be carryables or boardables.
    
    Specified by:
    
    getPropertyRecord in interface LegalLibrary
    
    Parameters:
    
    item - the item to check
    
    Returns:
    
    null, or the privateproperty record
    
    See Also:
    
    LegalLibrary.getPropertyRecord(Area), LegalLibrary.getPropertyRecord(Room), LegalLibrary.getPropertyRecord(MOB), LegalLibrary.getLandTitle(Area), LegalLibrary.getLandTitle(Room)
  - mayOwnThisItem
```
public boolean mayOwnThisItem(MOB mob,
                              Item item)
```
    Description copied from interface: LegalLibrary
    
    Given a mob and an item, this will return whether the mob has weak privileges with a property record on the item. It also affirms someone is following someone with weak privileges, or if the mob is in a room in which they have actual privileges. If the given item has no property record of its own, it will return whether the mob has weak privileges with the room the item is in. Items could include boardables, but also any item with a privateproperty property.
    
    Specified by:
    
    mayOwnThisItem in interface LegalLibrary
    
    Parameters:
    
    mob - the mob to check possible item ownership of
    
    item - the item to check
    
    Returns:
    
    true if there is some sort of ownership privilege
    
    See Also:
    
    LegalLibrary.doesHavePrivilegesWith(MOB, PrivateProperty), LegalLibrary.doesHaveWeakPrivilegesWith(MOB, PrivateProperty)

Class MUDLaw

Field Summary

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

Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.LegalLibrary

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Constructor Summary

Method Summary

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Constructor Detail

MUDLaw

Method Detail

ID

getTheLaw

getLegalBehavior

getLegalBehavior

getLegalObject

getLegalObject

isACity

getAllMetroTitledRooms

getAllUniqueLandTitles

getLandTitle

getPropertyRecord

getPropertyRecord

getLandTitle

getPropertyRecord

isHomeRoomUpstairs

isHomePeerRoom

ifHomePeerLandTitle

ifLandTitle

isRoomSimilarlyTitled

getHomePeersOnThisFloor

isHomeRoomDownstairs

doesHavePriviledgesInThisDirection

doesHavePrivilegesWith

doesHaveWeakPrivilegesWith

doesHavePriviledgesHere

doesHaveWeakPriviledgesHere

doesHaveClanFriendlyPrivilegesHere

doesAnyoneHavePrivilegesHere

getPropertyOwnerName

getLandOwnerName

isLandOwnable

isLandOwnersName

isPropertyOwnersName

doesOwnThisProperty

doesOwnThisProperty

getPropertyOwner

canAttackThisProperty

getClericInfusion

getClericInfused

doesOwnThisLand

isLegalOfficerHere

isLegalJudgeHere

isLegalOfficialHere

colorRoomForSale

shopkeeperMobPresent

robberyCheck

getPropertyRecord

mayOwnThisItem