BookLoaning

java.lang.Object
- com.planet_ink.coffee_mud.Abilities.StdAbility
- - com.planet_ink.coffee_mud.Abilities.Common.CommonSkill
  - - com.planet_ink.coffee_mud.Abilities.Common.BookLoaning

All Implemented Interfaces:

Ability, CMObject, Contingent, Economics, Environmental, Expireable, Modifiable, MsgListener, ShopKeeper, StatsAffecting, Tickable, Librarian, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class BookLoaning
extends CommonSkill
implements ShopKeeper, Librarian
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.Librarian
  Librarian.CheckedOutRecord
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ShopKeeper
  ShopKeeper.ShopPrice, ShopKeeper.ViewType

Field Summary

Fields
Modifier and Type Field Description

protected Item approvedI

protected java.lang.String approvedMob

protected CoffeeShop curShop

protected CoffeeShop shop
- Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability
  ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DESCS_, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_TECH, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CACHEINDEX_CLASSLESS, CACHEINDEX_EXPERTISE, CACHEINDEX_LASTTIME, CACHEINDEX_NORMAL, CACHEINDEX_TOTAL, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, COST_ALL, COST_NORMAL, COST_PCT, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_BUILDINGSKILL, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_COSMOLOGY, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_EDUCATIONLORE, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EPICUREAN, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_ROPEUSE, DOMAIN_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_TRAVEL, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WATERCONTROL, DOMAIN_WATERLORE, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_ADJUSTER, FLAG_AGGROFYING, FLAG_AIRBASED, FLAG_BINDING, FLAG_CASTER, FLAG_CHAOS, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ELECTRICBASED, FLAG_ENABLER, FLAG_FEARING, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_LAW, FLAG_MINDALTERING, FLAG_MODERATE, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NODISENCHANT, FLAG_NONENCHANTMENT, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_STEALING, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, POWER_COST_THRESHOLD, POWER_LEVEL_THRESHOLD, POWER_OVERRIDE_THRESHOLD, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, TICKS_ALMOST_FOREVER, TICKS_FOREVER, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_COUNT, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT, USAGEINDEX_TIMELSW, USAGEINDEX_TOTAL
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
  idConverter
- Fields inherited from class com.planet_ink.coffee_mud.Abilities.Common.CommonSkill
  aborted, activityRoom, bonusYield, bundling, displayText, fakeFire, helping, helpingAbility, lastBaseDuration, playSound, resourcesMap, tickUp, uninvokeEmpties, verb
- Fields inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.Librarian
  DEFAULT_MAX_BORROWED, DEFAULT_MAX_OVERDUE_DAYS, DEFAULT_MIN_OVERDUE_CHARGE, DEFAULT_MIN_OVERDUE_DAILY, DEFAULT_MIN_OVERDUE_DAYS, DEFAULT_PCT_OVERDUE_CHARGE, DEFAULT_PCT_OVERDUE_DAILY
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.ShopKeeper
  DEAL_ALCHEMIST, DEAL_ANYTECHNOLOGY, DEAL_ANYTHING, DEAL_ARMOR, DEAL_AUCTIONEER, DEAL_BANKER, DEAL_BOOKS, DEAL_BUTCHER, DEAL_CASTER, DEAL_CLANBANKER, DEAL_CLANDSELLER, DEAL_CLANPOSTMAN, DEAL_CLOTHSPINNER, DEAL_CONFLICTS, DEAL_CSHIPSELLER, DEAL_DESCS, DEAL_FOODSELLER, DEAL_GENERAL, DEAL_GROWER, DEAL_HIDESELLER, DEAL_INNKEEPER, DEAL_INSTRUMENTS, DEAL_INVENTORYONLY, DEAL_JEWELLER, DEAL_LANDSELLER, DEAL_LEATHER, DEAL_LUMBERER, DEAL_MAGIC, DEAL_METALSMITH, DEAL_PETS, DEAL_POSTMAN, DEAL_READABLES, DEAL_SHIPSELLER, DEAL_SLAVES, DEAL_STONEYARDER, DEAL_TRAINER, DEAL_WEAPONS
- Fields inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility
  affected, amDestroyed, canBeUninvoked, empty, invoker, isAnAutoEffect, lastCastHelp, miscText, proficiency, savable, tickDown, unInvoked
- 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
Modifier and Type	Field	Description
`protected Item`	`approvedI`
`protected java.lang.String`	`approvedMob`
`protected CoffeeShop`	`curShop`
`protected CoffeeShop`	`shop`

Constructor Summary

Constructors
Constructor Description

BookLoaning()

