CoffeeMaker

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.CoffeeMaker

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, GenericBuilder, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class CoffeeMaker
extends StdLibrary
implements GenericBuilder
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.GenericBuilder
  GenericBuilder.GenItemBonusFakeStats, GenericBuilder.GenItemCode, GenericBuilder.GenMOBBonusFakeStats, GenericBuilder.GenMOBCode, GenericBuilder.GenPhysBonusFakeStats

Field Summary
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
  idConverter
- Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
  isDebugging, name, serviceClient, tickStatus
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
  STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors
Constructor Description

CoffeeMaker()

Constructors
Constructor	Description
`CoffeeMaker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAutoPropsToAreaIfNecessary(Area newArea)`	Called when a new area enters the game in order to add any Automatic/Default properties to the area that are specified in the INI file.
`java.lang.String`	`addItemsFromXML(java.lang.String xmlBuffer, java.util.List<Item> addHere, Session S)`	Given a String xml document containing a ITEMs tag, this will build a set of item objects and add them to the given list.
`java.lang.String`	`addItemsFromXML(java.util.List<XMLLibrary.XMLTag> xml, java.util.List<Item> addHere, Session S)`	Given a pre-parsed xml document containing a ITEMs tag, this will build a set of item objects and add them to the given list.
`java.lang.String`	`addMOBsFromXML(java.lang.String xmlBuffer, java.util.List<MOB> addHere, Session S)`	Given a string xml document containing a MOBS tag, this will build a set of mob objects and add them to the given list.
`java.lang.String`	`addMOBsFromXML(java.util.List<XMLLibrary.XMLTag> xml, java.util.List<MOB> addHere, Session S)`	Given a pre-parsed xml document containing a MOBS tag, this will build a set of mob objects and add them to the given list.
`java.lang.String`	`addPlayersAndAccountsFromXML(java.lang.String xmlBuffer, java.util.List<PlayerAccount> addAccounts, java.util.List<MOB> addMobs, Session S)`	Creates player account objects and player character MOB objects from the given XML document.
`protected java.lang.String`	`addPlayersOnlyFromXML(java.util.List<XMLLibrary.XMLTag> mV, java.util.List<MOB> addMobs, Session S)`
`Area`	`copyArea(Area A, java.lang.String newName, boolean savable)`	This makes either a full database, or simple memory copy of the given area with the given new name
`protected void`	`doGenPropertiesCopy(Environmental fromE, Environmental toE)`
`java.lang.String`	`fillAreaAndCustomVectorFromXML(java.lang.String buf, java.util.List<XMLLibrary.XMLTag> area, java.util.List<CMObject> custom, java.util.Map<java.lang.String,java.lang.String> externalFiles)`	An xml helper function that merely parses the given xml document containing an AREA tag into its various content tags, and puts them into the given area list.
`java.lang.String`	`fillAreasVectorFromXML(java.lang.String buf, java.util.List<java.util.List<XMLLibrary.XMLTag>> areas, java.util.List<CMObject> custom, java.util.Map<java.lang.String,java.lang.String> externalFiles)`	An xml helper function that merely parses the given xml document containing an AREAS tag into its various AREA tags, and puts the contents into the given areas list.
`java.lang.String`	`fillCustomVectorFromXML(java.lang.String xml, java.util.List<CMObject> custom, java.util.Map<java.lang.String,java.lang.String> externalFiles)`	Given a string xml document with CUSTOM tag containing generic races, classes, and external files and scripts, this method will recreate the appropriate objects to populate into the custom list, and separate file paths from their string contents into the externalFiles map.
`protected java.lang.String`	`fillCustomVectorFromXML(java.util.List<XMLLibrary.XMLTag> xml, java.util.List<CMObject> custom, java.util.Map<java.lang.String,java.lang.String> externalFiles)`
`protected void`	`fillFileMap(Environmental E, java.util.List<java.lang.String> V, java.util.Map<java.lang.String,java.util.Set<Environmental>> H)`
`void`	`fillFileMap(Environmental E, java.util.Map<java.lang.String,java.util.Set<Environmental>> H)`	Attempts to fill the given map of script file paths to set of object that use the script.
`void`	`fillFileSet(Environmental E, java.util.Set<java.lang.String> H)`	Attempts to fill the given set full of script file paths from the object given by recursively inspecting it for embedded scripts, digging into mob and store inventory and so forth.
`void`	`fillFileSet(java.util.List<java.lang.String> V, java.util.Set<java.lang.String> H)`
`protected java.lang.String`	`fillRoomContentFromXML(Room newRoom, java.util.List<XMLLibrary.XMLTag> xml)`
`protected void`	`fixFillingRoomUnlinkedExits(Room newRoom, Room R, boolean andSave)`
`java.lang.String`	`getAccountXML(PlayerAccount account, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files)`	Given a player account, this will return an XML document of the account objects, as well as all characters contained in the account.
`java.util.List<java.lang.String>`	`getAllGenStats(Physical P)`	Returns the list of basic generic state codes applicable to the given object.
`java.lang.String`	`getAnyGenStat(Physical P, java.lang.String stat)`	Returns the value of the given stat on the given object, even if the object is not generic.
`java.lang.String`	`getAreaObjectXML(Area area, Session S, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, boolean andRooms)`	Generates an xml document of the given area, and optionally all of its rooms.
`java.lang.String`	`getAreaXML(Area area, Session S, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, boolean andRooms)`	Generates an xml document of the given area, and optionally all of its rooms.
`protected java.lang.String`	`getAreaXML(Area area, Session S, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, boolean andRooms, boolean isInDB)`
`java.lang.String`	`getCharStateStr(CharState E)`	Given the CharState object, returns the encoded string representing the values in the object.
`java.lang.String`	`getCharStatsStr(CharStats E)`	Given the CharStats object, returns the encoded string representing the values in the object.
`java.lang.String`	`getCodedSpellsOrBehaviors(PhysicalAgent I)`	Returns all of the given effect Abilities on the given Affectable as a semicolon delimited string of Ability IDs.
`java.util.List<CMObject>`	`getCodedSpellsOrBehaviors(java.lang.String spellsOrBehavsList)`	Parses the coded effects available from an ability parameter column and generates the Ability objects with any parameters of their own.
`java.lang.String`	`getEnvironmentalMiscTextXML(Environmental E, boolean fromTop)`	Gives an environmental object of a more basic sort, such as a mob or item, this will return the XML representation of that object.
`protected java.lang.String`	`getEnvPropertiesStr(Environmental E)`
`protected java.lang.String`	`getExitXML(Exit exit)`
`java.lang.String`	`getExtraEnvironmentalXML(Environmental E)`	From the given Environmental, returns xml of certain object settings that come from the objects most basic interfaces, such as Physical, Economic, PhysicalAgent, extra bonus stats, and scripts.
`java.lang.String`	`getFactionXML(MOB mob, java.util.List<Pair<java.lang.String,java.lang.Integer>> lst)`	Converts all the faction values and associations on the given mob or list into a complete xml doc for storage in the db.
`java.lang.String`	`getFinalStatName(java.lang.String stat)`	Removes any qualifying prefixes from stat names, to reveal the underlying stat code.
`java.lang.String`	`getGenAbilityXML(Ability A)`	Given an ability, including a generic one, this will construct an xml document representing the ability.
`protected java.lang.String`	`getGenEnvironmentalXML(Environmental E)`
`int`	`getGenItemCodeNum(java.lang.String code)`	Returns the ordinal of the given code in the basic genitem stat codes.
`java.lang.String`	`getGenItemStat(Item I, java.lang.String code)`	Gets the value of a basic genitem stat, even if the mob given is not generic.
`protected java.lang.String`	`getGenMobAbilitiesXML(MOB M)`
`int`	`getGenMobCodeNum(java.lang.String code)`	Returns the ordinal of the given code in the basic genmob stat codes.
`protected java.lang.String`	`getGenMobInventoryXML(MOB M)`
`java.lang.String`	`getGenMobStat(MOB M, java.lang.String code)`	Gets the value of a basic genmob stat, even if the mob given is not generic.
`java.lang.String`	`getGenMOBTextUnpacked(MOB mob, java.lang.String newText)`	Confirms the length of a misc text XML document for a generic mob, and if it is stored in the DB, retreives it before returning the final misc text xml document.
`java.lang.String`	`getGenScriptsXML(PhysicalAgent E, boolean includeVars)`	If the given PhysicalAgent contains any attached Scripts, this will bundle them up into an XML document and return them.
`java.lang.String`	`getItemXML(Item item)`	Returns an xml document representing the given item, wrapped in a neat ITEM tag.
`java.lang.String`	`getMobXML(MOB mob)`	Returns an xml document representing the given mob, wrapped in a neat MOB tag.
`protected java.lang.String`	`getOrdEnvironmentalXML(Environmental E)`
`java.lang.String`	`getPhyStatsStr(PhyStats E)`	Given the PhyStats object, returns the encoded string representing the values in the object.
`protected java.lang.String`	`getPlayerExtraInventory(MOB M)`
`java.lang.String`	`getPlayerXML(MOB mob, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files)`	Give a player/character mob, this will return an xml document of the mob object, as well as any items, etc contained therein.
`java.lang.String`	`getQuickName(java.lang.String classID, java.lang.String miscText)`	Weird function.
`java.lang.String`	`getRoomItems(Room room, java.util.Map<java.lang.String,java.util.List<Item>> found, java.util.Set<java.lang.String> files, CMClass.CMObjectType type)`	Given a database room, this function will grab its real contents from the database, and construct an xml document consisting of the unique items in the room.
`java.lang.String`	`getRoomMobs(Room room, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, java.util.Map<java.lang.String,java.util.List<MOB>> found)`	Given a database room, this function will grab its real contents from the database, and construct an xml document consisting of the unique mobs in the room.
`java.lang.String`	`getRoomXML(Room room, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, boolean andContent)`	Generates an xml document of the given room, and optionally all of its contents.
`protected java.lang.String`	`getRoomXML(Room room, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, boolean andContent, boolean andIsInDB, boolean skipDoors)`
`int`	`getSpecialEnvFlags(Environmental E)`	Some object types (items and exits) still use a compressed numeric form for some of their properties.
`java.lang.String`	`getUniqueItemsXML(java.util.List<Item> items, java.util.Map<java.lang.String,java.util.List<Item>> found, java.util.Set<java.lang.String> files, CMClass.CMObjectType type)`	Given a list of item objects, this will return an xml document of the set of ITEMs, but only returning any unique item from the list, relegating dups to the give map.
`protected java.lang.String`	`getUniqueItemXML(Item item, CMClass.CMObjectType type, java.util.Map<java.lang.String,java.util.List<Item>> found, java.util.Set<java.lang.String> files)`
`java.lang.String`	`getUniqueMobsXML(java.util.List<MOB> mobs, java.util.Set<CMObject> custom, java.util.Set<java.lang.String> files, java.util.Map<java.lang.String,java.util.List<MOB>> found)`	Given a list of mob objects, this will return an xml document of the set of MOBs, but only returning any unique mobs from the list, relegating dups to the give map.
`java.lang.String`	`getUnknownNameFromXML(java.lang.String xml)`	Given an xml document with a mob, item, or room, this will return the value of the first NAME or RDISP tag found herein.
`CMClass.CMObjectType`	`getUnknownTypeFromXML(java.lang.String xml)`	Given an xml document that starts with a MOB, ITEM, AROOM, or EXIT tag, this will return the appropriate CMOBjectType
`java.lang.String`	`getUnknownXML(Environmental obj)`	Given an item, mob, room, or exit, this will return the full XML document for that object.
`boolean`	`handleCatalogItem(Physical P, java.util.List<XMLLibrary.XMLTag> buf, boolean fromTop)`
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`protected java.lang.String`	`identifier(Environmental E, Environmental parent)`
`boolean`	`isAnyGenStat(Physical P, java.lang.String stat)`	Returns whether the given string represents any of the "AnyGen" stat codes for the given type object, even if the object is not generic.
`protected void`	`logDiff(Environmental E1, Environmental E2)`
`protected java.lang.String`	`logTextDiff(java.lang.String e1, java.lang.String e2)`
`Ammunition`	`makeAmmunition(java.lang.String ammunitionType, int number)`	Create a standard GenAmmunition Item, representing a bundle of ammo, of the give type and number.
`Room`	`makeNewRoomContent(Room room, boolean makeLive)`	Duplicates the contents of an official database room by reloading the room and its contents into a new room object.
`void`	`populateShops(ShopKeeper shopKeep, java.util.List<XMLLibrary.XMLTag> buf)`	Given parsed xml tags, this method will extract the basic shop settings into the given ShopKeeper object, as well as populate the shop inventory itself from the given xml.
`protected void`	`possibleAddElectronicsManufacturers(Item I, java.util.Set<CMObject> custom)`
`protected void`	`possibleAddElectronicsManufacturers(MOB M, java.util.Set<CMObject> custom)`
`protected void`	`possiblyAddCustomAbility(MOB mob, java.util.Set<CMObject> custom)`
`protected void`	`possiblyAddCustomClass(MOB mob, java.util.Set<CMObject> custom)`
`protected void`	`possiblyAddCustomEffect(Physical P, java.util.Set<CMObject> custom)`
`protected void`	`possiblyAddCustomRace(MOB mob, java.util.Set<CMObject> custom)`
`protected void`	`recoverPhysical(Physical P)`
`void`	`resetGenMOB(MOB mob, java.lang.String newText)`	Given a mob and its generic misc text, this method will reset the mob with the given misc text values, and reset its hit points, mana, etc.
`void`	`setAnyGenStat(Physical P, java.lang.String stat, java.lang.String value)`	Sets the value of the given stat on the given object, even if the object is not generic.
`void`	`setAnyGenStat(Physical P, java.lang.String stat, java.lang.String value, boolean supportPlusMinusPrefix)`	Sets the value of the given stat on the given object, even if the object is not generic.
`void`	`setCharState(CharState E, java.lang.String props)`	Sets the values in the given CharState object from the encoded string.
`void`	`setCharStats(CharStats E, java.lang.String props)`	Sets the values in the given CharStats object from the encoded string.
`protected void`	`setEnvProperties(Environmental E, java.util.List<XMLLibrary.XMLTag> buf)`
`void`	`setGenItemStat(Item I, java.lang.String code, java.lang.String val)`	Sets the value of a basic genitem stat, even if the mob given is not generic.
`protected void`	`setGenMobAbilities(MOB M, java.util.List<XMLLibrary.XMLTag> buf)`
`protected void`	`setGenMobInventory(MOB M, java.util.List<XMLLibrary.XMLTag> buf)`
`void`	`setGenMobStat(MOB M, java.lang.String code, java.lang.String val)`	Sets the value of a basic genmob stat, even if the mob given is not generic.
`protected void`	`setGenPropertiesFromXML(Environmental E, java.util.List<XMLLibrary.XMLTag> buf)`
`protected void`	`setOrdPropertiesFromXML(Environmental E, java.util.List<XMLLibrary.XMLTag> V)`
`void`	`setPhyStats(PhyStats E, java.lang.String props)`	Sets the values in the given PhyStats object from the encoded string.
`protected void`	`setPlayerExtraInventory(MOB M, java.util.List<XMLLibrary.XMLTag> buf)`
`void`	`setSpecialEnvFlags(Environmental E, int f)`	Some object types (items and exits) still use a compressed numeric form for some of their properties.
`java.lang.String`	`unpackAbilitiesFromXml(java.lang.String xml, java.util.List<Ability> ables)`	Given an xml document containing one or more ABILITY tags, this will parse out the Ability objects, including generic types, and add them to the given list.
`protected java.lang.String`	`unpackAreaFromXML(java.lang.String buf, Session S, java.lang.String overrideAreaType, boolean andRooms)`
`java.lang.String`	`unpackAreaFromXML(java.util.List<XMLLibrary.XMLTag> aV, Session S, java.lang.String overrideAreaType, boolean andRooms, boolean savable)`	Given a pre-parsed XML document containing an ACLAS tag, this method will unpack the given area into an area object, optionally complete with rooms, items, mobs, etc.
`Area`	`unpackAreaObjectFromXML(java.lang.String xml)`	Unpack an XML document containing an AREA tag into an actual area object, including any rooms, mobs, items, etc.
`void`	`unpackEnvironmentalMiscTextXML(Environmental E, java.lang.String buf, boolean fromTop)`	Given a string xml document, and an environmental to unpack the xml properties into, this will, well, do that.
`void`	`unpackEnvironmentalMiscTextXML(Environmental E, java.util.List<XMLLibrary.XMLTag> V, boolean fromTop)`	Given a parsed xml document, and an environmental to unpack the xml properties into, this will, well, do that.
`protected java.lang.String`	`unpackErr(java.lang.String where, java.lang.String msg)`
`protected java.lang.String`	`unpackErr(java.lang.String where, java.lang.String msg, XMLLibrary.XMLTag piece)`
`protected java.lang.String`	`unpackErr(java.lang.String where, java.lang.String msg, java.util.List<XMLLibrary.XMLTag> list)`
`protected Exit`	`unpackExitFromXML(java.lang.String buf)`
`void`	`unpackExtraEnvironmentalXML(Environmental E, java.util.List<XMLLibrary.XMLTag> buf)`	From the given XML tags, set certain given object settings that come from the objects most basic interfaces, such as Physical, Economic, PhysicalAgent, extra bonus stats
`java.util.List<Pair<java.lang.String,java.lang.Integer>>`	`unpackFactionFromXML(MOB mob, java.util.List<XMLLibrary.XMLTag> xml)`	Sets the faction values and associations on the given mob from a pre-parsed xml doc.
`void`	`unpackGenScriptsXML(PhysicalAgent E, java.util.List<XMLLibrary.XMLTag> buf, boolean restoreVars)`	From the given XML tags, set any object level Scripts attached to the given PhysicalAgent object.
`Item`	`unpackItemFromXML(java.lang.String xmlBuffer)`	Given an xml document with a ITEM tag in it, this will extract and create the associated item object.
`MOB`	`unpackMobFromXML(java.lang.String xmlBuffer)`	Given an xml document with a MOB tag in it, this will extract and create the associated mob object.
`java.lang.String`	`unpackRoomFromXML(Area forceArea, java.util.List<XMLLibrary.XMLTag> xml, boolean andContent, boolean andSave)`	Gives a parsed XML document containing the contents of room xml, with RCLAS tag, this will extract the room, optionally including mobs/items inside it, and add it to whatever world map area it belongs in, or the forced area if given.
`java.lang.String`	`unpackRoomFromXML(java.lang.String buf, boolean andContent)`	Given an xml document containing an AROOM tag, this method will extract the room, and optionally the mobs/items inside it, and add it to whatever world map area it is supposed to belong to.
`protected java.lang.String`	`unpackRoomFromXML(java.util.List<XMLLibrary.XMLTag> xml, boolean andContent)`
`protected Room`	`unpackRoomObjectFromXML(java.lang.String buf, boolean andContent)`
`Environmental`	`unpackUnknownFromXML(java.lang.String xml)`	Given an xml document for a single item, mob, room, or exit, this will return the fully formed object represented by the document.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

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

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

