Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface GenericBuilder

All Superinterfaces:

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

All Known Implementing Classes:

CoffeeMaker

public interface GenericBuilder
extends CMLibrary

The Generic CMObject Building library is the heart and core of CoffeeMud 2.0, formerly called "Generic". The purpose is to provide abstract methods for handling the modifiable aspects of CMObjects, such as manipulating and reading fields, converting to and from XML, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GenericBuilder.GenItemBonusFakeStats	An enum for properties found on Item objects that are derivative, or otherwise not available in this form from the Modifiable interface.
static class	GenericBuilder.GenItemCode	Enum for the most basic fields common to all objects that implement the Item interface.
static class	GenericBuilder.GenMOBBonusFakeStats	An enum for properties found on MOB objects that are derivative, or otherwise not available in this form from the Modifiable interface.
static class	GenericBuilder.GenMOBCode	The basic enum of GenMOB Modifiable codes used by the Modifiable interface on all mob derivatives.
static class	GenericBuilder.GenPhysBonusFakeStats	An enum for properties found on many different Physical objects that are derivative, or otherwise not available from the Modifiable interface.

Field Summary

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

idConverter

Method Summary

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.
Area	copyArea(Area A, java.lang.String newName, boolean setSavable)	This makes either a full database, or simple memory copy of the given area with the given new name
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.
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.
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.
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 spells)	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.
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.
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.
int	getGenMobCodeNum(java.lang.String code)	Returns the ordinal of the given code in the basic genmob stat codes.
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.
java.lang.String	getPhyStatsStr(PhyStats E)	Given the PhyStats object, returns the encoded string representing the values in the object.
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.
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.
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	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.
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.
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.
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.
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.
void	setPhyStats(PhyStats E, java.lang.String props)	Sets the values in the given PhyStats object from the encoded string.
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.
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.
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.
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, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSpecialEnvFlags

int getSpecialEnvFlags(Environmental E)

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.

Parameters:

E - the object to get envflags for

Returns:

the value of the special flags

See Also:

setSpecialEnvFlags(Environmental, int)

setSpecialEnvFlags

void setSpecialEnvFlags(Environmental E,
                        int f)

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.

Parameters:

E - the object to set envflags for

f - the value of the special flags

See Also:

getSpecialEnvFlags(Environmental)

addAutoPropsToAreaIfNecessary

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.

Parameters:

newArea - the area to add things to, if necessary

makeNewRoomContent

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. You can optionally activate the room as a full map member.

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

getGenAbilityXML

java.lang.String getGenAbilityXML(Ability A)

Given an ability, including a generic one, this will construct an xml document representing the ability.

Parameters:

A - the ability to get xml for

Returns:

the xml

See Also:

unpackAbilitiesFromXml(String, List)

unpackAbilitiesFromXml

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.

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:

getGenAbilityXML(Ability)

unpackUnknownFromXML

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.

Parameters:

xml - the xml document

Returns:

the item, mob, room, or exit object

See Also:

getUnknownXML(Environmental)

getUnknownXML

java.lang.String getUnknownXML(Environmental obj)

Given an item, mob, room, or exit, this will return the full XML document for that object.

Parameters:

obj - the object to get xml for

Returns:

the xml

See Also:

unpackUnknownFromXML(String)

getUnknownTypeFromXML

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

Parameters:

xml - the xml document to get the type of

Returns:

the object type

See Also:

CMClass.CMObjectType, getUnknownNameFromXML(String)

getUnknownNameFromXML

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.

Parameters:

xml - the xml document to get a name from

Returns:

the name

See Also:

getUnknownTypeFromXML(String)

fillAreaAndCustomVectorFromXML

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. It will also parse out any custom objects and external files contained therein into the custom and externalFiles object given.

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:

fillAreasVectorFromXML(String, List, List, Map)

fillAreasVectorFromXML

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. It will also parse out any custom objects and external files contained therein into the custom and externalFiles object given.

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:

fillAreaAndCustomVectorFromXML(String, List, List, Map)

fillCustomVectorFromXML

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.

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

unpackEnvironmentalMiscTextXML

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. Send fromTop to handle ordinary properties for standard items.

Parameters:

E - the environmental object to populate

buf - the xml doc

fromTop - true to unpack xml for standard objects

See Also:

getEnvironmentalMiscTextXML(Environmental, boolean), unpackEnvironmentalMiscTextXML(Environmental, List, boolean)