Constructors
Constructor	Description
`BookLoaning()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addSoldType(int mask)`	Adds the ShopKeeper DEAL_* constants describing what is sold or bought by this ShopKeeper to the existing shopkeeper mask.
`void`	`affectPhyStats(Physical E, PhyStats affectableStats)`	This method is called by the recoverPhyStats() method on other Environmental objects.
`void`	`autoGive(MOB src, MOB tgt, Item I)`
`boolean`	`autoInvocation(MOB mob, boolean force)`	An autoinvocating ability is an ability which affects the mob just by having learned the ability.
`protected int`	`canAffectCode()`	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
`boolean`	`canBeUninvoked()`	Whether this skill is allowed to be uninvoked.
`boolean`	`canPossiblyLoan(Environmental E, Environmental what)`
`protected int`	`canTargetCode()`	Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
`int`	`classificationCode()`	Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
`java.lang.String`	`contributorMask()`	Returns the mask used to determine if a contributor is ignored by the Librarian for contribution.
`CMObject`	`copyOf()`	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
`MOB`	`deriveLibrarian(MOB roomHelper)`
`void`	`destroy()`	Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
`boolean`	`doISellThis(Environmental thisThang)`	Returns whether this ShopKeeper deals in the type of item passed in.
`void`	`executeMsg(Environmental myHost, CMMsg msg)`	The general message event handler for the object.
`java.util.List<Librarian.CheckedOutRecord>`	`getAllMyRecords(java.lang.String name)`
`CoffeeShop`	`getBaseLibrary()`	Returns the underlying basic book stock of the library, as opposed to the current shop, which reflects only what is there at the moment.
`double`	`getDailyOverdueCharge()`	Gets the daily base currency charge due every day a withdrawn item remains overdue.
`double`	`getDailyOverdueChargePct()`	Gets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due every day that a withdrawn item remains overdue.
`Pair<java.lang.Long,TimeClock.TimePeriod>`	`getFinalBudget()`	Returns a description of the buying budget of the shopkeeper.
`java.lang.String`	`getFinalCurrency()`	Gets the derived currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
`double[]`	`getFinalDevalueRate()`	Returns a double array describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
`java.lang.String`	`getFinalIgnoreMask()`	Returns the mask used to determine if a customer is ignored by the ShopKeeper.
`int`	`getFinalInvResetRate()`	Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
`java.lang.String[]`	`getFinalItemPricingAdjustments()`	A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
`java.lang.String`	`getFinalPrejudiceFactors()`	A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
`java.util.List<Librarian.CheckedOutRecord>`	`getItemRecords(java.lang.String itemName)`
`protected java.lang.String`	`getLibraryShopKey()`
`int`	`getMaxBorrowed()`	Gets the maximum number of items that one person can have checked out at any given time.
`int`	`getMaxOverdueDays()`	Gets the maximum number of mud-days that an item can be checked out.
`int`	`getMinOverdueDays()`	Gets the number of mud-days that an item can be checked out before being overdue.
`protected TimeClock`	`getMyClock()`
`double`	`getOverdueCharge()`	Gets the minimum base currency charge due the moment a withdrawn item becomes overdue.
`double`	`getOverdueChargePct()`	Gets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due the moment a withdrawn item becomes overdue.
`java.lang.String`	`getRawBbudget()`	Returns a description of the buying budget of the shopkeeper.
`java.lang.String`	`getRawCurrency()`	Gets the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
`java.lang.String`	`getRawDevalueRate()`	Returns a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
`java.lang.String`	`getRawIgnoreMask()`	Returns the mask used to determine if a customer is ignored by the ShopKeeper.
`int`	`getRawInvResetRate()`	Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
`java.lang.String[]`	`getRawItemPricingAdjustments()`	A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
`java.lang.String`	`getRawPrejudiceFactors()`	A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
`protected CostDef`	`getRawTrainingCost()`
`Librarian.CheckedOutRecord`	`getRecord(java.lang.String playerName, java.lang.String itemName)`
`protected java.lang.String`	`getRecordsXML()`
`CoffeeShop`	`getShop()`	the CoffeeShop method to access the shopkeepers store of goods
`protected Area`	`getStartArea()`
`protected double`	`getTotalOverdueCharges(java.lang.String name)`
`long`	`getWhatIsSoldMask()`	Returns the ShopKeeper DEAL_* mask describing what is sold or bought by this ShopKeeper
`java.lang.String`	`getWhatIsSoldZappermask()`	Returns the zapper mask which applies to items to determine whether they are bought and sold by this shopkeeper.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`boolean`	`invoke(MOB mob, java.util.List<java.lang.String> commands, Physical givenTarget, boolean auto, int asLevel)`	This method is called when a player or the system invokes this skill, casts this spell, etc.
`protected boolean`	`isActive(MOB mob)`
`protected boolean`	`isAPossiblePayback(MOB mob, Environmental tool)`
`boolean`	`isAutoInvoked()`	An autoinvocating ability is an ability which affects the mob just by having learned the ability.
`boolean`	`isSold(int mask)`	Returns whether the given type of good is sold by this shopkeeper.
`java.lang.String`	`libraryChain()`	Gets the name of the library chain to which this librarian belongs.
`protected Room`	`location()`
`protected void`	`makeActive(MOB mob)`
`java.lang.String`	`name()`	The nice displayable name of this instance of this object
`CMObject`	`newInstance()`	Returns a new instance of this class.
`boolean`	`okMessage(Environmental myHost, CMMsg msg)`	The general message event previewer for the object.
`int`	`overrideMana()`	amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT
`protected void`	`parseRecords(java.lang.String text)`
`protected boolean`	`processCheckedOutRecord(Librarian.CheckedOutRecord rec)`
`boolean`	`putUpForLoan(MOB source, MOB merchantM, Environmental tool)`
`void`	`setBudget(java.lang.String factors)`	Sets a description of the buying budget of the shopkeeper.
`void`	`setContributorMask(java.lang.String mask)`	Sets the mask used to determine if a contributor is ignored by the Librarian for contribution.
`void`	`setCurrency(java.lang.String newCurrency)`	Returns the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
`void`	`setDailyOverdueCharge(double charge)`	Sets the daily base currency charge due every day a withdrawn item remains overdue.
`void`	`setDailyOverdueChargePct(double pct)`	Sets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due every day that a withdrawn item remains overdue.
`void`	`setDevalueRate(java.lang.String factors)`	Sets a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
`void`	`setIgnoreMask(java.lang.String factors)`	Sets the mask used to determine if a customer is ignored by the ShopKeeper.
`void`	`setInvResetRate(int ticks)`	Sets the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
`void`	`setItemPricingAdjustments(java.lang.String[] factors)`	Sets the string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
`void`	`setLibraryChain(java.lang.String name)`	Sets the name of the library chain to which this librarian belongs.
`void`	`setMaxBorrowed(int items)`	Sets the maximum number of items that one person can have checked out at any given time.
`void`	`setMaxOverdueDays(int days)`	Sets the maximum number of mud-days that an item can be checked out.
`void`	`setMinOverdueDays(int days)`	Sets the number of mud-days that an item can be checked out before being overdue.
`void`	`setMiscText(java.lang.String text)`	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
`void`	`setOverdueCharge(double charge)`	Sets the minimum base currency charge due the moment a withdrawn item becomes overdue.
`void`	`setOverdueChargePct(double pct)`	Sets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due the moment a withdrawn item becomes overdue.
`void`	`setPrejudiceFactors(java.lang.String factors)`	Sets the string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
`void`	`setWhatIsSoldMask(long newSellCode)`	Sets the encoded ShopKeeper DEAL_* constants describing what is sold or bought by this ShopKeeper
`void`	`setWhatIsSoldZappermask(java.lang.String newSellMask)`	Sets the zapper mask which applies to items to determine whether they are bought and sold by this shopkeeper.
`java.lang.String`	`storeKeeperString()`	Based on the value of this ShopKeepers whatIsSold() method, this will return a displayable string describing that type.
`java.lang.String`	`text()`	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`java.lang.String[]`	`triggerStrings()`	A set of the command strings the user types to access this command when it is listed as a skill ability.
`protected void`	`updateCheckedOutRecords()`
`java.util.Set<ShopKeeper.ViewType>`	`viewFlags()`	The ShopKeeper item view flags for determining what a player sees from items in this shopkeepers inventory.

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