- Constructor Detail
  - CoffeeMaker
```
public CoffeeMaker()
```
- Method Detail
  - ID
```
public java.lang.String ID()
```
    Description copied from interface: CMObject
    
    The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.
    
    Specified by:
    
    ID in interface CMObject
    
    Overrides:
    
    ID in class StdLibrary
    
    Returns:
    
    the name of this class
  - getGenMOBTextUnpacked
```
public java.lang.String getGenMOBTextUnpacked(MOB mob,
                                              java.lang.String newText)
```
    Description copied from interface: GenericBuilder
    
    Confirms the length of a misc text XML document for a generic mob, and if it is stored in the DB, retreives it before returning the final misc text xml document.
    
    Specified by:
    
    getGenMOBTextUnpacked in interface GenericBuilder
    
    Parameters:
    
    mob - the mob whose misc text this is
    
    newText - the misc text
    
    Returns:
    
    the final misc text
  - resetGenMOB
```
public void resetGenMOB(MOB mob,
                        java.lang.String newText)
```
    Description copied from interface: GenericBuilder
    
    Given a mob and its generic misc text, this method will reset the mob with the given misc text values, and reset its hit points, mana, etc. This is often called during generic mob rebirth.
    
    Specified by:
    
    resetGenMOB in interface GenericBuilder
    
    Parameters:
    
    mob - the mob to repopulate
    
    newText - the misctext for the mob
  - getSpecialEnvFlags
