Package com.planet_ink.coffee_mud.Items.Basic

Class StdLawBook

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Basic.StdLawBook

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenLawBook

public class StdLawBook
extends StdItem

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[][]	lawflags
static java.lang.String[][]	locflags

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

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

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
StdLawBook()

Method Summary

Modifier and Type	Method	Description
void	changeTheLaw(Environmental A, LegalBehavior B, MOB mob, Law theLaw, java.lang.String tag, java.lang.String newValue)
void	doBannedSubstances(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doBasicLaw(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doIllegalEmotation(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doIllegalInfluence(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doIllegalSkill(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doJailPolicy(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doOfficersAndJudges(Area A, LegalBehavior B, Area legalO, Law theLaw, MOB mob, boolean allowedToModify)
void	doParoleAndRelease(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doTaxLaw(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doTresspassingLaw(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	doVictimsOfCrime(Area A, LegalBehavior B, Law theLaw, MOB mob, boolean allowedToModify)
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
java.lang.String	genericName()	Returns a generic name for this object, devoid of its particular identifying details.
java.lang.String	getFromTOC(java.lang.String tag)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String[]	modifyLaw(Area A, LegalBehavior B, Law theLaw, MOB mob, java.lang.String[] oldLaw)
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
java.lang.String	shortLawDesc(java.lang.String[] bits)
java.lang.String	shortLawHeader()

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.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

locflags

public static final java.lang.String[][] locflags

lawflags

public static final java.lang.String[][] lawflags

Constructor Detail

StdLawBook

public StdLawBook()

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 StdItem

Returns:

the name of this class

genericName

public java.lang.String genericName()

Description copied from interface: Physical

Returns a generic name for this object, devoid of its particular identifying details. e.g. for a mob, this would return the age-range and race of this mob, as if it were someone spotted on the street that you didn't know.

Specified by:

genericName in interface Physical

Overrides:

genericName in class StdItem

Returns:

the generic name of this thing

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

getFromTOC

public java.lang.String getFromTOC(java.lang.String tag)

changeTheLaw

public void changeTheLaw(Environmental A,
                         LegalBehavior B,
                         MOB mob,
                         Law theLaw,
                         java.lang.String tag,
                         java.lang.String newValue)

shortLawDesc

public java.lang.String shortLawDesc(java.lang.String[] bits)

shortLawHeader

public java.lang.String shortLawHeader()

modifyLaw

public java.lang.String[] modifyLaw(Area A,
                                    LegalBehavior B,
                                    Law theLaw,
                                    MOB mob,
                                    java.lang.String[] oldLaw)
                             throws java.io.IOException

Throws:

java.io.IOException

doIllegalEmotation

public void doIllegalEmotation(Area A,
                               LegalBehavior B,
                               Law theLaw,
                               MOB mob,
                               boolean allowedToModify)
                        throws java.io.IOException

Throws:

java.io.IOException

doBannedSubstances

public void doBannedSubstances(Area A,
                               LegalBehavior B,
                               Law theLaw,
                               MOB mob,
                               boolean allowedToModify)
                        throws java.io.IOException

Throws:

java.io.IOException

doIllegalSkill

public void doIllegalSkill(Area A,
                           LegalBehavior B,
                           Law theLaw,
                           MOB mob,
                           boolean allowedToModify)
                    throws java.io.IOException

Throws:

java.io.IOException

doTaxLaw

public void doTaxLaw(Area A,
                     LegalBehavior B,
                     Law theLaw,
                     MOB mob,
                     boolean allowedToModify)
              throws java.io.IOException

Throws:

java.io.IOException

doIllegalInfluence

public void doIllegalInfluence(Area A,
                               LegalBehavior B,
                               Law theLaw,
                               MOB mob,
                               boolean allowedToModify)
                        throws java.io.IOException

Throws:

java.io.IOException

doBasicLaw

public void doBasicLaw(Area A,
                       LegalBehavior B,
                       Law theLaw,
                       MOB mob,
                       boolean allowedToModify)
                throws java.io.IOException

Throws:

java.io.IOException

doParoleAndRelease

public void doParoleAndRelease(Area A,
                               LegalBehavior B,
                               Law theLaw,
                               MOB mob,
                               boolean allowedToModify)
                        throws java.io.IOException

Throws:

java.io.IOException

doJailPolicy

public void doJailPolicy(Area A,
                         LegalBehavior B,
                         Law theLaw,
                         MOB mob,
                         boolean allowedToModify)
                  throws java.io.IOException

Throws:

java.io.IOException

doTresspassingLaw

public void doTresspassingLaw(Area A,
                              LegalBehavior B,
                              Law theLaw,
                              MOB mob,
                              boolean allowedToModify)
                       throws java.io.IOException

Throws:

java.io.IOException

doVictimsOfCrime

public void doVictimsOfCrime(Area A,
                             LegalBehavior B,
                             Law theLaw,
                             MOB mob,
                             boolean allowedToModify)
                      throws java.io.IOException

Throws:

java.io.IOException

doOfficersAndJudges

public void doOfficersAndJudges(Area A,
                                LegalBehavior B,
                                Area legalO,
                                Law theLaw,
                                MOB mob,
                                boolean allowedToModify)
                         throws java.io.IOException

Throws:

java.io.IOException