Methods inherited from class com.planet_ink.coffee_mud.Abilities.Common.CommonSkill
abilityCode, abstractQuality, addedTickTime, allowedInTheDark, allowedWhileMounted, baseYield, bumpTickDown, canBeDoneSittingDown, canBeLearnedBy, checkStop, commonEmote, confirmPossibleMaterialLocation, displayText, dropAWinner, dropAWinner, getActivityMessageType, getAlmostDoneMessage, getBrand, getBrand, getCompletedActivityMessageType, getDuration, getMyCodeNum, getOthersContinueMessage, getRequiredFire, getStat, getStatCodes, getUninvokeException, getYouContinueMessage, iniPracticesToPractice, isMadeOfSupportedResource, loadList, loadRecipes, lookingForMat, lookingForMat, lookingForRsc, lookingForRsc, setAbilityCode, setBrand, setStat, setTickUp, startTickDown, supportedResourcesMap, supportedResourceString, teach, unInvoke, usageCost, usageType, xlevel

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent
amDestroyed, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental
description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setName

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable
expirationDate, setExpirationDate

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable
getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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.core.interfaces.StatsAffecting
affectCharState, affectCharStats

Methods inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility
accountForYourself, adjustBeneficialTickdownTime, adjustedLevel, adjustedMaxInvokerRange, adjustMaliciousTickdownTime, affectCharState, affectCharStats, affecting, amDestroyed, aPossibleAbuserOfCasterLevel, appropriateToMyFactions, beneficialAffect, beneficialSoundFizzle, beneficialVisualFizzle, beneficialWordsFizzle, bubbleAffect, buildCostArray, canAffect, canAffect, canBePracticedBy, canBeTaughtBy, canTarget, canTarget, castingQuality, castingQuality, castingTime, checkComponents, checkedCastingCost, checkTargetRange, cloneFix, combatCastingTime, commonTell, commonTelL, commonTelL, compareTo, description, disregardsArmorCheck, enchantQuality, evalTargetItem, expertise, expirationDate, externalFiles, failureTell, flags, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getAnyTarget, getBeneficialTickdownTime, getCodeNum, getHardOverrideManaCache, getInternalCodeNum, getMaliciousTickdownTime, getPersonalLevelAdjustments, getSaveStatIndex, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTarget, getTargetItemFavorMOB, getTargetItemFavorMOB, getTargetItemFavorMOB, getTickDownRemaining, getTicksBetweenCasts, getTickStatus, getTimeOfNextCast, getTrainingCost, getVisibleRoomTarget, getX1Level, getX2Level, getX3Level, getX4Level, getX5Level, getXLEVELLevel, getXLOWCOSTLevel, getXLOWFREECOSTLevel, getXMAXRANGELevel, getXPCOSTAdjustment, getXPCOSTLevel, getXTIMELevel, helpProficiency, I, ignoreCompounding, image, initializeClass, invoke, invoker, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maliciousAffect, maliciousFizzle, maxRange, mayBeEnchanted, minCastWaitTime, minRange, miscTextFormat, modifyCastCode, Name, possibleContainer, practice, practicesToPractice, preInvoke, proficiency, proficiencyCheck, properTargetList, properTargets, putInCommandlist, rawImage, requirements, restoreCombatState, sameAs, saveCombatState, setAffectedOne, setDescription, setDisplayText, setExpirationDate, setImage, setInvoker, setName, setProficiency, setSavable, setTickDown, setTickDownRemaining, setTimeOfNextCast, setTimeOfNextCast, somaticCastCode, somaticCastMask, spreadImmunity, testUsageCost, unlearn, verbalCastCode, verbalCastMask, verbalSpeakCode

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
getTickStatus

- Field Detail
  - curShop
```
protected volatile CoffeeShop curShop
```
  - shop
```
protected CoffeeShop shop
```
  - approvedI
```
protected volatile Item approvedI
```
  - approvedMob
```
protected volatile java.lang.String approvedMob
```
- Constructor Detail
  - BookLoaning
```
public BookLoaning()
```
- 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 CommonSkill
    
    Returns:
    
    the name of this class
  - name
```
public java.lang.String name()
```
    Description copied from interface: Tickable
    
    The nice displayable name of this instance of this object
    
    Specified by:
    
    name in interface CMObject
    
    Specified by:
    
    name in interface Tickable
    
    Overrides:
    
    name in class CommonSkill
    
    Returns:
    
    the displayable name of this object instance
    
    See Also:
    
    Environmental.Name()
  - triggerStrings
```
public java.lang.String[] triggerStrings()
```
    Description copied from interface: Ability
    
    A set of the command strings the user types to access this command when it is listed as a skill ability.
    
    Specified by:
    
    triggerStrings in interface Ability
    
    Overrides:
    
    triggerStrings in class CommonSkill
    
    Returns:
    
    an array of command invoking string words
    
    See Also:
    
    Ability.putInCommandlist()
  - overrideMana