```
public int getSpecialEnvFlags(Environmental E)
```
    Description copied from interface: GenericBuilder
    
    Some object types (items and exits) still use a compressed numeric form for some of their properties. This method will return the value of that special flag.
    
    Specified by:
    
    getSpecialEnvFlags in interface GenericBuilder
    
    Parameters:
    
    E - the object to get envflags for
    
    Returns:
    
    the value of the special flags
    
    See Also:
    
    GenericBuilder.setSpecialEnvFlags(Environmental, int)
  - setSpecialEnvFlags
```
public void setSpecialEnvFlags(Environmental E,
                               int f)
```
    Description copied from interface: GenericBuilder
    
    Some object types (items and exits) still use a compressed numeric form for some of their properties. This method will set the value of that special flag.
    
    Specified by:
    
    setSpecialEnvFlags in interface GenericBuilder
    
    Parameters:
    
    E - the object to set envflags for
    
    f - the value of the special flags
    
    See Also:
    
    GenericBuilder.getSpecialEnvFlags(Environmental)
  - getGenAbilityXML
```
public java.lang.String getGenAbilityXML(Ability A)
```
    Description copied from interface: GenericBuilder
    
    Given an ability, including a generic one, this will construct an xml document representing the ability.
    
    Specified by:
    
    getGenAbilityXML in interface GenericBuilder
    
    Parameters:
    
    A - the ability to get xml for
    
    Returns:
    
    the xml
    
    See Also:
    
    GenericBuilder.unpackAbilitiesFromXml(String, List)
  - unpackAbilitiesFromXml
```
public java.lang.String unpackAbilitiesFromXml(java.lang.String xml,
                                               java.util.List<Ability> ables)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document containing one or more ABILITY tags, this will parse out the Ability objects, including generic types, and add them to the given list.
    
    Specified by:
    
    unpackAbilitiesFromXml in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document with AbILITY tags
    
    ables - the list to put ability objects into
    
    Returns:
    
    "" if all went well, and an error message otherwise
    
    See Also:
    
    GenericBuilder.getGenAbilityXML(Ability)
  - getEnvironmentalMiscTextXML
```
public java.lang.String getEnvironmentalMiscTextXML(Environmental E,
                                                    boolean fromTop)
```
    Description copied from interface: GenericBuilder
    
    Gives an environmental object of a more basic sort, such as a mob or item, this will return the XML representation of that object. This will work for standard or generic objects, and you can specify with the fromTop variable whether you want full xml for standard objects.
    
    Specified by:
    
    getEnvironmentalMiscTextXML in interface GenericBuilder
    
    Parameters:
    
    E - the object to get xml for
    
    fromTop - true to get all xml for a standard object
    
    Returns:
    
    the xml document
    
    See Also:
    
    GenericBuilder.unpackEnvironmentalMiscTextXML(Environmental, List, boolean), GenericBuilder.unpackEnvironmentalMiscTextXML(Environmental, String, boolean)
  - doGenPropertiesCopy
```
protected void doGenPropertiesCopy(Environmental fromE,
                                   Environmental toE)
```
  - getOrdEnvironmentalXML
```
protected java.lang.String getOrdEnvironmentalXML(Environmental E)
```
  - getGenMobAbilitiesXML
```
protected java.lang.String getGenMobAbilitiesXML(MOB M)
```
  - getGenScriptsXML
```
public java.lang.String getGenScriptsXML(PhysicalAgent E,
                                         boolean includeVars)
```
    Description copied from interface: GenericBuilder
    
    If the given PhysicalAgent contains any attached Scripts, this will bundle them up into an XML document and return them. If includeVars is set to true, it will also bundle all currently set script variables.
    
    Specified by:
    
    getGenScriptsXML in interface GenericBuilder
    
    Parameters:
    
    E - the object that might be scripted
    
    includeVars - true to return any vars also
    
    Returns:
    
    the xml document, or ""
    
    See Also:
    
    GenericBuilder.unpackGenScriptsXML(PhysicalAgent, List, boolean)
  - possibleAddElectronicsManufacturers
```
protected void possibleAddElectronicsManufacturers(Item I,
                                                   java.util.Set<CMObject> custom)
```
  - possibleAddElectronicsManufacturers
```
protected void possibleAddElectronicsManufacturers(MOB M,
                                                   java.util.Set<CMObject> custom)
```
  - getGenMobInventoryXML
```
protected java.lang.String getGenMobInventoryXML(MOB M)
```
  - getPlayerExtraInventory
```
protected java.lang.String getPlayerExtraInventory(MOB M)
```
  - setPlayerExtraInventory
```
protected void setPlayerExtraInventory(MOB M,
                                       java.util.List<XMLLibrary.XMLTag> buf)
```
  - getGenEnvironmentalXML
```
protected java.lang.String getGenEnvironmentalXML(Environmental E)
```
  - unpackErr
```
protected java.lang.String unpackErr(java.lang.String where,
                                     java.lang.String msg)
```
  - unpackErr
```
protected java.lang.String unpackErr(java.lang.String where,
                                     java.lang.String msg,
                                     XMLLibrary.XMLTag piece)
```
  - unpackErr
```
protected java.lang.String unpackErr(java.lang.String where,
                                     java.lang.String msg,
                                     java.util.List<XMLLibrary.XMLTag> list)
```
  - unpackExitFromXML
```
protected Exit unpackExitFromXML(java.lang.String buf)
```
  - unpackRoomFromXML
```
public java.lang.String unpackRoomFromXML(java.lang.String buf,
                                          boolean andContent)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document containing an AROOM tag, this method will extract the room, and optionally the mobs/items inside it, and add it to whatever world map area it is supposed to belong to.
    
    Specified by:
    
    unpackRoomFromXML in interface GenericBuilder
    
    Parameters:
    
    buf - the xml document containing AROOM tag
    
    andContent - true to also extract mob/items or false otherwise
    
    Returns:
    
    an error message, or "" if all is well
    
    See Also:
    
    GenericBuilder.getRoomXML(Room, Set, Set, boolean)
  - unpackRoomFromXML
```
protected java.lang.String unpackRoomFromXML(java.util.List<XMLLibrary.XMLTag> xml,
                                             boolean andContent)
```
  - unpackRoomObjectFromXML
```
protected Room unpackRoomObjectFromXML(java.lang.String buf,
                                       boolean andContent)
```
  - fillRoomContentFromXML
```
protected java.lang.String fillRoomContentFromXML(Room newRoom,
                                                  java.util.List<XMLLibrary.XMLTag> xml)
```
  - unpackRoomFromXML
```
public java.lang.String unpackRoomFromXML(Area forceArea,
                                          java.util.List<XMLLibrary.XMLTag> xml,
                                          boolean andContent,
                                          boolean andSave)
```
    Description copied from interface: GenericBuilder
    
    Gives a parsed XML document containing the contents of room xml, with RCLAS tag, this will extract the room, optionally including mobs/items inside it, and add it to whatever world map area it belongs in, or the forced area if given.
    
    Specified by:
    
    unpackRoomFromXML in interface GenericBuilder
    
    Parameters:
    
    forceArea - null to use a map area, or an area object to add the room to
    
    xml - the pre-parsed xml document containing room tags
    
    andContent - true to also build mobs/items, or false to ignore them
    
    andSave - true to save the room to the db, or false to not.
    
    Returns:
    
    an error message, or ""
    
    See Also:
    
    GenericBuilder.getRoomXML(Room, Set, Set, boolean)
  - fixFillingRoomUnlinkedExits
```
protected void fixFillingRoomUnlinkedExits(Room newRoom,
                                           Room R,
                                           boolean andSave)
```
  - fillAreaAndCustomVectorFromXML
```
public java.lang.String fillAreaAndCustomVectorFromXML(java.lang.String buf,
                                                       java.util.List<XMLLibrary.XMLTag> area,
                                                       java.util.List<CMObject> custom,
                                                       java.util.Map<java.lang.String,java.lang.String> externalFiles)
```
    Description copied from interface: GenericBuilder
    
    An xml helper function that merely parses the given xml document containing an AREA tag into its various content tags, and puts them into the given area list. It will also parse out any custom objects and external files contained therein into the custom and externalFiles object given.
    
    Specified by:
    
    fillAreaAndCustomVectorFromXML in interface GenericBuilder
    
    Parameters:
    
    buf - the xml document containing AREAS tag
    
    area - the list to put AREA tag contents into
    
    custom - the required list to put any generic races or classes
    
    externalFiles - the optional list to put a map of file paths to their contents
    
    Returns:
    
    "" if all went well, or an error message
    
    See Also:
    
    GenericBuilder.fillAreasVectorFromXML(String, List, List, Map)
  - fillCustomVectorFromXML
