Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface LegalLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

MUDLaw

public interface LegalLibrary
extends CMLibrary

The primary legal matters handled by this library are property law: who is permitted to do what, where. It also handles access to legal codes, and manages standards related to property transfer markers and property titles.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INDOORSTR	The default room title for an indoor room These get localized later.
static java.lang.String	OUTDOORSTR	The default room title for an outdoor room These get localized later.
static java.lang.String	RENTSTR	The default room description for a room for rent These get localized later.
static java.lang.String	SALESTR	The default room description for a room for sale These get localized later.

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

idConverter

Method Summary

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.
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.
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.
boolean	isACity(Area A)	Returns whether the stats for the given area reflect that it is legally considered a City.
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.

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, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

SALESTR

static final java.lang.String SALESTR

The default room description for a room for sale These get localized later.

See Also:

Constant Field Values

RENTSTR

static final java.lang.String RENTSTR

The default room description for a room for rent These get localized later.

See Also:

Constant Field Values

INDOORSTR

static final java.lang.String INDOORSTR

The default room title for an indoor room These get localized later.

See Also:

Constant Field Values

OUTDOORSTR

static final java.lang.String OUTDOORSTR

The default room title for an outdoor room These get localized later.

See Also:

Constant Field Values

Method Detail

getTheLaw

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.

Parameters:

R - the room to check

Returns:

null, or the legal policies

See Also:

getLegalObject(Area), getLegalBehavior(Area), getLegalObject(Room), getLegalBehavior(Room)

getLegalBehavior

LegalBehavior getLegalBehavior(Area A)

If an area is subject to law and order, this method will return the legal system that applies to it.

Parameters:

A - the area to check

Returns:

null, or the legal system

See Also:

getTheLaw(Room), getLegalObject(Area), getLegalObject(Room), getLegalBehavior(Room)

getLegalObject

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.

Parameters:

A - the area to check

Returns:

null, or the legal area

See Also:

getTheLaw(Room), getLegalBehavior(Area), getLegalObject(Room), getLegalBehavior(Room)

getLegalBehavior

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.

Parameters:

R - the room to check

Returns:

null, or the legal system

See Also:

getTheLaw(Room), getLegalObject(Area), getLegalBehavior(Area), getLegalObject(Room)

getLegalObject

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.

Parameters:

R - the room to check

Returns:

null, or the legal area

See Also:

getTheLaw(Room), getLegalObject(Area), getLegalBehavior(Area), getLegalBehavior(Room)

getLandOwnerName

java.lang.String getLandOwnerName(Room room)

Returns the name of the owner of the given room. This might include its area.

Parameters:

room - the room to check

Returns:

"", or the name of the owner

See Also:

getPropertyOwnerName(Room), isLandOwnable(Room)

isLandOwnable

boolean isLandOwnable(Room room)

Returns whether the given room has a land title that makes it possible to own, which might include the area.

Parameters:

room - the room to check

Returns:

true if it can be privately owned

See Also:

getPropertyOwnerName(Room), getLandOwnerName(Room)

getPropertyOwnerName

java.lang.String getPropertyOwnerName(Room room)

Returns the name of the owner of the given room. This might include its area.

Parameters:

room - the room to check

Returns:

"" or the name of the owner

See Also:

isLandOwnable(Room), getLandOwnerName(Room)

colorRoomForSale

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. Will save the room info to the DB.

Parameters:

R - the room that's for sale

title - the rooms land title

reset - reset the room description

getLandTitle

LandTitle getLandTitle(Area area)

Returns the private property record of the given area, if one exists.

Parameters:

area - the area to check

Returns:

null, or the LandTitle record

See Also:

getPropertyRecord(Room), getPropertyRecord(Area), getPropertyRecord(Item), getPropertyRecord(MOB), getLandTitle(Room)

getLandTitle

LandTitle getLandTitle(Room room)

Returns the private property record of the given room, if one exists, or its area.

Parameters:

room - the room to check

Returns:

null, or the LandTitle record

See Also:

getPropertyRecord(Room), getPropertyRecord(Area), getPropertyRecord(Item), getPropertyRecord(MOB), getLandTitle(Area)

getPropertyRecord

PrivateProperty getPropertyRecord(Area area)

Returns the private property record of the given area, if one existsa. This could also be in a boardable.

Parameters:

area - the area to check

Returns:

null, or the privateproperty record

See Also:

getPropertyRecord(Room), getPropertyRecord(Item), getPropertyRecord(MOB), getLandTitle(Area), getLandTitle(Room)

getPropertyRecord

PrivateProperty getPropertyRecord(MOB mob)

Returns the private property record of the given mob, if one exists. Slaves happen.

Parameters:

mob - the mob to check

Returns:

null, or the privateproperty record

See Also:

getPropertyRecord(Room), getPropertyRecord(Item), getPropertyRecord(Area), getLandTitle(Area), getLandTitle(Room)

getPropertyRecord

PrivateProperty getPropertyRecord(Room room)

Returns the private property record of the given room, if one exists, or its area. This could also be in a boardable.

Parameters:

room - the room to check

Returns:

null, or the privateproperty record

See Also:

getPropertyRecord(Area), getPropertyRecord(Item), getPropertyRecord(MOB), getLandTitle(Area), getLandTitle(Room)

getPropertyRecord

PrivateProperty getPropertyRecord(Item item)