```
public int overrideMana()
```
    Description copied from class: StdAbility
    
    amount of mana/move used by this ability, overriding ini file -1=normal, Ability.COST_ALL=all, Ability.COST_PCT
    
    Overrides:
    
    overrideMana in class StdAbility
    
    Returns:
    
    amount of mana/move used by this ability, overriding ini file
  - isAutoInvoked
```
public boolean isAutoInvoked()
```
    Description copied from interface: Ability
    
    An autoinvocating ability is an ability which affects the mob just by having learned the ability. Dodge is an example of this. This method returns whether this skill is classified as one of those kinds of abilities.
    
    Specified by:
    
    isAutoInvoked in interface Ability
    
    Overrides:
    
    isAutoInvoked in class StdAbility
    
    Returns:
    
    whether this is an autoinvoking skill
  - canBeUninvoked
```
public boolean canBeUninvoked()
```
    Description copied from interface: Ability
    
    Whether this skill is allowed to be uninvoked. If it returns false, then it behaves as a permanent property of the object it is affecting. Not death, dispelling, or other negations will remove it.
    
    Specified by:
    
    canBeUninvoked in interface Ability
    
    Overrides:
    
    canBeUninvoked in class StdAbility
    
    Returns:
    
    whether this skill can be uninvoked.
    
    See Also:
    
    Ability.makeNonUninvokable()
  - getRawTrainingCost
```
protected CostDef getRawTrainingCost()
```
    Overrides:
    
    getRawTrainingCost in class CommonSkill
  - canAffectCode
```
protected int canAffectCode()
```
    Description copied from class: StdAbility
    
    Designates whether, when used as a property/effect, what sort of objects this ability can affect. Uses the Ability.CAN_* constants.
    
    Overrides:
    
    canAffectCode in class CommonSkill
    
    Returns:
    
    a mask showing the type of objects this ability can affect
    
    See Also:
    
    Ability
  - canTargetCode
```
protected int canTargetCode()
```
    Description copied from class: StdAbility
    
    Designates whether, when invoked as a skill, what sort of objects this ability can effectively target. Uses the Ability.CAN_* constants.
    
    Overrides:
    
    canTargetCode in class CommonSkill
    
    Returns:
    
    a mask showing the type of objects this ability can target
    
    See Also:
    
    Ability
  - classificationCode
```
public int classificationCode()
```
    Description copied from interface: Ability
    
    Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain. It is made up of the ACODE_* constants the Ability interface, and optionally the DOMAIN_* constants also defined in this interface.
    
    Specified by:
    
    classificationCode in interface Ability
    
    Overrides:
    
    classificationCode in class CommonSkill
    
    Returns:
    
    ACODE_* constant classification
    
    See Also:
    
    Ability
  - getMyClock
```
protected TimeClock getMyClock()
```
  - copyOf
```
public CMObject copyOf()
```
    Description copied from interface: CMObject
    
    Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
    
    Specified by:
    
    copyOf in interface CMObject
    
    Overrides:
    
    copyOf in class StdAbility
    
    Returns:
    
    a clone of this object
  - newInstance
```
public CMObject newInstance()
```
    Description copied from interface: CMObject
    
    Returns a new instance of this class.
    
    Specified by:
    
    newInstance in interface CMObject
    
    Overrides:
    
    newInstance in class StdAbility
    
    Returns:
    
    a new instance of this class
  - getShop
```
public CoffeeShop getShop()
```
    Description copied from interface: ShopKeeper
    
    the CoffeeShop method to access the shopkeepers store of goods
    
    Specified by:
    
    getShop in interface ShopKeeper
    
    Returns:
    
    the CoffeeShop object
    
    See Also:
    
    CoffeeShop
  - getRecordsXML
```
protected java.lang.String getRecordsXML()
```
  - viewFlags
```
public java.util.Set<ShopKeeper.ViewType> viewFlags()
```
    Description copied from interface: ShopKeeper
    
    The ShopKeeper item view flags for determining what a player sees from items in this shopkeepers inventory. This list is dynamic and can be changed at will... no protections whatever.
    
    Specified by:
    
    viewFlags in interface ShopKeeper
    
    Returns:
    
    the set of valid view type flags.
  - text
```
public java.lang.String text()
```
    Description copied from interface: Environmental
    
    For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.
    
    Specified by:
    
    text in interface Environmental
    
    Overrides:
    
    text in class StdAbility
    
    Returns:
    
    either an open internal text string, or XML
  - getRawBbudget
```
public java.lang.String getRawBbudget()
```
    Description copied from interface: Economics
    
    Returns a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.
    
    Specified by:
    
    getRawBbudget in interface Economics
    
    Returns:
    
    the string for the shopkeepers buying budget
  - setBudget
```
public void setBudget(java.lang.String factors)
```
    Description copied from interface: Economics
    
    Sets a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.
    
    Specified by:
    
    setBudget in interface Economics
    
    Parameters:
    
    factors - the string for the shopkeepers buying budget
  - getRawDevalueRate
```
public java.lang.String getRawDevalueRate()
```
    Description copied from interface: Economics
    
    Returns a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of "0 0" would mean no drop in price for either, ever.
    
    Specified by:
    
    getRawDevalueRate in interface Economics
    
    Returns:
    
    the price dropping percentage rule for this shopkeeper
  - setDevalueRate
```
public void setDevalueRate(java.lang.String factors)
```
    Description copied from interface: Economics
    
    Sets a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of "0 0" would mean no drop in price for either, ever.
    
    Specified by:
    
    setDevalueRate in interface Economics
    
    Parameters:
    
    factors - the price dropping percentage rule for this shopkeeper
  - getRawInvResetRate
```
public int getRawInvResetRate()
```
    Description copied from interface: Economics
    
    Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
    
    Specified by:
    
    getRawInvResetRate in interface Economics
    
    Returns:
    
    the number of ticks between total resets of inventory
  - getFinalCurrency