```
public java.lang.String fillCustomVectorFromXML(java.lang.String xml,
                                                java.util.List<CMObject> custom,
                                                java.util.Map<java.lang.String,java.lang.String> externalFiles)
```
    Description copied from interface: GenericBuilder
    
    Given a string xml document with CUSTOM tag containing generic races, classes, and external files and scripts, this method will recreate the appropriate objects to populate into the custom list, and separate file paths from their string contents into the externalFiles map.
    
    Specified by:
    
    fillCustomVectorFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document containing the CUSTOM tag
    
    custom - required list to put genraces and classes into
    
    externalFiles - null, or optional map to put filepaths, file contents into
    
    Returns:
    
    "" or an error message
  - fillCustomVectorFromXML
```
protected java.lang.String fillCustomVectorFromXML(java.util.List<XMLLibrary.XMLTag> xml,
                                                   java.util.List<CMObject> custom,
                                                   java.util.Map<java.lang.String,java.lang.String> externalFiles)
```
  - fillAreasVectorFromXML
```
public java.lang.String fillAreasVectorFromXML(java.lang.String buf,
                                               java.util.List<java.util.List<XMLLibrary.XMLTag>> areas,
                                               java.util.List<CMObject> custom,
                                               java.util.Map<java.lang.String,java.lang.String> externalFiles)
```
    Description copied from interface: GenericBuilder
    
    An xml helper function that merely parses the given xml document containing an AREAS tag into its various AREA tags, and puts the contents into the given areas list. It will also parse out any custom objects and external files contained therein into the custom and externalFiles object given.
    
    Specified by:
    
    fillAreasVectorFromXML in interface GenericBuilder
    
    Parameters:
    
    buf - the xml document containing AREAS tag
    
    areas - the list to put AREA tag contents into
    
    custom - the required list to put any generic races or classes
    
    externalFiles - the optional list to put a map of file paths to their contents
    
    Returns:
    
    "" if all went well, or an error message
    
    See Also:
    
    GenericBuilder.fillAreaAndCustomVectorFromXML(String, List, List, Map)
  - addAutoPropsToAreaIfNecessary
```
public void addAutoPropsToAreaIfNecessary(Area newArea)
```
    Description copied from interface: GenericBuilder
    
    Called when a new area enters the game in order to add any Automatic/Default properties to the area that are specified in the INI file.
    
    Specified by:
    
    addAutoPropsToAreaIfNecessary in interface GenericBuilder
    
    Parameters:
    
    newArea - the area to add things to, if necessary
  - unpackAreaFromXML
```
public java.lang.String unpackAreaFromXML(java.util.List<XMLLibrary.XMLTag> aV,
                                          Session S,
                                          java.lang.String overrideAreaType,
                                          boolean andRooms,
                                          boolean savable)
```
    Description copied from interface: GenericBuilder
    
    Given a pre-parsed XML document containing an ACLAS tag, this method will unpack the given area into an area object, optionally complete with rooms, items, mobs, etc. An optional session can be sent which will receive progress messages. An optional area class id can be sent to override whatever is in the xml document. The area can also optionally be saved to the database and added to the game map.
    
    Specified by:
    
    unpackAreaFromXML in interface GenericBuilder
    
    Parameters:
    
    aV - parsed XML document of the inside of the AREA tag.
    
    S - an optional session for monitoring, or null
    
    overrideAreaType - null, or an area class id
    
    andRooms - true to also unpack rooms, mobs, and items, false otherwise
    
    savable - true to save to the db and add to the map
    
    Returns:
    
    any errors, or "" for no errors
    
    See Also:
    
    GenericBuilder.getAreaObjectXML(Area, Session, Set, Set, boolean), GenericBuilder.getAreaXML(Area, Session, Set, Set, boolean)
  - unpackAreaFromXML
```
protected java.lang.String unpackAreaFromXML(java.lang.String buf,
                                             Session S,
                                             java.lang.String overrideAreaType,
                                             boolean andRooms)
```
  - unpackAreaObjectFromXML
```
public Area unpackAreaObjectFromXML(java.lang.String xml)
                             throws CMException
```
    Description copied from interface: GenericBuilder
    
    Unpack an XML document containing an AREA tag into an actual area object, including any rooms, mobs, items, etc. Saves nothing to the db, or to the world map. Just returns the populated object.
    
    Specified by:
    
    unpackAreaObjectFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document containing an AREA tag
    
    Returns:
    
    the populated area object
    
    Throws:
    
    CMException - any unpacking errors, bad xml, etc
    
    See Also:
    
    GenericBuilder.getAreaObjectXML(Area, Session, Set, Set, boolean), GenericBuilder.getAreaXML(Area, Session, Set, Set, boolean)
  - getAreaXML
```
public java.lang.String getAreaXML(Area area,
                                   Session S,
                                   java.util.Set<CMObject> custom,
                                   java.util.Set<java.lang.String> files,
                                   boolean andRooms)
```
    Description copied from interface: GenericBuilder
    
    Generates an xml document of the given area, and optionally all of its rooms. It will also split out any files, or local generic races and classes for optional inclusion. The area must be in the database, as the rooms will be refreshed from there.
    
    Specified by:
    
    getAreaXML in interface GenericBuilder
    
    Parameters:
    
    area - the area to generate an xml document for
    
    S - optional session for progress messages, or null
    
    custom - optional set to put generic races/classes into
    
    files - optional set to put the paths to scripts used in the room
    
    andRooms - true to include rooms/mobs/items, false otherwise
    
    Returns:
    
    the xml document for the area
    
    See Also:
    
    GenericBuilder.unpackAreaFromXML(List, Session, String, boolean, boolean), GenericBuilder.unpackAreaObjectFromXML(String)
  - getAreaObjectXML
```
public java.lang.String getAreaObjectXML(Area area,
                                         Session S,
                                         java.util.Set<CMObject> custom,
                                         java.util.Set<java.lang.String> files,
                                         boolean andRooms)
```
    Description copied from interface: GenericBuilder
    
    Generates an xml document of the given area, and optionally all of its rooms. It will also split out any files, or local generic races and classes for optional inclusion. The area need not be in the database, as the room xml will be generated from memory.
    
    Specified by:
    
    getAreaObjectXML in interface GenericBuilder
    
    Parameters:
    
    area - the area to generate an xml document for
    
    S - optional session for progress messages, or null
    
    custom - optional set to put generic races/classes into
    
    files - optional set to put the paths to scripts used in the room
    
    andRooms - true to include rooms/mobs/items, false otherwise
    
    Returns:
    
    the xml document for the area
    
    See Also:
    
    GenericBuilder.unpackAreaFromXML(List, Session, String, boolean, boolean), GenericBuilder.unpackAreaObjectFromXML(String)
  - getAreaXML
```
protected java.lang.String getAreaXML(Area area,
                                      Session S,
                                      java.util.Set<CMObject> custom,
                                      java.util.Set<java.lang.String> files,
                                      boolean andRooms,
                                      boolean isInDB)
```
  - logTextDiff
```
protected java.lang.String logTextDiff(java.lang.String e1,
                                       java.lang.String e2)
```
  - logDiff
```
protected void logDiff(Environmental E1,
                       Environmental E2)
```
  - makeNewRoomContent
```
public Room makeNewRoomContent(Room room,
                               boolean makeLive)
```
    Description copied from interface: GenericBuilder
    
    Duplicates the contents of an official database room by reloading the room and its contents into a new room object. You can optionally activate the room as a full map member.
    
    Specified by:
    
    makeNewRoomContent in interface GenericBuilder
    
    Parameters:
    
    room - the room with an id to duplicate
    
    makeLive - true to make the room live, or false to leave passive and unticking
    
    Returns:
    
    the new room object
  - getMobXML
```
public java.lang.String getMobXML(MOB mob)
```
    Description copied from interface: GenericBuilder
    
    Returns an xml document representing the given mob, wrapped in a neat MOB tag. No custom objects or scripts are captured.
    
    Specified by:
    
    getMobXML in interface GenericBuilder
    
    Parameters:
    
    mob - the mob to get the xml of
    
    Returns:
    
    the full xml of the mob
    
    See Also:
    
    GenericBuilder.addMOBsFromXML(String, List, Session), GenericBuilder.addMOBsFromXML(List, List, Session), GenericBuilder.getUniqueMobsXML(List, Set, Set, Map), GenericBuilder.unpackMobFromXML(String)
  - getExitXML
```
protected java.lang.String getExitXML(Exit exit)
```
  - getUniqueMobsXML
```
public java.lang.String getUniqueMobsXML(java.util.List<MOB> mobs,
                                         java.util.Set<CMObject> custom,
                                         java.util.Set<java.lang.String> files,
                                         java.util.Map<java.lang.String,java.util.List<MOB>> found)
```
    Description copied from interface: GenericBuilder
    
    Given a list of mob objects, this will return an xml document of the set of MOBs, but only returning any unique mobs from the list, relegating dups to the give map. It will also populate sets with any script paths or generic races and classes found.
    
    Specified by:
    
    getUniqueMobsXML in interface GenericBuilder
    
    Parameters:
    
    mobs - the list of mobs to create xml for
    
    custom - any generic races/classes found
    
    files - any script paths found
    
    found - required map to keep track of dups, for some reason
    
    Returns:
    
    the xml document of the unique mobs from the list
    
    See Also:
    
    GenericBuilder.getMobXML(MOB), GenericBuilder.unpackMobFromXML(String), GenericBuilder.addMOBsFromXML(List, List, Session), GenericBuilder.addMOBsFromXML(String, List, Session)
  - possiblyAddCustomRace