Returns the private property record of the given item, if one exists. This could be carryables or boardables.

Parameters:

item - the item to check

Returns:

null, or the privateproperty record

See Also:

getPropertyRecord(Area), getPropertyRecord(Room), getPropertyRecord(MOB), getLandTitle(Area), getLandTitle(Room)

isRoomSimilarlyTitled

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.

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

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. Does not return any upstairs or downstairs rooms.

Parameters:

room - the room to check

doneRooms - a required set to put all peer rooms in

Returns:

the given set

See Also:

isHomeRoomUpstairs(Room), isHomeRoomDownstairs(Room)

isHomeRoomDownstairs

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. Caves generally don't count. If a room has no upstairs, it can't be downstairs.

Parameters:

room - the room to check whether it is downstairs

Returns:

true if the given room is upstairs

See Also:

isHomeRoomUpstairs(Room), getHomePeersOnThisFloor(Room, Set)

isHomeRoomUpstairs

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. Caves generally don't count.

Parameters:

room - the room to check whether it is upstairs

Returns:

true if the given room is upstairs

See Also:

isHomeRoomDownstairs(Room), getHomePeersOnThisFloor(Room, Set)

doesAnyoneHavePrivilegesHere

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

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:

doesHavePrivilegesWith(MOB, PrivateProperty), doesHavePriviledgesHere(MOB, Room), doesHavePriviledgesInThisDirection(MOB, Room, Exit)

doesHavePriviledgesHere

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. Followers don't matter. This returns whether the given mob has normal privileges in the given room.

Parameters:

mob - the mob

room - the room

Returns:

true if the mob has normal privileges in the room

See Also:

doesHavePrivilegesWith(MOB, PrivateProperty), doesAnyoneHavePrivilegesHere(MOB, String, Room), doesHavePriviledgesInThisDirection(MOB, Room, Exit)

doesHavePriviledgesInThisDirection

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

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:

doesHavePrivilegesWith(MOB, PrivateProperty), doesAnyoneHavePrivilegesHere(MOB, String, Room), doesHavePriviledgesHere(MOB, Room)

doesHavePrivilegesWith

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. Followers don't matter.

Parameters:

mob - the mob to check

record - the property to check

Returns:

true if the mob has normal privileges with the property

See Also:

doesHaveWeakPrivilegesWith(MOB, PrivateProperty), doesHavePriviledgesInThisDirection(MOB, Room, Exit), doesHavePriviledgesHere(MOB, Room), doesAnyoneHavePrivilegesHere(MOB, String, Room)

doesHaveWeakPrivilegesWith

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

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:

doesHaveWeakPriviledgesHere(MOB, Room)

doesHaveWeakPriviledgesHere

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

Parameters:

mob - the mob to check

room - the room to check

Returns:

true if the mob has weak privileges in the room

See Also:

doesHaveWeakPrivilegesWith(MOB, PrivateProperty)

isLandOwnersName

boolean isLandOwnersName(java.lang.String name,
                         Room room)

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.

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:

doesOwnThisLand(MOB, Room)

doesOwnThisLand

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.

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:

isLandOwnersName(String, Room)

mayOwnThisItem

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

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:

doesHavePrivilegesWith(MOB, PrivateProperty), doesHaveWeakPrivilegesWith(MOB, PrivateProperty)

isPropertyOwnersName

boolean isPropertyOwnersName(java.lang.String name,
                             Room room)

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.

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:

doesOwnThisProperty(MOB, PrivateProperty), doesOwnThisProperty(MOB, Room)

doesOwnThisProperty

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.

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:

doesOwnThisProperty(MOB, PrivateProperty), isPropertyOwnersName(String, Room)

doesOwnThisProperty

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.

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:

doesOwnThisProperty(MOB, Room), isPropertyOwnersName(String, Room)

robberyCheck

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

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:

doesHavePriviledgesHere(MOB, Room)

getPropertyOwner

MOB getPropertyOwner(PrivateProperty record)

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.

Parameters:

record - the property record

Returns:

the property owner mob

canAttackThisProperty

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.

Parameters:

mob - the attacker

record - the property record for the given property

Returns:

true if the attacker is allowed to attack it

getAllUniqueLandTitles

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

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

getClericInfusion

Deity.DeityWorshipper getClericInfusion(Physical P)

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.

Parameters:

P - the thing to check for infusion

Returns:

null, or a deityworshipper object

See Also:

Deity.DeityWorshipper

getClericInfused

java.lang.String getClericInfused(Physical P)

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.

Parameters:

P - the thing to check for infusion

Returns:

null, or the name of a deity

isLegalOfficerHere

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.

Parameters:

mob - the mob to check

Returns:

true if a Police Officer, false otherwise

See Also:

isLegalJudgeHere(MOB), isLegalOfficialHere(MOB)

isLegalJudgeHere

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.

Parameters:

mob - the mob to check

Returns:

true if a judge, false otherwise

See Also:

isLegalOfficerHere(MOB), isLegalOfficialHere(MOB)

isLegalOfficialHere

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.

Parameters:

mob - the mob to check

Returns:

true if judge/officer, false otherwise

See Also:

isLegalJudgeHere(MOB), isLegalOfficerHere(MOB)

isACity

boolean isACity(Area A)

Returns whether the stats for the given area reflect that it is legally considered a City.

Parameters:

A - the area to check

Returns:

true if its a city, false otherwise