```
public java.lang.String getFinalCurrency()
```
    Description copied from interface: Economics
    
    Gets the derived currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.
    
    Specified by:
    
    getFinalCurrency in interface Economics
    
    Returns:
    
    a currency name/definition
  - getRawCurrency
```
public java.lang.String getRawCurrency()
```
    Description copied from interface: Economics
    
    Gets the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.
    
    Specified by:
    
    getRawCurrency in interface Economics
    
    Returns:
    
    a currency name/definition or NULL to derive
  - setCurrency
```
public void setCurrency(java.lang.String newCurrency)
```
    Description copied from interface: Economics
    
    Returns the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.
    
    Specified by:
    
    setCurrency in interface Economics
    
    Parameters:
    
    newCurrency - a currency name/definition
  - setInvResetRate
```
public void setInvResetRate(int ticks)
```
    Description copied from interface: Economics
    
    Sets the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
    
    Specified by:
    
    setInvResetRate in interface Economics
    
    Parameters:
    
    ticks - the number of ticks between total resets of inventory
  - parseRecords
```
protected void parseRecords(java.lang.String text)
```
  - setMiscText
```
public void setMiscText(java.lang.String text)
```
    Description copied from interface: Environmental
    
    For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.
    
    Specified by:
    
    setMiscText in interface Environmental
    
    Overrides:
    
    setMiscText in class CommonSkill
    
    Parameters:
    
    text - either an open internal text string, or XML
  - affectPhyStats
```
public void affectPhyStats(Physical E,
                           PhyStats affectableStats)
```
    Description copied from interface: StatsAffecting
    
    This method is called by the recoverPhyStats() method on other Environmental objects. It is used to transform the Environmental basePhyStats() object into a finished phyStats() object, both of which are objects implementing the PhyStats interface. See those methods for more information.
    
    Specified by:
    
    affectPhyStats in interface StatsAffecting
    
    Overrides:
    
    affectPhyStats in class StdAbility
    
    Parameters:
    
    E - the host of the PhyStats object being affected
    
    affectableStats - the particular PhyStats object being affected
    
    See Also:
    
    PhyStats, Environmental, Affectable.basePhyStats(), Affectable.phyStats(), Affectable.recoverPhyStats()
  - isSold
```
public boolean isSold(int mask)
```
    Description copied from interface: ShopKeeper
    
    Returns whether the given type of good is sold by this shopkeeper.
    
    Specified by:
    
    isSold in interface ShopKeeper
    
    Parameters:
    
    mask - the ShopKeeper DEAL_* constant describing what is sold or bought by this ShopKeeper
    
    Returns:
    
    true if the shopkeeper will make such a deal
    
    See Also:
    
    ShopKeeper.DEAL_DESCS, ShopKeeper.getWhatIsSoldMask()
  - addSoldType
```
public void addSoldType(int mask)
```
    Description copied from interface: ShopKeeper
    
    Adds the ShopKeeper DEAL_* constants describing what is sold or bought by this ShopKeeper to the existing shopkeeper mask. A value of 0 will clear the whole mask.
    
    Specified by:
    
    addSoldType in interface ShopKeeper
    
    Parameters:
    
    mask - the ShopKeeper DEAL_* constants describing what is sold or bought by this ShopKeeper
    
    See Also:
    
    ShopKeeper.DEAL_DESCS, ShopKeeper.isSold(int)
  - getWhatIsSoldMask
```
public long getWhatIsSoldMask()
```
    Description copied from interface: ShopKeeper
    
    Returns the ShopKeeper DEAL_* mask describing what is sold or bought by this ShopKeeper
    
    Specified by:
    
    getWhatIsSoldMask in interface ShopKeeper
    
    Returns:
    
    the dealer type constants to the 2nd power, shifted 8 bits left
    
    See Also:
    
    ShopKeeper.DEAL_DESCS, ShopKeeper.setWhatIsSoldMask(long)
  - setWhatIsSoldMask
```
public void setWhatIsSoldMask(long newSellCode)
```
    Description copied from interface: ShopKeeper
    
    Sets the encoded ShopKeeper DEAL_* constants describing what is sold or bought by this ShopKeeper
    
    Specified by:
    
    setWhatIsSoldMask in interface ShopKeeper
    
    Parameters:
    
    newSellCode - the dealer type constants to the 2nd power, shifted 8 bits left
    
    See Also:
    
    ShopKeeper.DEAL_DESCS, ShopKeeper.addSoldType(int)
  - storeKeeperString
```
public java.lang.String storeKeeperString()
```
    Description copied from interface: ShopKeeper
    
    Based on the value of this ShopKeepers whatIsSold() method, this will return a displayable string describing that type.
    
    Specified by:
    
    storeKeeperString in interface ShopKeeper
    
    Returns:
    
    a description of the whatIsSold() code
    
    See Also:
    
    ShopKeeper.isSold(int)
  - doISellThis
```
public boolean doISellThis(Environmental thisThang)
```
    Description copied from interface: ShopKeeper
    
    Returns whether this ShopKeeper deals in the type of item passed in. The determination is based on the whatIsSold() code.
    
    Specified by:
    
    doISellThis in interface ShopKeeper
    
    Parameters:
    
    thisThang - the item to determine if the shopkeeper deals in
    
    Returns:
    
    whether the shopkeeper deals in the type of item passed in
    
    See Also:
    
    ShopKeeper.isSold(int)
  - getRawPrejudiceFactors
```
public java.lang.String getRawPrejudiceFactors()
```
    Description copied from interface: Economics
    
    A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
    
    Specified by:
    
    getRawPrejudiceFactors in interface Economics
    
    Returns:
    
    the string describing price prejudicing
  - setPrejudiceFactors