```
protected void possiblyAddCustomRace(MOB mob,
                                     java.util.Set<CMObject> custom)
```
  - possiblyAddCustomClass
```
protected void possiblyAddCustomClass(MOB mob,
                                      java.util.Set<CMObject> custom)
```
  - possiblyAddCustomEffect
```
protected void possiblyAddCustomEffect(Physical P,
                                       java.util.Set<CMObject> custom)
```
  - possiblyAddCustomAbility
```
protected void possiblyAddCustomAbility(MOB mob,
                                        java.util.Set<CMObject> custom)
```
  - getRoomMobs
```
public java.lang.String getRoomMobs(Room room,
                                    java.util.Set<CMObject> custom,
                                    java.util.Set<java.lang.String> files,
                                    java.util.Map<java.lang.String,java.util.List<MOB>> found)
```
    Description copied from interface: GenericBuilder
    
    Given a database room, this function will grab its real contents from the database, and construct an xml document consisting of the unique mobs in the room. It will also populate a set with custom races and classes, and a set with the paths of any externally used files, as well as use a map to keep track of duplicates.
    
    Specified by:
    
    getRoomMobs in interface GenericBuilder
    
    Parameters:
    
    room - the room to get mobs from
    
    custom - a set for any generic classes or races
    
    files - a set for any file paths used
    
    found - a map for keeping track of dups
    
    Returns:
    
    the xml document of mobs
  - getUniqueItemXML
```
protected java.lang.String getUniqueItemXML(Item item,
                                            CMClass.CMObjectType type,
                                            java.util.Map<java.lang.String,java.util.List<Item>> found,
                                            java.util.Set<java.lang.String> files)
```
  - getItemXML
```
public java.lang.String getItemXML(Item item)
```
    Description copied from interface: GenericBuilder
    
    Returns an xml document representing the given item, wrapped in a neat ITEM tag. No custom objects or scripts are captured.
    
    Specified by:
    
    getItemXML in interface GenericBuilder
    
    Parameters:
    
    item - the item to get the xml of
    
    Returns:
    
    the full xml of the item
    
    See Also:
    
    GenericBuilder.addItemsFromXML(String, List, Session), GenericBuilder.addItemsFromXML(List, List, Session), GenericBuilder.getUniqueItemsXML(List, Map, Set, CMObjectType), GenericBuilder.unpackItemFromXML(String)
  - unpackItemFromXML
```
public Item unpackItemFromXML(java.lang.String xmlBuffer)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document with a ITEM tag in it, this will extract and create the associated item object. Any generic races or scripts must already exist.
    
    Specified by:
    
    unpackItemFromXML in interface GenericBuilder
    
    Parameters:
    
    xmlBuffer - the xml document with the item tag
    
    Returns:
    
    the item object, or null
    
    See Also:
    
    GenericBuilder.getUniqueItemsXML(List, Map, Set, CMObjectType), GenericBuilder.getItemXML(Item), GenericBuilder.addItemsFromXML(String, List, Session), GenericBuilder.addItemsFromXML(List, List, Session)
  - addItemsFromXML
```
public java.lang.String addItemsFromXML(java.util.List<XMLLibrary.XMLTag> xml,
                                        java.util.List<Item> addHere,
                                        Session S)
```
    Description copied from interface: GenericBuilder
    
    Given a pre-parsed xml document containing a ITEMs tag, this will build a set of item objects and add them to the given list. An optional session can handle any progress reporting. Returns an error, or "".
    
    Specified by:
    
    addItemsFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document with the ITEMs tag
    
    addHere - the list to add the item objects to
    
    S - an optional session object for progress
    
    Returns:
    
    "", or an error message
    
    See Also:
    
    GenericBuilder.getUniqueItemsXML(List, Map, Set, CMObjectType), GenericBuilder.getItemXML(Item), GenericBuilder.addItemsFromXML(String, List, Session), GenericBuilder.unpackItemFromXML(String)
  - addMOBsFromXML
```
public java.lang.String addMOBsFromXML(java.util.List<XMLLibrary.XMLTag> xml,
                                       java.util.List<MOB> addHere,
                                       Session S)
```
    Description copied from interface: GenericBuilder
    
    Given a pre-parsed xml document containing a MOBS tag, this will build a set of mob objects and add them to the given list. An optional session can handle any progress reporting. Returns an error, or "".
    
    Specified by:
    
    addMOBsFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document with the MOBS tag
    
    addHere - the list to add the mob objects to
    
    S - an optional session object for progress
    
    Returns:
    
    "", or an error message
    
    See Also:
    
    GenericBuilder.getMobXML(MOB), GenericBuilder.addMOBsFromXML(String, List, Session), GenericBuilder.getUniqueMobsXML(List, Set, Set, Map), GenericBuilder.unpackMobFromXML(String)
  - addItemsFromXML
```
public java.lang.String addItemsFromXML(java.lang.String xmlBuffer,
                                        java.util.List<Item> addHere,
                                        Session S)
```
    Description copied from interface: GenericBuilder
    
    Given a String xml document containing a ITEMs tag, this will build a set of item objects and add them to the given list. An optional session can handle any progress reporting. Returns an error, or "".
    
    Specified by:
    
    addItemsFromXML in interface GenericBuilder
    
    Parameters:
    
    xmlBuffer - the xml document with the ITEMs tag
    
    addHere - the list to add the item objects to
    
    S - an optional session object for progress
    
    Returns:
    
    "", or an error message
    
    See Also:
    
    GenericBuilder.getUniqueItemsXML(List, Map, Set, CMObjectType), GenericBuilder.getItemXML(Item), GenericBuilder.addItemsFromXML(List, List, Session), GenericBuilder.unpackItemFromXML(String)
  - getUnknownTypeFromXML
```
public CMClass.CMObjectType getUnknownTypeFromXML(java.lang.String xml)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document that starts with a MOB, ITEM, AROOM, or EXIT tag, this will return the appropriate CMOBjectType
    
    Specified by:
    
    getUnknownTypeFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document to get the type of
    
    Returns:
    
    the object type
    
    See Also:
    
    CMClass.CMObjectType, GenericBuilder.getUnknownNameFromXML(String)
  - getUnknownNameFromXML
```
public java.lang.String getUnknownNameFromXML(java.lang.String xml)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document with a mob, item, or room, this will return the value of the first NAME or RDISP tag found herein.
    
    Specified by:
    
    getUnknownNameFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document to get a name from
    
    Returns:
    
    the name
    
    See Also:
    
    GenericBuilder.getUnknownTypeFromXML(String)
  - unpackUnknownFromXML
```
public Environmental unpackUnknownFromXML(java.lang.String xml)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document for a single item, mob, room, or exit, this will return the fully formed object represented by the document.
    
    Specified by:
    
    unpackUnknownFromXML in interface GenericBuilder
    
    Parameters:
    
    xml - the xml document
    
    Returns:
    
    the item, mob, room, or exit object
    
    See Also:
    
    GenericBuilder.getUnknownXML(Environmental)
  - getUnknownXML
```
public java.lang.String getUnknownXML(Environmental obj)
```
    Description copied from interface: GenericBuilder
    
    Given an item, mob, room, or exit, this will return the full XML document for that object.
    
    Specified by:
    
    getUnknownXML in interface GenericBuilder
    
    Parameters:
    
    obj - the object to get xml for
    
    Returns:
    
    the xml
    
    See Also:
    
    GenericBuilder.unpackUnknownFromXML(String)
  - unpackMobFromXML
```
public MOB unpackMobFromXML(java.lang.String xmlBuffer)
```
    Description copied from interface: GenericBuilder
    
    Given an xml document with a MOB tag in it, this will extract and create the associated mob object. Any generic races or scripts must already exist.
    
    Specified by:
    
    unpackMobFromXML in interface GenericBuilder
    
    Parameters:
    
    xmlBuffer - the xml document with the mob tag
    
    Returns:
    
    the mob object, or null
    
    See Also:
    
    GenericBuilder.getUniqueMobsXML(List, Set, Set, Map), GenericBuilder.getMobXML(MOB), GenericBuilder.addMOBsFromXML(List, List, Session), GenericBuilder.addMOBsFromXML(String, List, Session)
  - addMOBsFromXML
```
public java.lang.String addMOBsFromXML(java.lang.String xmlBuffer,
                                       java.util.List<MOB> addHere,
                                       Session S)
```
    Description copied from interface: GenericBuilder
    
    Given a string xml document containing a MOBS tag, this will build a set of mob objects and add them to the given list. An optional session can handle any progress reporting. Returns an error, or "".
    
    Specified by:
    
    addMOBsFromXML in interface GenericBuilder
    
    Parameters:
    
    xmlBuffer - the xml document with the MOBS tag
    
    addHere - the list to add the mob objects to
    
    S - an optional session object for progress
    
    Returns:
    
    "", or an error message
    
    See Also:
    
    GenericBuilder.getMobXML(MOB), GenericBuilder.addMOBsFromXML(List, List, Session), GenericBuilder.getUniqueMobsXML(List, Set, Set, Map), GenericBuilder.unpackMobFromXML(String)
  - getUniqueItemsXML