unpackEnvironmentalMiscTextXML

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. Send fromTop to handle ordinary properties for standard items.

Parameters:

E - the environmental object to populate

V - the parsed xml doc

fromTop - true to unpack xml for standard objects

See Also:

getEnvironmentalMiscTextXML(Environmental, boolean), unpackEnvironmentalMiscTextXML(Environmental, String, boolean)

getEnvironmentalMiscTextXML

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. This will work for standard or generic objects, and you can specify with the fromTop variable whether you want full xml for standard objects.

Parameters:

E - the object to get xml for

fromTop - true to get all xml for a standard object

Returns:

the xml document

See Also:

unpackEnvironmentalMiscTextXML(Environmental, List, boolean), unpackEnvironmentalMiscTextXML(Environmental, String, boolean)

getRoomItems

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

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

addItemsFromXML

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. An optional session can handle any progress reporting. Returns an error, or "".

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:

getUniqueItemsXML(List, Map, Set, CMObjectType), getItemXML(Item), addItemsFromXML(List, List, Session), unpackItemFromXML(String)

addItemsFromXML

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. An optional session can handle any progress reporting. Returns an error, or "".

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:

getUniqueItemsXML(List, Map, Set, CMObjectType), getItemXML(Item), addItemsFromXML(String, List, Session), unpackItemFromXML(String)

unpackItemFromXML

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. Any generic races or scripts must already exist.

Parameters:

xmlBuffer - the xml document with the item tag

Returns:

the item object, or null

See Also:

getUniqueItemsXML(List, Map, Set, CMObjectType), getItemXML(Item), addItemsFromXML(String, List, Session), addItemsFromXML(List, List, Session)

getUniqueItemsXML

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. It will also populate sets with any script paths or generic races and classes found.

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:

getItemXML(Item), addItemsFromXML(String, List, Session), addItemsFromXML(List, List, Session), unpackItemFromXML(String)

getItemXML

java.lang.String getItemXML(Item item)

Returns an xml document representing the given item, wrapped in a neat ITEM tag. No custom objects or scripts are captured.

Parameters:

item - the item to get the xml of

Returns:

the full xml of the item

See Also:

addItemsFromXML(String, List, Session), addItemsFromXML(List, List, Session), getUniqueItemsXML(List, Map, Set, CMObjectType), unpackItemFromXML(String)

getGenMOBTextUnpacked

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.

Parameters:

mob - the mob whose misc text this is

newText - the misc text

Returns:

the final misc text

resetGenMOB

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. This is often called during generic mob rebirth.

Parameters:

mob - the mob to repopulate

newText - the misctext for the mob

addMOBsFromXML

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. An optional session can handle any progress reporting. Returns an error, or "".

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:

getMobXML(MOB), addMOBsFromXML(List, List, Session), getUniqueMobsXML(List, Set, Set, Map), unpackMobFromXML(String)

getRoomMobs

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

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

addMOBsFromXML

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. An optional session can handle any progress reporting. Returns an error, or "".

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:

getMobXML(MOB), addMOBsFromXML(String, List, Session), getUniqueMobsXML(List, Set, Set, Map), unpackMobFromXML(String)

getMobXML

java.lang.String getMobXML(MOB mob)

Returns an xml document representing the given mob, wrapped in a neat MOB tag. No custom objects or scripts are captured.

Parameters:

mob - the mob to get the xml of

Returns:

the full xml of the mob

See Also:

addMOBsFromXML(String, List, Session), addMOBsFromXML(List, List, Session), getUniqueMobsXML(List, Set, Set, Map), unpackMobFromXML(String)

getUniqueMobsXML

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. It will also populate sets with any script paths or generic races and classes found.

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:

getMobXML(MOB), unpackMobFromXML(String), addMOBsFromXML(List, List, Session), addMOBsFromXML(String, List, Session)

unpackMobFromXML

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. Any generic races or scripts must already exist.

Parameters:

xmlBuffer - the xml document with the mob tag

Returns:

the mob object, or null

See Also:

getUniqueMobsXML(List, Set, Set, Map), getMobXML(MOB), addMOBsFromXML(List, List, Session), addMOBsFromXML(String, List, Session)

unpackRoomFromXML

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.

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:

getRoomXML(Room, Set, Set, boolean)

unpackRoomFromXML

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.

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:

getRoomXML(Room, Set, Set, boolean)

getRoomXML

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. It will also split out any files, or local generic races and classes for optional inclusion.

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:

unpackRoomFromXML(String, boolean), unpackRoomFromXML(Area, List, boolean, boolean)

unpackAreaObjectFromXML

Area unpackAreaObjectFromXML(java.lang.String xml)
                      throws CMException

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.

Parameters:

xml - the xml document containing an AREA tag

Returns:

the populated area object

Throws:

CMException - any unpacking errors, bad xml, etc

See Also:

getAreaObjectXML(Area, Session, Set, Set, boolean), getAreaXML(Area, Session, Set, Set, boolean)

unpackAreaFromXML

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

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:

getAreaObjectXML(Area, Session, Set, Set, boolean), getAreaXML(Area, Session, Set, Set, boolean)

getAreaXML

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

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:

unpackAreaFromXML(List, Session, String, boolean, boolean), unpackAreaObjectFromXML(String)

getAreaObjectXML

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

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:

unpackAreaFromXML(List, Session, String, boolean, boolean), unpackAreaObjectFromXML(String)

makeAmmunition

Ammunition makeAmmunition(java.lang.String ammunitionType,
                          int number)

Create a standard GenAmmunition Item, representing a bundle of ammo, of the give type and number.

Parameters:

ammunitionType - the type of ammo "arrows" "bullets", etc.

number - the number of ammo in the bundle

Returns:

the new GenAmmunition object

populateShops

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.

Parameters:

shopKeep - the shopkeeper to populate

buf - the parsed xml doc with STORE, etc tags

getPlayerXML

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. Dependency custom objects and script file paths can optionally be captured during this process.

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:

addPlayersAndAccountsFromXML(String, List, List, Session)

getAccountXML

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. Dependency custom objects and script file paths can optionally be captured during this process.

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:

addPlayersAndAccountsFromXML(String, List, List, Session)

addPlayersAndAccountsFromXML

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

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:

getPlayerXML(MOB, Set, Set), getAccountXML(PlayerAccount, Set, Set)

fillFileSet

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.

Parameters:

E - the top level object to dig for script paths

H - the set of script paths found

See Also:

fillFileMap(Environmental, Map)

fillFileMap

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. Does so recursively, going into mob and store inventory and so forth.

Parameters:

E - the top level object to go digging for script paths

H - the map to fill.

See Also:

fillFileSet(Environmental, Set)

getPhyStatsStr

java.lang.String getPhyStatsStr(PhyStats E)

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.

Parameters:

E - the PhyStats Object

Returns:

the encoded values object

See Also:

setPhyStats(PhyStats, String)

getCharStateStr

java.lang.String getCharStateStr(CharState E)

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.

Parameters:

E - the CharState Object

Returns:

the encoded values object

See Also:

setCharState(CharState, String)

getCharStatsStr

java.lang.String getCharStatsStr(CharStats E)

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.

Parameters:

E - the CharStats Object

Returns:

the encoded values object

See Also:

setCharStats(CharStats, String)

getExtraEnvironmentalXML

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.

Parameters:

E - the object to give settings to

Returns:

the xml tags containing settings

See Also:

unpackExtraEnvironmentalXML(Environmental, List), getGenScriptsXML(PhysicalAgent, boolean)

getGenScriptsXML

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. If includeVars is set to true, it will also bundle all currently set script variables.

Parameters:

E - the object that might be scripted

includeVars - true to return any vars also

Returns:

the xml document, or ""

See Also:

unpackGenScriptsXML(PhysicalAgent, List, boolean)

setCharStats

void setCharStats(CharStats E,
                  java.lang.String props)

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

Parameters:

E - the CharStats object to alter

props - the encoded values

See Also:

getCharStatsStr(CharStats)

setCharState

void setCharState(CharState E,
                  java.lang.String props)

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

Parameters:

E - the CharState object to alter

props - the encoded values

See Also:

getCharStateStr(CharState)

setPhyStats

void setPhyStats(PhyStats E,
                 java.lang.String props)

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

Parameters:

E - the PhyStats object to alter

props - the encoded values

See Also:

getPhyStatsStr(PhyStats)

getQuickName

java.lang.String getQuickName(java.lang.String classID,
                              java.lang.String miscText)

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.

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

unpackExtraEnvironmentalXML

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

Parameters:

E - the object to give settings to

buf - the xml tags containing settings

See Also:

getExtraEnvironmentalXML(Environmental)

unpackGenScriptsXML

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. If restoreVars is true, then any variable values stored in the XML document are also restored.

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:

getGenScriptsXML(PhysicalAgent, boolean)

setAnyGenStat

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

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:

setAnyGenStat(Physical, String, String), getAnyGenStat(Physical, String), isAnyGenStat(Physical, String)

setAnyGenStat

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. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.

Parameters:

P - the type of object to change

stat - the stat code to change

value - the new value for the stat

See Also:

setAnyGenStat(Physical, String, String, boolean), getAnyGenStat(Physical, String), isAnyGenStat(Physical, String)

getAnyGenStat

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. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.

Parameters:

P - the type of object to read

stat - the stat code to read

Returns:

the value of the stat, or ""

See Also:

setAnyGenStat(Physical, String, String), setAnyGenStat(Physical, String, String, boolean), isAnyGenStat(Physical, String)

isAnyGenStat

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. This includes not only the Generic codes, but also any fakeitem or fakemob stat codes as well. All Physical type objects are supported.

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:

setAnyGenStat(Physical, String, String), setAnyGenStat(Physical, String, String, boolean), getAnyGenStat(Physical, String)

getAllGenStats

java.util.List<java.lang.String> getAllGenStats(Physical P)

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.

Parameters:

P - the object to get stat codes for

Returns:

the list of stat codes.

getFinalStatName

java.lang.String getFinalStatName(java.lang.String stat)

Removes any qualifying prefixes from stat names, to reveal the underlying stat code. Prefixes include things like CURRENT_, CURRENT ,BASE_, BASE ,MAX_, and MAX

Parameters:

stat - the possibly qualified stat code

Returns:

the underlying state code

getGenItemCodeNum

int getGenItemCodeNum(java.lang.String code)

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.

Parameters:

code - the stat code

Returns:

the ordinal of the stat

See Also:

getGenItemStat(Item, String), setGenItemStat(Item, String, String)

getGenItemStat

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. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenItemBonusFakeStats stats.

Parameters:

I - the item object to read

code - the stat code to return the value of

Returns:

the value of the stat

See Also:

getGenItemCodeNum(String), setGenItemStat(Item, String, String)

setGenItemStat

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. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenItemBonusFakeStats stats.

Parameters:

I - the item object to modify

code - the stat code to modify

val - the value to set the stat to

See Also:

getGenItemStat(Item, String), getGenItemCodeNum(String)

getGenMobCodeNum

int getGenMobCodeNum(java.lang.String code)

Returns the ordinal of the given code in the basic genmob stat codes.

Parameters:

code - the stat code

Returns:

the ordinal of the stat

See Also:

getGenMobStat(MOB, String), setGenMobStat(MOB, String, String)

getGenMobStat

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. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenMOBBonusFakeStats stats.

Parameters:

M - the mob object to read

code - the stat code to return the value of

Returns:

the value of the stat

See Also:

getGenMobCodeNum(String), setGenMobStat(MOB, String, String)

setGenMobStat

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. Therefore, it does not rely on the Modifiable interface. It also does not support any of the fake GenMOBBonusFakeStats stats.

Parameters:

M - the mob object to modify

code - the stat code to modify

val - the value to set the stat to

See Also:

getGenMobStat(MOB, String), getGenMobCodeNum(String)

copyArea

Area copyArea(Area A,
              java.lang.String newName,
              boolean setSavable)

This makes either a full database, or simple memory copy of the given area with the given new name

Parameters:

A - the area to copy, including rooms, items, etc..

newName - the name of the area copy

setSavable - true to save to db, false for ram

Returns:

the new area object

getFactionXML

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.

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:

unpackFactionFromXML(MOB, List)

unpackFactionFromXML

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. The list of tags must include one called "FACTIONS".

Parameters:

mob - the mob to set faction associations on

xml - the list of pre-parsed xml tags

Returns:

TODO

See Also:

getFactionXML(MOB, List)

getCodedSpellsOrBehaviors

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

Parameters:

I - the Affectable one to look at the effects of

Returns:

the coded string of those effects

See Also:

Affectable.effects(), getCodedSpellsOrBehaviors(String)

getCodedSpellsOrBehaviors

java.util.List<CMObject> getCodedSpellsOrBehaviors(java.lang.String spells)

Parses the coded effects available from an ability parameter column and generates the Ability objects with any parameters of their own.

Parameters:

spells - the coded ability parameter affectable effects string

Returns:

the list of ability which are the effects

See Also:

Affectable.effects(), getCodedSpellsOrBehaviors(PhysicalAgent)