```
public void setPrejudiceFactors(java.lang.String factors)
```
    Description copied from interface: Economics
    
    Sets the string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
    
    Specified by:
    
    setPrejudiceFactors in interface Economics
    
    Parameters:
    
    factors - the string describing price prejudicing
  - getRawIgnoreMask
```
public java.lang.String getRawIgnoreMask()
```
    Description copied from interface: Economics
    
    Returns the mask used to determine if a customer is ignored by the ShopKeeper.
    
    Specified by:
    
    getRawIgnoreMask in interface Economics
    
    Returns:
    
    the mask used
    
    See Also:
    
    MaskingLibrary
  - setIgnoreMask
```
public void setIgnoreMask(java.lang.String factors)
```
    Description copied from interface: Economics
    
    Sets the mask used to determine if a customer is ignored by the ShopKeeper.
    
    Specified by:
    
    setIgnoreMask in interface Economics
    
    Parameters:
    
    factors - the mask to use
    
    See Also:
    
    MaskingLibrary
  - getRawItemPricingAdjustments
```
public java.lang.String[] getRawItemPricingAdjustments()
```
    Description copied from interface: Economics
    
    A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
    
    Specified by:
    
    getRawItemPricingAdjustments in interface Economics
    
    Returns:
    
    an array of the strings describing price adjustments
  - setWhatIsSoldZappermask
```
public void setWhatIsSoldZappermask(java.lang.String newSellMask)
```
    Description copied from interface: ShopKeeper
    
    Sets the zapper mask which applies to items to determine whether they are bought and sold by this shopkeeper.
    
    Specified by:
    
    setWhatIsSoldZappermask in interface ShopKeeper
    
    Parameters:
    
    newSellMask - the item zappermask
    
    See Also:
    
    ShopKeeper.isSold(int), ShopKeeper.getWhatIsSoldZappermask(), MaskingLibrary
  - getWhatIsSoldZappermask
```
public java.lang.String getWhatIsSoldZappermask()
```
    Description copied from interface: ShopKeeper
    
    Returns the zapper mask which applies to items to determine whether they are bought and sold by this shopkeeper.
    
    Specified by:
    
    getWhatIsSoldZappermask in interface ShopKeeper
    
    Returns:
    
    the item zappermask
    
    See Also:
    
    ShopKeeper.isSold(int), ShopKeeper.setWhatIsSoldZappermask(String), MaskingLibrary
  - getOverdueCharge
```
public double getOverdueCharge()
```
    Description copied from interface: Librarian
    
    Gets the minimum base currency charge due the moment a withdrawn item becomes overdue.
    
    Specified by:
    
    getOverdueCharge in interface Librarian
    
    Returns:
    
    the base charge
    
    See Also:
    
    Librarian.setOverdueCharge(double)
  - setOverdueCharge
```
public void setOverdueCharge(double charge)
```
    Description copied from interface: Librarian
    
    Sets the minimum base currency charge due the moment a withdrawn item becomes overdue.
    
    Specified by:
    
    setOverdueCharge in interface Librarian
    
    Parameters:
    
    charge - the base charge
    
    See Also:
    
    Librarian.setOverdueCharge(double)
  - getDailyOverdueCharge
```
public double getDailyOverdueCharge()
```
    Description copied from interface: Librarian
    
    Gets the daily base currency charge due every day a withdrawn item remains overdue.
    
    Specified by:
    
    getDailyOverdueCharge in interface Librarian
    
    Returns:
    
    the daily charge from 0-1
    
    See Also:
    
    Librarian.setDailyOverdueCharge(double)
  - setDailyOverdueCharge
```
public void setDailyOverdueCharge(double charge)
```
    Description copied from interface: Librarian
    
    Sets the daily base currency charge due every day a withdrawn item remains overdue. Value 0-1.
    
    Specified by:
    
    setDailyOverdueCharge in interface Librarian
    
    Parameters:
    
    charge - the daily charge from 0-1
    
    See Also:
    
    Librarian.setDailyOverdueCharge(double)
  - getOverdueChargePct
```
public double getOverdueChargePct()
```
    Description copied from interface: Librarian
    
    Gets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due the moment a withdrawn item becomes overdue.
    
    Specified by:
    
    getOverdueChargePct in interface Librarian
    
    Returns:
    
    the base charge as pct of item value from 0-1
    
    See Also:
    
    Librarian.setOverdueChargePct(double)
  - setOverdueChargePct
```
public void setOverdueChargePct(double pct)
```
    Description copied from interface: Librarian
    
    Sets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due the moment a withdrawn item becomes overdue.
    
    Specified by:
    
    setOverdueChargePct in interface Librarian
    
    Parameters:
    
    pct - the base charge as pct of item value from 0-1
    
    See Also:
    
    Librarian.setOverdueChargePct(double)
  - getDailyOverdueChargePct
```
public double getDailyOverdueChargePct()
```
    Description copied from interface: Librarian
    
    Gets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due every day that a withdrawn item remains overdue.
    
    Specified by:
    
    getDailyOverdueChargePct in interface Librarian
    
    Returns:
    
    the base charge as pct of item value from 0-1
    
    See Also:
    
    Librarian.setDailyOverdueChargePct(double)
  - setDailyOverdueChargePct
```
public void setDailyOverdueChargePct(double pct)
```
    Description copied from interface: Librarian
    
    Sets the percent from 0 to 1, of the value of a withdrawn item, in base currency charge, due every day that a withdrawn item remains overdue.
    
    Specified by:
    
    setDailyOverdueChargePct in interface Librarian
    
    Parameters:
    
    pct - the base charge as pct of item value from 0-1
    
    See Also:
    
    Librarian.setDailyOverdueChargePct(double)
  - getMinOverdueDays
```
public int getMinOverdueDays()
```
    Description copied from interface: Librarian
    
    Gets the number of mud-days that an item can be checked out before being overdue. After this number of days, the item is considered overdue and charges begin accruing.
    
    Specified by:
    
    getMinOverdueDays in interface Librarian
    
    Returns:
    
    mud-days before its overdue
    
    See Also:
    
    Librarian.setMinOverdueDays(int), Librarian.getMaxOverdueDays(), Librarian.setMaxOverdueDays(int)
  - setMinOverdueDays