```
public java.lang.String getUniqueItemsXML(java.util.List<Item> items,
                                          java.util.Map<java.lang.String,java.util.List<Item>> found,
                                          java.util.Set<java.lang.String> files,
                                          CMClass.CMObjectType type)
```
    Description copied from interface: GenericBuilder
    
    Given a list of item objects, this will return an xml document of the set of ITEMs, but only returning any unique item from the list, relegating dups to the give map. It will also populate sets with any script paths or generic races and classes found.
    
    Specified by:
    
    getUniqueItemsXML in interface GenericBuilder
    
    Parameters:
    
    items - the list of items to create xml for
    
    found - required map to keep track of dups, for some reason
    
    files - any script paths found
    
    type - object type of item to grab
    
    Returns:
    
    the xml document of the unique items from the list
    
    See Also:
    
    GenericBuilder.getItemXML(Item), GenericBuilder.addItemsFromXML(String, List, Session), GenericBuilder.addItemsFromXML(List, List, Session), GenericBuilder.unpackItemFromXML(String)
  - getRoomItems
```
public java.lang.String getRoomItems(Room room,
                                     java.util.Map<java.lang.String,java.util.List<Item>> found,
                                     java.util.Set<java.lang.String> files,
                                     CMClass.CMObjectType type)
```
    Description copied from interface: GenericBuilder
    
    Given a database room, this function will grab its real contents from the database, and construct an xml document consisting of the unique items in the room. It will also filter based on type, or populate a set with the paths of any externally used files, as well as use a map to keep track of duplicates.
    
    Specified by:
    
    getRoomItems in interface GenericBuilder
    
    Parameters:
    
    room - the room to get items from
    
    found - a map for keeping track of dups
    
    files - a set for any file paths used
    
    type - the object type filter
    
    Returns:
    
    the xml document of items
  - getRoomXML
```
public java.lang.String getRoomXML(Room room,
                                   java.util.Set<CMObject> custom,
                                   java.util.Set<java.lang.String> files,
                                   boolean andContent)
```
    Description copied from interface: GenericBuilder
    
    Generates an xml document of the given room, and optionally all of its contents. It will also split out any files, or local generic races and classes for optional inclusion.
    
    Specified by:
    
    getRoomXML in interface GenericBuilder
    
    Parameters:
    
    room - the room to generate an xml document for
    
    custom - optional set to put generic races/classes into
    
    files - optional set to put the paths to scripts used in the room
    
    andContent - true to include mobs/items, false otherwise
    
    Returns:
    
    the xml document for the room
    
    See Also:
    
    GenericBuilder.unpackRoomFromXML(String, boolean), GenericBuilder.unpackRoomFromXML(Area, List, boolean, boolean)
  - getRoomXML
```
protected java.lang.String getRoomXML(Room room,
                                      java.util.Set<CMObject> custom,
                                      java.util.Set<java.lang.String> files,
                                      boolean andContent,
                                      boolean andIsInDB,
                                      boolean skipDoors)
```
  - unpackEnvironmentalMiscTextXML
```
public void unpackEnvironmentalMiscTextXML(Environmental E,
                                           java.lang.String buf,
                                           boolean fromTop)
```
    Description copied from interface: GenericBuilder
    
    Given a string xml document, and an environmental to unpack the xml properties into, this will, well, do that. Send fromTop to handle ordinary properties for standard items.
    
    Specified by:
    
    unpackEnvironmentalMiscTextXML in interface GenericBuilder
    
    Parameters:
    
    E - the environmental object to populate
    
    buf - the xml doc
    
    fromTop - true to unpack xml for standard objects
    
    See Also:
    
    GenericBuilder.getEnvironmentalMiscTextXML(Environmental, boolean), GenericBuilder.unpackEnvironmentalMiscTextXML(Environmental, List, boolean)
  - recoverPhysical
```
protected void recoverPhysical(Physical P)
```
  - unpackEnvironmentalMiscTextXML
```
public void unpackEnvironmentalMiscTextXML(Environmental E,
                                           java.util.List<XMLLibrary.XMLTag> V,
                                           boolean fromTop)
```
    Description copied from interface: GenericBuilder
    
    Given a parsed xml document, and an environmental to unpack the xml properties into, this will, well, do that. Send fromTop to handle ordinary properties for standard items.
    
    Specified by:
    
    unpackEnvironmentalMiscTextXML in interface GenericBuilder
    
    Parameters:
    
    E - the environmental object to populate
    
    V - the parsed xml doc
    
    fromTop - true to unpack xml for standard objects
    
    See Also:
    
    GenericBuilder.getEnvironmentalMiscTextXML(Environmental, boolean), GenericBuilder.unpackEnvironmentalMiscTextXML(Environmental, String, boolean)
  - setOrdPropertiesFromXML
```
protected void setOrdPropertiesFromXML(Environmental E,
                                       java.util.List<XMLLibrary.XMLTag> V)
```
  - setGenMobAbilities
```
protected void setGenMobAbilities(MOB M,
                                  java.util.List<XMLLibrary.XMLTag> buf)
```
  - unpackGenScriptsXML
```
public void unpackGenScriptsXML(PhysicalAgent E,
                                java.util.List<XMLLibrary.XMLTag> buf,
                                boolean restoreVars)
```
    Description copied from interface: GenericBuilder
    
    From the given XML tags, set any object level Scripts attached to the given PhysicalAgent object. If restoreVars is true, then any variable values stored in the XML document are also restored.
    
    Specified by:
    
    unpackGenScriptsXML in interface GenericBuilder
    
    Parameters:
    
    E - the object to give scripts to
    
    buf - the xml tags containing scripts
    
    restoreVars - true to look for saved variables and restore them
    
    See Also:
    
    GenericBuilder.getGenScriptsXML(PhysicalAgent, boolean)
  - setGenMobInventory
```
protected void setGenMobInventory(MOB M,
                                  java.util.List<XMLLibrary.XMLTag> buf)
```
  - populateShops
```
public void populateShops(ShopKeeper shopKeep,
                          java.util.List<XMLLibrary.XMLTag> buf)
```
    Description copied from interface: GenericBuilder
    
    Given parsed xml tags, this method will extract the basic shop settings into the given ShopKeeper object, as well as populate the shop inventory itself from the given xml.
    
    Specified by:
    
    populateShops in interface GenericBuilder
    
    Parameters:
    
    shopKeep - the shopkeeper to populate
    
    buf - the parsed xml doc with STORE, etc tags
  - handleCatalogItem
```
public boolean handleCatalogItem(Physical P,
                                 java.util.List<XMLLibrary.XMLTag> buf,
                                 boolean fromTop)
```
  - getQuickName
```
public java.lang.String getQuickName(java.lang.String classID,
                                     java.lang.String miscText)
```
    Description copied from interface: GenericBuilder
    
    Weird function. Given an optional xml doc in miscText, it will return the value of the first <NAME> tag found. If not, then, given a standard mob or item class id, this will return the name of that standard object.
    
    Specified by:
    
    getQuickName in interface GenericBuilder
    
    Parameters:
    
    classID - the optional standard class id object
    
    miscText - the optional xml document with NAME tag
    
    Returns:
    
    a name derived from one of the fields, or ""
  - getAllGenStats
```
public java.util.List<java.lang.String> getAllGenStats(Physical P)
```
    Description copied from interface: GenericBuilder
    
    Returns the list of basic generic state codes applicable to the given object. It does not rely on the Modifiable interface. It also does not support any of the fake GenItem or GenMobBonusFakeStats stats.
    
    Specified by:
    
    getAllGenStats in interface GenericBuilder
    
    Parameters:
    
    P - the object to get stat codes for
    
    Returns:
    
    the list of stat codes.
  - getFinalStatName
```
public java.lang.String getFinalStatName(java.lang.String stat)
```
    Description copied from interface: GenericBuilder
    
    Removes any qualifying prefixes from stat names, to reveal the underlying stat code. Prefixes include things like CURRENT_, CURRENT ,BASE_, BASE ,MAX_, and MAX
    
    Specified by:
    
    getFinalStatName in interface GenericBuilder
    
    Parameters:
    
    stat - the possibly qualified stat code
    
    Returns:
    
    the underlying state code
  - isAnyGenStat
```
public boolean isAnyGenStat(Physical P,
                            java.lang.String stat)
```
    Description copied from interface: GenericBuilder
    
    Returns whether the given string represents any of the "AnyGen" stat codes for the given type object, even if the object is not generic. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.
    
    Specified by:
    
    isAnyGenStat in interface GenericBuilder
    
    Parameters:
    
    P - the type of object to check
    
    stat - the stat code to check
    
    Returns:
    
    true if the stat code can apply, false otherwise
    
    See Also:
    
    GenericBuilder.setAnyGenStat(Physical, String, String), GenericBuilder.setAnyGenStat(Physical, String, String, boolean), GenericBuilder.getAnyGenStat(Physical, String)
  - getAnyGenStat
```
public java.lang.String getAnyGenStat(Physical P,
                                      java.lang.String stat)
```
    Description copied from interface: GenericBuilder
    
    Returns the value of the given stat on the given object, even if the object is not generic. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.
    
    Specified by:
    
    getAnyGenStat in interface GenericBuilder
    
    Parameters:
    
    P - the type of object to read
    
    stat - the stat code to read
    
    Returns:
    
    the value of the stat, or ""
    
    See Also:
    
    GenericBuilder.setAnyGenStat(Physical, String, String), GenericBuilder.setAnyGenStat(Physical, String, String, boolean), GenericBuilder.isAnyGenStat(Physical, String)
  - setAnyGenStat
```
public void setAnyGenStat(Physical P,
                          java.lang.String stat,
                          java.lang.String value)
```
    Description copied from interface: GenericBuilder
    
    Sets the value of the given stat on the given object, even if the object is not generic. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.
    
    Specified by:
    
    setAnyGenStat in interface GenericBuilder
    
    Parameters:
    
    P - the type of object to change
    
    stat - the stat code to change
    
    value - the new value for the stat
    
    See Also:
    
    GenericBuilder.setAnyGenStat(Physical, String, String, boolean), GenericBuilder.getAnyGenStat(Physical, String), GenericBuilder.isAnyGenStat(Physical, String)
  - setAnyGenStat
```
public void setAnyGenStat(Physical P,
                          java.lang.String stat,
                          java.lang.String value,
                          boolean supportPlusMinusPrefix)
```
    Description copied from interface: GenericBuilder
    
    Sets the value of the given stat on the given object, even if the object is not generic. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported. This method supports deltas to numeric values as well, by sending a value with + or - as a prefix.
    
    Specified by:
    
    setAnyGenStat in interface GenericBuilder
    
    Parameters:
    
    P - the type of object to change
    
    stat - the stat code to change
    
    value - the new value for the stat
    
    supportPlusMinusPrefix - true to support += prefix
    
    See Also:
    
    GenericBuilder.setAnyGenStat(Physical, String, String), GenericBuilder.getAnyGenStat(Physical, String), GenericBuilder.isAnyGenStat(Physical, String)
  - setGenPropertiesFromXML
```
protected void setGenPropertiesFromXML(Environmental E,
                                       java.util.List<XMLLibrary.XMLTag> buf)
```
  - getAccountXML
```
public java.lang.String getAccountXML(PlayerAccount account,
                                      java.util.Set<CMObject> custom,
                                      java.util.Set<java.lang.String> files)
```
    Description copied from interface: GenericBuilder
    
    Given a player account, this will return an XML document of the account objects, as well as all characters contained in the account. Dependency custom objects and script file paths can optionally be captured during this process.
    
    Specified by:
    
    getAccountXML in interface GenericBuilder
    
    Parameters:
    
    account - the account to get the xml of
    
    custom - optional set in which to capture custom classes, races
    
    files - optional set in which to capture script paths
    
    Returns:
    
    the xml document of the account
    
    See Also:
    
    GenericBuilder.addPlayersAndAccountsFromXML(String, List, List, Session)
  - getPlayerXML
```
public java.lang.String getPlayerXML(MOB mob,
                                     java.util.Set<CMObject> custom,
                                     java.util.Set<java.lang.String> files)
```
    Description copied from interface: GenericBuilder
    
    Give a player/character mob, this will return an xml document of the mob object, as well as any items, etc contained therein. Dependency custom objects and script file paths can optionally be captured during this process.
    
    Specified by:
    
    getPlayerXML in interface GenericBuilder
    
    Parameters:
    
    mob - the player/character mob to get the xml of
    
    custom - optional set in which to capture custom classes, races
    
    files - optional set in which to capture script paths
    
    Returns:
    
    the xml document of the character
    
    See Also:
    
    GenericBuilder.addPlayersAndAccountsFromXML(String, List, List, Session)
  - addPlayersOnlyFromXML
```
protected java.lang.String addPlayersOnlyFromXML(java.util.List<XMLLibrary.XMLTag> mV,
                                                 java.util.List<MOB> addMobs,
                                                 Session S)
```
  - addPlayersAndAccountsFromXML
```
public java.lang.String addPlayersAndAccountsFromXML(java.lang.String xmlBuffer,
                                                     java.util.List<PlayerAccount> addAccounts,
                                                     java.util.List<MOB> addMobs,
                                                     Session S)
```
    Description copied from interface: GenericBuilder
    
    Creates player account objects and player character MOB objects from the given XML document. If a Session is sent, then any confirmations or special messages are done through that session. This does not actually save the accounts or characters to the database.
    
    Specified by:
    
    addPlayersAndAccountsFromXML in interface GenericBuilder
    
    Parameters:
    
    xmlBuffer - the XML document
    
    addAccounts - the list to put accounts into
    
    addMobs - the list to put character mobsinto
    
    S - an optional session object for interaction
    
    Returns:
    
    any errors that occurred, or "" for all-OK
    
    See Also:
    
    GenericBuilder.getPlayerXML(MOB, Set, Set), GenericBuilder.getAccountXML(PlayerAccount, Set, Set)
  - getExtraEnvironmentalXML
```
public java.lang.String getExtraEnvironmentalXML(Environmental E)
```
    Description copied from interface: GenericBuilder
    
    From the given Environmental, returns xml of certain object settings that come from the objects most basic interfaces, such as Physical, Economic, PhysicalAgent, extra bonus stats, and scripts.
    
    Specified by:
    
    getExtraEnvironmentalXML in interface GenericBuilder
    
    Parameters:
    
    E - the object to give settings to
    
    Returns:
    
    the xml tags containing settings
    
    See Also:
    
    GenericBuilder.unpackExtraEnvironmentalXML(Environmental, List), GenericBuilder.getGenScriptsXML(PhysicalAgent, boolean)
  - fillFileSet
```
public void fillFileSet(java.util.List<java.lang.String> V,
                        java.util.Set<java.lang.String> H)
```
  - fillFileSet
```
public void fillFileSet(Environmental E,
                        java.util.Set<java.lang.String> H)
```
    Description copied from interface: GenericBuilder
    
    Attempts to fill the given set full of script file paths from the object given by recursively inspecting it for embedded scripts, digging into mob and store inventory and so forth.
    
    Specified by:
    
    fillFileSet in interface GenericBuilder
    
    Parameters:
    
    E - the top level object to dig for script paths
    
    H - the set of script paths found
    
    See Also:
    
    GenericBuilder.fillFileMap(Environmental, Map)
  - fillFileMap
```
protected void fillFileMap(Environmental E,
                           java.util.List<java.lang.String> V,
                           java.util.Map<java.lang.String,java.util.Set<Environmental>> H)
```
  - fillFileMap
```
public void fillFileMap(Environmental E,
                        java.util.Map<java.lang.String,java.util.Set<Environmental>> H)
```
    Description copied from interface: GenericBuilder
    
    Attempts to fill the given map of script file paths to set of object that use the script. Does so recursively, going into mob and store inventory and so forth.
    
    Specified by:
    
    fillFileMap in interface GenericBuilder
    
    Parameters:
    
    E - the top level object to go digging for script paths
    
    H - the map to fill.
    
    See Also:
    
    GenericBuilder.fillFileSet(Environmental, Set)
  - getPhyStatsStr
```
public java.lang.String getPhyStatsStr(PhyStats E)
```
    Description copied from interface: GenericBuilder
    
    Given the PhyStats object, returns the encoded string representing the values in the object. The encoding is the values of the object, in ordinal order, separated by | chars.
    
    Specified by:
    
    getPhyStatsStr in interface GenericBuilder
    
    Parameters:
    
    E - the PhyStats Object
    
    Returns:
    
    the encoded values object
    
    See Also:
    
    GenericBuilder.setPhyStats(PhyStats, String)
  - getCharStateStr
```
public java.lang.String getCharStateStr(CharState E)
```
    Description copied from interface: GenericBuilder
    
    Given the CharState object, returns the encoded string representing the values in the object. The encoding is the values of the object, in ordinal order, separated by | chars.
    
    Specified by:
    
    getCharStateStr in interface GenericBuilder
    
    Parameters:
    
    E - the CharState Object
    
    Returns:
    
    the encoded values object
    
    See Also:
    
    GenericBuilder.setCharState(CharState, String)
  - getCharStatsStr
```
public java.lang.String getCharStatsStr(CharStats E)
```
    Description copied from interface: GenericBuilder
    
    Given the CharStats object, returns the encoded string representing the values in the object. The encoding is the values of the object, in ordinal order, separated by | chars.
    
    Specified by:
    
    getCharStatsStr in interface GenericBuilder
    
    Parameters:
    
    E - the CharStats Object
    
    Returns:
    
    the encoded values object
    
    See Also:
    
    GenericBuilder.setCharStats(CharStats, String)
  - getEnvPropertiesStr
```
protected java.lang.String getEnvPropertiesStr(Environmental E)
```
  - setCharStats
```
public void setCharStats(CharStats E,
                         java.lang.String props)
```
    Description copied from interface: GenericBuilder
    
    Sets the values in the given CharStats object from the encoded string. The encoding is the values of the object in ordinal order separated by | chars
    
    Specified by:
    
    setCharStats in interface GenericBuilder
    
    Parameters:
    
    E - the CharStats object to alter
    
    props - the encoded values
    
    See Also:
    
    GenericBuilder.getCharStatsStr(CharStats)
  - setCharState
```
public void setCharState(CharState E,
                         java.lang.String props)
```
    Description copied from interface: GenericBuilder
    
    Sets the values in the given CharState object from the encoded string. The encoding is the values of the object in ordinal order separated by | chars
    
    Specified by:
    
    setCharState in interface GenericBuilder
    
    Parameters:
    
    E - the CharState object to alter
    
    props - the encoded values
    
    See Also:
    
    GenericBuilder.getCharStateStr(CharState)
  - setPhyStats
```
public void setPhyStats(PhyStats E,
                        java.lang.String props)
```
    Description copied from interface: GenericBuilder
    
    Sets the values in the given PhyStats object from the encoded string. The encoding is the values of the object in ordinal order separated by | chars
    
    Specified by:
    
    setPhyStats in interface GenericBuilder
    
    Parameters:
    
    E - the PhyStats object to alter
    
    props - the encoded values
    
    See Also:
    
    GenericBuilder.getPhyStatsStr(PhyStats)
  - setEnvProperties
```
protected void setEnvProperties(Environmental E,
                                java.util.List<XMLLibrary.XMLTag> buf)
```
  - identifier
```
protected java.lang.String identifier(Environmental E,
                                      Environmental parent)
```
  - unpackExtraEnvironmentalXML