```
public void setMinOverdueDays(int days)
```
    Description copied from interface: Librarian
    
    Sets the number of mud-days that an item can be checked out before being overdue. After this number of days, the item is considered overdue and charges begin accruing.
    
    Specified by:
    
    setMinOverdueDays in interface Librarian
    
    Parameters:
    
    days - mud-days before its overdue
    
    See Also:
    
    Librarian.getMinOverdueDays(), Librarian.getMaxOverdueDays(), Librarian.setMaxOverdueDays(int)
  - getMaxOverdueDays
```
public int getMaxOverdueDays()
```
    Description copied from interface: Librarian
    
    Gets the maximum number of mud-days that an item can be checked out. After this number of days, the item is automatically returned to the librarian, and the charges made.
    
    Specified by:
    
    getMaxOverdueDays in interface Librarian
    
    Returns:
    
    mud-days to be overdue
    
    See Also:
    
    Librarian.setMaxOverdueDays(int), Librarian.getMinOverdueDays(), Librarian.setMinOverdueDays(int)
  - setMaxOverdueDays
```
public void setMaxOverdueDays(int days)
```
    Description copied from interface: Librarian
    
    Sets the maximum number of mud-days that an item can be checked out. After this number of days, the item is automatically returned to the librarian, and the charges made.
    
    Specified by:
    
    setMaxOverdueDays in interface Librarian
    
    Parameters:
    
    days - mud-days to be overdue
    
    See Also:
    
    Librarian.getMaxOverdueDays(), Librarian.getMinOverdueDays(), Librarian.setMinOverdueDays(int)
  - getMaxBorrowed
```
public int getMaxBorrowed()
```
    Description copied from interface: Librarian
    
    Gets the maximum number of items that one person can have checked out at any given time.
    
    Specified by:
    
    getMaxBorrowed in interface Librarian
    
    Returns:
    
    number of items
    
    See Also:
    
    Librarian.setMaxBorrowed(int)
  - setMaxBorrowed
```
public void setMaxBorrowed(int items)
```
    Description copied from interface: Librarian
    
    Sets the maximum number of items that one person can have checked out at any given time.
    
    Specified by:
    
    setMaxBorrowed in interface Librarian
    
    Parameters:
    
    items - number of items
    
    See Also:
    
    Librarian.getMaxBorrowed()
  - libraryChain
```
public java.lang.String libraryChain()
```
    Description copied from interface: Librarian
    
    Gets the name of the library chain to which this librarian belongs.
    
    Specified by:
    
    libraryChain in interface Librarian
    
    Returns:
    
    the library chain name
    
    See Also:
    
    Librarian.setLibraryChain(String)
  - setLibraryChain
```
public void setLibraryChain(java.lang.String name)
```
    Description copied from interface: Librarian
    
    Sets the name of the library chain to which this librarian belongs.
    
    Specified by:
    
    setLibraryChain in interface Librarian
    
    Parameters:
    
    name - the library chain name
    
    See Also:
    
    Librarian.libraryChain()
  - contributorMask
```
public java.lang.String contributorMask()
```
    Description copied from interface: Librarian
    
    Returns the mask used to determine if a contributor is ignored by the Librarian for contribution.
    
    Specified by:
    
    contributorMask in interface Librarian
    
    Returns:
    
    the mask used
    
    See Also:
    
    MaskingLibrary, Librarian.setContributorMask(String)
  - setContributorMask
```
public void setContributorMask(java.lang.String mask)
```
    Description copied from interface: Librarian
    
    Sets the mask used to determine if a contributor is ignored by the Librarian for contribution.
    
    Specified by:
    
    setContributorMask in interface Librarian
    
    Parameters:
    
    mask - the mask to use
    
    See Also:
    
    MaskingLibrary, Librarian.contributorMask()
  - getLibraryShopKey
```
protected java.lang.String getLibraryShopKey()
```
  - getBaseLibrary
```
public CoffeeShop getBaseLibrary()
```
    Description copied from interface: Librarian
    
    Returns the underlying basic book stock of the library, as opposed to the current shop, which reflects only what is there at the moment.
    
    Specified by:
    
    getBaseLibrary in interface Librarian
    
    Returns:
    
    the underlying basic book stock of the library
  - setItemPricingAdjustments
```
public void setItemPricingAdjustments(java.lang.String[] factors)
```
    Description copied from interface: Economics
    
    Sets the string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
    
    Specified by:
    
    setItemPricingAdjustments in interface Economics
    
    Parameters:
    
    factors - the string describing price prejudicing
  - getStartArea
```
protected Area getStartArea()
```
  - getFinalInvResetRate
```
public int getFinalInvResetRate()
```
    Description copied from interface: Economics
    
    Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
    
    Specified by:
    
    getFinalInvResetRate in interface Economics
    
    Returns:
    
    the number of ticks between total resets of inventory
  - getFinalPrejudiceFactors
```
public java.lang.String getFinalPrejudiceFactors()
```
    Description copied from interface: Economics
    
    A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
    
    Specified by:
    
    getFinalPrejudiceFactors in interface Economics
    
    Returns:
    
    the string describing price prejudicing
  - getFinalIgnoreMask
```
public java.lang.String getFinalIgnoreMask()
```
    Description copied from interface: Economics
    
    Returns the mask used to determine if a customer is ignored by the ShopKeeper.
    
    Specified by:
    
    getFinalIgnoreMask in interface Economics
    
    Returns:
    
    the mask used
    
    See Also:
    
    MaskingLibrary
  - getFinalItemPricingAdjustments
```
public java.lang.String[] getFinalItemPricingAdjustments()
```
    Description copied from interface: Economics
    
    A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
    
    Specified by:
    
    getFinalItemPricingAdjustments in interface Economics
    
    Returns:
    
    an array of the strings describing price adjustments
  - getFinalBudget
```
public Pair<java.lang.Long,TimeClock.TimePeriod> getFinalBudget()
```
    Description copied from interface: Economics
    
    Returns a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.
    
    Specified by:
    
    getFinalBudget in interface Economics
    
    Returns:
    
    the pair for the shopkeepers buying budget
  - getFinalDevalueRate
```
public double[] getFinalDevalueRate()
```
    Description copied from interface: Economics
    
    Returns a double array describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of null or [0,0] would mean no drop in price for either, ever.
    
    Specified by:
    
    getFinalDevalueRate in interface Economics
    
    Returns:
    
    null, or the price dropping percentage rule for this shopkeeper
  - updateCheckedOutRecords
```
protected void updateCheckedOutRecords()
```
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class CommonSkill
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - processCheckedOutRecord
```
protected boolean processCheckedOutRecord(Librarian.CheckedOutRecord rec)
```
  - deriveLibrarian
```
public MOB deriveLibrarian(MOB roomHelper)
```
  - 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 CommonSkill
    
    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()
  - putUpForLoan
```
public boolean putUpForLoan(MOB source,
                            MOB merchantM,
                            Environmental tool)
```
  - canPossiblyLoan
```
public boolean canPossiblyLoan(Environmental E,
                               Environmental what)
```
  - destroy
```
public void destroy()
```
    Description copied from interface: Contingent
    
    Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java. Containers, rooms. and mobs who have their destroy() method called will also call the destroy() methods on all items and other objects listed as content, recursively.
    
    Specified by:
    
    destroy in interface Contingent
    
    Overrides:
    
    destroy in class StdAbility
  - getAllMyRecords
```
public java.util.List<Librarian.CheckedOutRecord> getAllMyRecords(java.lang.String name)
```
  - getRecord
```
public Librarian.CheckedOutRecord getRecord(java.lang.String playerName,
                                            java.lang.String itemName)
```
  - getItemRecords
```
public java.util.List<Librarian.CheckedOutRecord> getItemRecords(java.lang.String itemName)
```
  - getTotalOverdueCharges
```
protected double getTotalOverdueCharges(java.lang.String name)
```
  - location
```
protected final Room location()
```
  - autoGive
```
public void autoGive(MOB src,
                     MOB tgt,
                     Item I)
```
  - isAPossiblePayback
```
protected boolean isAPossiblePayback(MOB mob,
                                     Environmental tool)
```
  - 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 StdAbility
    
    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
  - isActive
```
protected boolean isActive(MOB mob)
```
  - makeActive
```
protected void makeActive(MOB mob)
```
  - invoke
```
public boolean invoke(MOB mob,
                      java.util.List<java.lang.String> commands,
                      Physical givenTarget,
                      boolean auto,
                      int asLevel)
```
    Description copied from interface: Ability
    
    This method is called when a player or the system invokes this skill, casts this spell, etc. Calls the more complete invoke method without an empty command strings vector unless target is non-null, in which case the vector will contain the name of the target.
    
    Specified by:
    
    invoke in interface Ability
    
    Overrides:
    
    invoke in class CommonSkill
    
    Parameters:
    
    mob - the player or mob invoking the skill
    
    commands - the parameters entered for the skill (minus trigger word)
    
    givenTarget - null, unless being auto-invoked. Represents an override target.
    
    auto - false if player enters command, true if system invokes the command
    
    asLevel - -1, unless being auto-invoked, when it is the level to invoke it at.
    
    Returns:
    
    whether the skill successfully invoked.
  - autoInvocation
```
public boolean autoInvocation(MOB mob,
                              boolean force)
```
    Description copied from interface: Ability
    
    An autoinvocating ability is an ability which affects the mob just by having learned the ability. Dodge is an example of this. This method is called to initiate this, and is called whenever a mob gains this skill as a new Ability. This method will add the ability to the mob as an effect.
    
    Specified by:
    
    autoInvocation in interface Ability
    
    Overrides:
    
    autoInvocation in class StdAbility
    
    Parameters:
    
    mob - the player or npc mob who has this ability
    
    force - if the skill has default-off settings, this overrides to ON
    
    Returns:
    
    whether the ability autoinvoked correctly
    
    See Also:
    
    Ability.isAutoInvoked(), Ability.isNowAnAutoEffect()

Class BookLoaning

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.Librarian

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ShopKeeper

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

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

Fields inherited from class com.planet_ink.coffee_mud.Abilities.Common.CommonSkill

Fields inherited from interface com.planet_ink.coffee_mud.MOBS.interfaces.Librarian

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

Fields inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility

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.core.interfaces.CMObject

Methods inherited from class com.planet_ink.coffee_mud.Abilities.Common.CommonSkill

Methods inherited from interface java.lang.Comparable

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Abilities.StdAbility

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

Field Detail

curShop

shop

approvedI

approvedMob

Constructor Detail

BookLoaning

Method Detail

ID

name

triggerStrings

overrideMana

isAutoInvoked

canBeUninvoked

getRawTrainingCost

canAffectCode

canTargetCode

classificationCode

getMyClock

copyOf

newInstance

getShop

getRecordsXML

viewFlags

text

getRawBbudget

setBudget

getRawDevalueRate

setDevalueRate

getRawInvResetRate

getFinalCurrency

getRawCurrency

setCurrency

setInvResetRate

parseRecords

setMiscText

affectPhyStats

isSold

addSoldType

getWhatIsSoldMask

setWhatIsSoldMask

storeKeeperString

doISellThis

getRawPrejudiceFactors

setPrejudiceFactors

getRawIgnoreMask

setIgnoreMask

getRawItemPricingAdjustments

setWhatIsSoldZappermask

getWhatIsSoldZappermask

getOverdueCharge

setOverdueCharge

getDailyOverdueCharge

setDailyOverdueCharge

getOverdueChargePct