```
public void unpackExtraEnvironmentalXML(Environmental E,
                                        java.util.List<XMLLibrary.XMLTag> buf)
```
    Description copied from interface: GenericBuilder
    
    From the given XML tags, set certain given object settings that come from the objects most basic interfaces, such as Physical, Economic, PhysicalAgent, extra bonus stats
    
    Specified by:
    
    unpackExtraEnvironmentalXML in interface GenericBuilder
    
    Parameters:
    
    E - the object to give settings to
    
    buf - the xml tags containing settings
    
    See Also:
    
    GenericBuilder.getExtraEnvironmentalXML(Environmental)
  - makeAmmunition
```
public Ammunition makeAmmunition(java.lang.String ammunitionType,
                                 int number)
```
    Description copied from interface: GenericBuilder
    
    Create a standard GenAmmunition Item, representing a bundle of ammo, of the give type and number.
    
    Specified by:
    
    makeAmmunition in interface GenericBuilder
    
    Parameters:
    
    ammunitionType - the type of ammo "arrows" "bullets", etc.
    
    number - the number of ammo in the bundle
    
    Returns:
    
    the new GenAmmunition object
  - getGenItemCodeNum
```
public int getGenItemCodeNum(java.lang.String code)
```
    Description copied from interface: GenericBuilder
    
    Returns the ordinal of the given code in the basic genitem stat codes. It does not rely on the Modifiable interface. It also does not support any of the fake GenItemBonusFakeStats stats.
    
    Specified by:
    
    getGenItemCodeNum in interface GenericBuilder
    
    Parameters:
    
    code - the stat code
    
    Returns:
    
    the ordinal of the stat
    
    See Also:
    
    GenericBuilder.getGenItemStat(Item, String), GenericBuilder.setGenItemStat(Item, String, String)
  - getGenItemStat
```
public java.lang.String getGenItemStat(Item I,
                                       java.lang.String code)
```
    Description copied from interface: GenericBuilder
    
    Gets the value of a basic genitem stat, even if the mob given is not generic. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenItemBonusFakeStats stats.
    
    Specified by:
    
    getGenItemStat in interface GenericBuilder
    
    Parameters:
    
    I - the item object to read
    
    code - the stat code to return the value of
    
    Returns:
    
    the value of the stat
    
    See Also:
    
    GenericBuilder.getGenItemCodeNum(String), GenericBuilder.setGenItemStat(Item, String, String)
  - setGenItemStat
```
public void setGenItemStat(Item I,
                           java.lang.String code,
                           java.lang.String val)
```
    Description copied from interface: GenericBuilder
    
    Sets the value of a basic genitem stat, even if the mob given is not generic. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenItemBonusFakeStats stats.
    
    Specified by:
    
    setGenItemStat in interface GenericBuilder
    
    Parameters:
    
    I - the item object to modify
    
    code - the stat code to modify
    
    val - the value to set the stat to
    
    See Also:
    
    GenericBuilder.getGenItemStat(Item, String), GenericBuilder.getGenItemCodeNum(String)
  - getGenMobCodeNum
```
public int getGenMobCodeNum(java.lang.String code)
```
    Description copied from interface: GenericBuilder
    
    Returns the ordinal of the given code in the basic genmob stat codes.
    
    Specified by:
    
    getGenMobCodeNum in interface GenericBuilder
    
    Parameters:
    
    code - the stat code
    
    Returns:
    
    the ordinal of the stat
    
    See Also:
    
    GenericBuilder.getGenMobStat(MOB, String), GenericBuilder.setGenMobStat(MOB, String, String)
  - getGenMobStat
```
public java.lang.String getGenMobStat(MOB M,
                                      java.lang.String code)
```
    Description copied from interface: GenericBuilder
    
    Gets the value of a basic genmob stat, even if the mob given is not generic. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenMOBBonusFakeStats stats.
    
    Specified by:
    
    getGenMobStat in interface GenericBuilder
    
    Parameters:
    
    M - the mob object to read
    
    code - the stat code to return the value of
    
    Returns:
    
    the value of the stat
    
    See Also:
    
    GenericBuilder.getGenMobCodeNum(String), GenericBuilder.setGenMobStat(MOB, String, String)
  - setGenMobStat
```
public void setGenMobStat(MOB M,
                          java.lang.String code,
                          java.lang.String val)
```
    Description copied from interface: GenericBuilder
    
    Sets the value of a basic genmob stat, even if the mob given is not generic. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenMOBBonusFakeStats stats.
    
    Specified by:
    
    setGenMobStat in interface GenericBuilder
    
    Parameters:
    
    M - the mob object to modify
    
    code - the stat code to modify
    
    val - the value to set the stat to
    
    See Also:
    
    GenericBuilder.getGenMobStat(MOB, String), GenericBuilder.getGenMobCodeNum(String)
  - copyArea
```
public Area copyArea(Area A,
                     java.lang.String newName,
                     boolean savable)
```
    Description copied from interface: GenericBuilder
    
    This makes either a full database, or simple memory copy of the given area with the given new name
    
    Specified by:
    
    copyArea in interface GenericBuilder
    
    Parameters:
    
    A - the area to copy, including rooms, items, etc..
    
    newName - the name of the area copy
    
    savable - true to save to db, false for ram
    
    Returns:
    
    the new area object
  - getFactionXML
```
public java.lang.String getFactionXML(MOB mob,
                                      java.util.List<Pair<java.lang.String,java.lang.Integer>> lst)
```
    Description copied from interface: GenericBuilder
    
    Converts all the faction values and associations on the given mob or list into a complete xml doc for storage in the db.
    
    Specified by:
    
    getFactionXML in interface GenericBuilder
    
    Parameters:
    
    mob - the mob to grab faction associations from
    
    lst - optional list to grab faction info from
    
    Returns:
    
    the xml doc of all factions on the mob or list
    
    See Also:
    
    GenericBuilder.unpackFactionFromXML(MOB, List)
  - getCodedSpellsOrBehaviors
```
public java.lang.String getCodedSpellsOrBehaviors(PhysicalAgent I)
```
    Description copied from interface: GenericBuilder
    
    Returns all of the given effect Abilities on the given Affectable as a semicolon delimited string of Ability IDs. If any of the abilities contain parameters, they come after the ability and another semicolon. This method can't really capture all permutations and combinations, but, well, it seemed like a good idea at the time.
    
    Specified by:
    
    getCodedSpellsOrBehaviors in interface GenericBuilder
    
    Parameters:
    
    I - the Affectable one to look at the effects of
    
    Returns:
    
    the coded string of those effects
    
    See Also:
    
    Affectable.effects(), GenericBuilder.getCodedSpellsOrBehaviors(String)
  - getCodedSpellsOrBehaviors
```
public java.util.List<CMObject> getCodedSpellsOrBehaviors(java.lang.String spellsOrBehavsList)
```
    Description copied from interface: GenericBuilder
    
    Parses the coded effects available from an ability parameter column and generates the Ability objects with any parameters of their own.
    
    Specified by:
    
    getCodedSpellsOrBehaviors in interface GenericBuilder
    
    Parameters:
    
    spellsOrBehavsList - the coded ability parameter affectable effects string
    
    Returns:
    
    the list of ability which are the effects
    
    See Also:
    
    Affectable.effects(), GenericBuilder.getCodedSpellsOrBehaviors(PhysicalAgent)
  - unpackFactionFromXML
```
public java.util.List<Pair<java.lang.String,java.lang.Integer>> unpackFactionFromXML(MOB mob,
                                                                                     java.util.List<XMLLibrary.XMLTag> xml)
```
    Description copied from interface: GenericBuilder
    
    Sets the faction values and associations on the given mob from a pre-parsed xml doc. The list of tags must include one called "FACTIONS".
    
    Specified by:
    
    unpackFactionFromXML in interface GenericBuilder
    
    Parameters:
    
    mob - the mob to set faction associations on
    
    xml - the list of pre-parsed xml tags
    
    Returns:
    
    TODO
    
    See Also:
    
    GenericBuilder.getFactionXML(MOB, List)

Class CoffeeMaker

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.GenericBuilder

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

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

Constructor Detail

CoffeeMaker

Method Detail

ID

getGenMOBTextUnpacked

resetGenMOB

getSpecialEnvFlags

setSpecialEnvFlags

getGenAbilityXML

unpackAbilitiesFromXml

getEnvironmentalMiscTextXML

doGenPropertiesCopy

getOrdEnvironmentalXML

getGenMobAbilitiesXML

getGenScriptsXML

possibleAddElectronicsManufacturers

possibleAddElectronicsManufacturers

getGenMobInventoryXML

getPlayerExtraInventory

setPlayerExtraInventory

getGenEnvironmentalXML

unpackErr

unpackErr

unpackErr

unpackExitFromXML

unpackRoomFromXML

unpackRoomFromXML

unpackRoomObjectFromXML

fillRoomContentFromXML

unpackRoomFromXML

fixFillingRoomUnlinkedExits

fillAreaAndCustomVectorFromXML

fillCustomVectorFromXML

fillCustomVectorFromXML

fillAreasVectorFromXML

addAutoPropsToAreaIfNecessary

unpackAreaFromXML

unpackAreaFromXML

unpackAreaObjectFromXML

getAreaXML

getAreaObjectXML

getAreaXML

logTextDiff

logDiff

makeNewRoomContent

getMobXML

getExitXML

getUniqueMobsXML

possiblyAddCustomRace

possiblyAddCustomClass

possiblyAddCustomEffect

possiblyAddCustomAbility

getRoomMobs

getUniqueItemXML

getItemXML

unpackItemFromXML

addItemsFromXML

addMOBsFromXML

addItemsFromXML

getUnknownTypeFromXML

getUnknownNameFromXML

unpackUnknownFromXML

getUnknownXML

unpackMobFromXML

addMOBsFromXML

getUniqueItemsXML