com.planet_ink.coffee_mud.core
Class CMLib

java.lang.Object
  extended by com.planet_ink.coffee_mud.core.CMLib

public class CMLib
extends java.lang.Object

CMLib is a semi-singleton central repository for all the various code libraries implemented in CoffeeMud. Generally it provides accessor methods for all the java classes in com.planet_ink.coffee_mud.Libraries. Like many other CoffeeMud classes, it also supports the thread-group-code-character accessor method, so that it can provide unique instances of some of the libraries based on the first character of the name of the current thread group. For completeness, you'll also find accessors for other core singletons. Lastly, CMLib is a container class for all MudHost objects running in this process.

See Also:
MudHost

Nested Class Summary
static class CMLib.Library
          Collection of all the different official CoffeeMud libraries
 
Constructor Summary
CMLib()
          Constructs a new CMLib object for the current thread group.
 
Method Summary
 AbilityComponents _ableComponents()
          Returns a reference to this instances abilities components management library.
 AbilityMapper _ableMapper()
          Returns a reference to this instances abilities collection/management library.
 AbilityParameters _ableParms()
          Returns a reference to this instances recipe maker and skill parameter library.
 AchievementLibrary _achievements()
          Returns a reference to this instances achievement system library.
 MoneyLibrary _beanCounter()
          Returns a reference to this instances money handling library.
 CatalogLibrary _catalog()
          Returns a reference to this instances cataloged mob/item collection/management library.
 ChannelsLibrary _channels()
          Returns a reference to this instances chat channel library.
 ClanManager _clans()
          Returns a reference to this instances clan collection/management library.
 TelnetFilter _coffeeFilter()
          Returns a reference to this instances telnet input/output filtering library.
 GenericBuilder _coffeeMaker()
          Returns a reference to this instances GenObject low level construction library.
 ShoppingLibrary _coffeeShops()
          Returns a reference to this instances store front/shopping library.
 StatisticsLibrary _coffeeTables()
          Returns a reference to this instances statistics library.
 ColorLibrary _color()
          Returns a reference to this instances ansi color library.
 CombatLibrary _combat()
          Returns a reference to this instances combat library.
 CommonCommands _commands()
          Returns a reference to this instances command shortcut and common event handler library.
 DatabaseEngine _database()
          Returns a reference to this instances database engine library.
 DiceLibrary _dice()
          Returns a reference to this instances random dice roll library.
 TextEncoders _encoder()
          Returns a reference to this instances string hashing and compression library.
 EnglishParsing _english()
          Returns a reference to this instances english grammar and input utility library.
 ExpertiseLibrary _expertises()
          Returns a reference to this instances expertise collection/management library.
 FactionManager _factions()
          Returns a reference to this instances faction collection/management library.
 CMFlagLibrary _flags()
          Returns a reference to this instances flag checking shortcut library.
 GenericEditor _genEd()
          Returns a reference to this instances generic object builder/editor and prompting library.
 HelpLibrary _help()
          Returns a reference to this instances help file library.
 I3Interface _intermud()
          Returns a reference to this instances Intermud3 access library.
 ItemBalanceLibrary _itemBuilder()
          Returns a reference to this instances item balancing library.
 JournalsLibrary _journals()
          Returns a reference to this instances message board and journal library.
 LanguageLibrary _lang()
          Returns a reference to this instances localization library.
 LegalLibrary _law()
          Returns a reference to this instances legal and property library.
 ExpLevelLibrary _leveler()
          Returns a reference to this instances leveling and experience gaining library.
 ListingLibrary _lister()
          Returns a reference to this instances string/item/object listing library.
 CharCreationLibrary _login()
          Returns a reference to this instances login and char creation library.
 WorldMap _map()
          Returns a reference to this instances areas and rooms access/management library.
 MaskingLibrary _masking()
          Returns a reference to this instances object masking/filtering library.
 MaterialLibrary _materials()
          Returns a reference to this instances raw resource/material item library.
 AreaGenerationLibrary _percolator()
          Returns a reference to this instances random map/object generation library.
 PlayerLibrary _players()
          Returns a reference to this instances player and account collection/management library.
 PollManager _polls()
          Returns a reference to this instances player poll collection/management library.
 ProtocolLibrary _protocol()
          Returns a reference to this instances mud protocol mxp/msdp/etc library.
 QuestManager _quests()
          Returns a reference to this instances quest collection/management library.
 SessionsList _sessions()
          Returns a reference to this instances telnet session management library.
 SlaveryLibrary _slavery()
          Returns a reference to this instances slavery and geas library.
 SMTPLibrary _smtp()
          Returns a reference to this instances email sending library.
 SocialsList _socials()
          Returns a reference to this instances social command collection/management library.
 TechLibrary _tech()
          Returns a reference to this instances tech and electricity library.
 ThreadEngine _threads()
          Returns a reference to this instances Thread access library.
 TimeManager _time()
          Returns a reference to this instances real time utility library.
 AutoTitlesLibrary _titles()
          Returns a reference to this instances player titles collection/management library.
 TrackingLibrary _tracking()
          Returns a reference to this instances mob tracking/movement library.
 CMMiscUtils _utensils()
          Returns a reference to this instances random world utilities library.
 WebMacroLibrary _webMacroFilter()
          Returns a reference to this instances web macro filtering library.
 XMLLibrary _xml()
          Returns a reference to this instances xml parsing library.
static AbilityComponents ableComponents()
          Returns a reference to this threads abilities components management library.
static AbilityMapper ableMapper()
          Returns a reference to this threads abilities collection/management library.
static AbilityParameters ableParms()
          Returns a reference to this threads recipe maker and skill parameter library.
static AchievementLibrary achievements()
          Returns a reference to this threads achievement system library.
static void activateLibraries()
          Signify to the library library (this) that all of the library classes have been registered, and that any missing libraries are to share code with the thread 0 (base) set.
static MoneyLibrary beanCounter()
          Returns a reference to this threads money handling library.
static CatalogLibrary catalog()
          Returns a reference to this threads cataloged mob/item collection/management library.
static ChannelsLibrary channels()
          Returns a reference to this threads chat channel library.
static ClanManager clans()
          Returns a reference to this threads clan collection/management library.
static CMClass classes()
          Returns reference to the class loader.
static TelnetFilter coffeeFilter()
          Returns a reference to this threads telnet input/output filtering library.
static GenericBuilder coffeeMaker()
          Returns a reference to this threads GenObject low level construction library.
static ShoppingLibrary coffeeShops()
          Returns a reference to this threads store front/shopping library.
static StatisticsLibrary coffeeTables()
          Returns a reference to this threads statistics library.
static ColorLibrary color()
          Returns a reference to this threads ansi color library.
static CombatLibrary combat()
          Returns a reference to this threads combat library.
static CommonCommands commands()
          Returns a reference to this threads command shortcut and common event handler library.
static CMLib.Library convertToLibraryCode(java.lang.Object O)
          Return the Library Enum entry that represents the ancestor of the given library object.
static int countRegistered()
          Returns how many CMLibrary objects have been registered for this thread group.
static DatabaseEngine database()
          Returns a reference to this threads database engine library.
static DiceLibrary dice()
          Returns a reference to this threads random dice roll library.
static Directions directions()
          Returns reference to the directions class.
static TextEncoders encoder()
          Returns a reference to this threads string hashing and compression library.
static EnglishParsing english()
          Returns a reference to this threads english grammar and input utility library.
static ExpertiseLibrary expertises()
          Returns a reference to this threads expertise collection/management library.
static FactionManager factions()
          Returns a reference to this threads faction collection/management library.
static CMFlagLibrary flags()
          Returns a reference to this threads flag checking shortcut library.
static GenericEditor genEd()
          Returns a reference to this threads generic object builder/editor and prompting library.
static CMLib get(int id)
          Returns the CMLib instance associated with the given thread id, or the current thread.
static CMLib get(Session session)
          Returns the CMLib instance associated either with the given session, or the current thread.
static char getLibraryThreadID(CMLib.Library code, CMLibrary lib)
          Return the private thread id that belongs to the given library
static HelpLibrary help()
          Returns a reference to this threads help file library.
static MudHost host()
          Returns the MudHost associated with the callers thread group.
static java.util.List<MudHost> hosts()
          Returns a list of all the registered mud hosts running.
static CMLib initialize()
          Returns a CMLib object for the current thread group.
static I3Interface intermud()
          Returns a reference to this threads Intermud3 access library.
static ItemBalanceLibrary itemBuilder()
          Returns a reference to this threads item balancing library.
static JournalsLibrary journals()
          Returns a reference to this threads message board and journal library.
static void killThread(java.lang.Thread t, long sleepTime, int attempts)
          Do your best to shut down the given thread, trying for at most sleepTime ms, and making as many number attempts as given.
static LanguageLibrary lang()
          Returns a reference to this threads localization library.
static LegalLibrary law()
          Returns a reference to this threads legal and property library.
static ExpLevelLibrary leveler()
          Returns a reference to this threads leveling and experience gaining library.
static java.util.Enumeration<CMLibrary> libraries()
          Returns an enumeration of basic code libraries registered with the system thus far.
static java.util.Enumeration<CMLibrary> libraries(CMLib.Library code)
          Returns an enumeration of all library objects of the Library Enum type given across all thread groups.
static CMLibrary library(char tcode, CMLib.Library lcode)
          Return the library belonging to the given thread group code, and the given Library Enum
static ListingLibrary lister()
          Returns a reference to this threads string/item/object listing library.
static Log log()
          Returns reference to the logger.
static CharCreationLibrary login()
          Returns a reference to this threads login and char creation library.
static WorldMap map()
          Returns a reference to this threads areas and rooms access/management library.
static MaskingLibrary masking()
          Returns a reference to this threads object masking/filtering library.
static MaterialLibrary materials()
          Returns a reference to this threads raw resource/material item library.
static CMath math()
          Returns reference to the math utility class.
static MudHost mud(int port)
          Returns the mud running on the given port, or null if none is found.
static CMParms parms()
          Returns reference to the string parameter utility class.
static AreaGenerationLibrary percolator()
          Returns a reference to this threads random map/object generation library.
static PlayerLibrary players()
          Returns a reference to this threads player and account collection/management library.
static PollManager polls()
          Returns a reference to this threads player poll collection/management library.
static void propertiesLoaded()
          Signify to the library library (this), that the ini file has been loaded, and that all registered libraries need to be likewise notified.
static CMProps props()
          Returns reference to the properties ini file class.
static ProtocolLibrary protocol()
          Returns a reference to this threads mud protocol mxp/msdp/etc library.
static QuestManager quests()
          Returns a reference to this threads quest collection/management library.
static void registerLibraries(java.util.Enumeration<CMLibrary> e)
          Calls registerLibrary on all the given CMLibrary objects
static void registerLibrary(CMLibrary O)
          Register the given library object as belonging to the thread group that called this method.
static Resources resources()
          Returns reference to the resources storage class.
static boolean s_sleep(long millis)
          Sleep for the given ms without throwing an exception
static CMSecurity security()
          Returns reference to the security class.
static SessionsList sessions()
          Returns a reference to this threads telnet session management library.
static SlaveryLibrary slavery()
          Returns a reference to this threads slavery and geas library.
static SMTPLibrary smtp()
          Returns a reference to this threads email sending library.
static SocialsList socials()
          Returns a reference to this threads social command collection/management library.
static CMStrings strings()
          Returns reference to the string utility class.
static TechLibrary tech()
          Returns a reference to this threads tech and electricity library.
static ThreadEngine threads()
          Returns a reference to this threads Thread access library.
static TimeManager time()
          Returns a reference to this threads real time utility library.
static AutoTitlesLibrary titles()
          Returns a reference to this threads player titles collection/management library.
static TrackingLibrary tracking()
          Returns a reference to this threads mob tracking/movement library.
static java.lang.String unregistered()
          Returns a comma-delimited list of the ordinal numbers of those libraries which have not been registered for this thread group.
static CMMiscUtils utensils()
          Returns a reference to this threads random world utilities library.
static WebMacroLibrary webMacroFilter()
          Returns a reference to this threads web macro filtering library.
static XMLLibrary xml()
          Returns a reference to this threads xml parsing library.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMLib

public CMLib()
Constructs a new CMLib object for the current thread group.

Method Detail

initialize

public static final CMLib initialize()
Returns a CMLib object for the current thread group. If one is not assigned, it will be instantiated, thus guaranteeing that a CMLib object always returns from this method.

Returns:
a CMLib object

math

public static final CMath math()
Returns reference to the math utility class.

Returns:
reference to the math utility class.
See Also:
CMath

parms

public static final CMParms parms()
Returns reference to the string parameter utility class.

Returns:
reference to the string parameter utility class.
See Also:
CMParms

strings

public static final CMStrings strings()
Returns reference to the string utility class.

Returns:
reference to the string utility class.
See Also:
CMStrings

classes

public static final CMClass classes()
Returns reference to the class loader.

Returns:
reference to the class loader.
See Also:
CMClass

security

public static final CMSecurity security()
Returns reference to the security class.

Returns:
reference to the security class.
See Also:
CMSecurity

directions

public static final Directions directions()
Returns reference to the directions class.

Returns:
reference to the directions class.
See Also:
Directions

log

public static final Log log()
Returns reference to the logger.

Returns:
reference to the logger.
See Also:
Log

resources

public static final Resources resources()
Returns reference to the resources storage class.

Returns:
reference to the resources storage class.
See Also:
Resources

props

public static final CMProps props()
Returns reference to the properties ini file class.

Returns:
reference to the properties ini file class.
See Also:
CMProps

hosts

public static final java.util.List<MudHost> hosts()
Returns a list of all the registered mud hosts running.

Returns:
list of the registered mud hosts running.
See Also:
MUD

host

public static final MudHost host()
Returns the MudHost associated with the callers thread group.

Returns:
the appropriate mud host.

mud

public static final MudHost mud(int port)
Returns the mud running on the given port, or null if none is found.

Parameters:
port - port to search for
Returns:
the mudhost running on that port
See Also:
MudHost

libraries

public static final java.util.Enumeration<CMLibrary> libraries()
Returns an enumeration of basic code libraries registered with the system thus far.

Returns:
an enumeration of basic code libraries registered
See Also:
CMLibrary

get

public static final CMLib get(Session session)
Returns the CMLib instance associated either with the given session, or the current thread.

Parameters:
session - the session
Returns:
the cmlib

get

public static final CMLib get(int id)
Returns the CMLib instance associated with the given thread id, or the current thread.

Parameters:
id - the id
Returns:
the cmlib

database

public static final DatabaseEngine database()
Returns a reference to this threads database engine library.

Returns:
a reference to this threads database engine library.
See Also:
DatabaseEngine

threads

public static final ThreadEngine threads()
Returns a reference to this threads Thread access library.

Returns:
a reference to this threads Thread access library.
See Also:
ThreadEngine

intermud

public static final I3Interface intermud()
Returns a reference to this threads Intermud3 access library.

Returns:
a reference to this threads Intermud3 access library.
See Also:
I3Interface

itemBuilder

public static final ItemBalanceLibrary itemBuilder()
Returns a reference to this threads item balancing library.

Returns:
a reference to this threads item balancing library.
See Also:
ItemBalanceLibrary

webMacroFilter

public static final WebMacroLibrary webMacroFilter()
Returns a reference to this threads web macro filtering library.

Returns:
a reference to this threads web macro filtering library.
See Also:
WebMacroLibrary

lister

public static final ListingLibrary lister()
Returns a reference to this threads string/item/object listing library.

Returns:
a reference to this threads string/item/object listing library.
See Also:
ListingLibrary

beanCounter

public static final MoneyLibrary beanCounter()
Returns a reference to this threads money handling library.

Returns:
a reference to this threads money handling library.
See Also:
MoneyLibrary

coffeeShops

public static final ShoppingLibrary coffeeShops()
Returns a reference to this threads store front/shopping library.

Returns:
a reference to this threads store front/shopping library.
See Also:
ShoppingLibrary

materials

public static final MaterialLibrary materials()
Returns a reference to this threads raw resource/material item library.

Returns:
a reference to this threads raw resource/material item library.
See Also:
MaterialLibrary

combat

public static final CombatLibrary combat()
Returns a reference to this threads combat library.

Returns:
a reference to this threads combat library.
See Also:
CombatLibrary

help

public static final HelpLibrary help()
Returns a reference to this threads help file library.

Returns:
a reference to this threads help file library.
See Also:
HelpLibrary

tracking

public static final TrackingLibrary tracking()
Returns a reference to this threads mob tracking/movement library.

Returns:
a reference to this threads mob tracking/movement library.
See Also:
TrackingLibrary

law

public static final LegalLibrary law()
Returns a reference to this threads legal and property library.

Returns:
a reference to this threads legal and property library.
See Also:
LegalLibrary

masking

public static final MaskingLibrary masking()
Returns a reference to this threads object masking/filtering library.

Returns:
a reference to this threads object masking/filtering library.
See Also:
MaskingLibrary

channels

public static final ChannelsLibrary channels()
Returns a reference to this threads chat channel library.

Returns:
a reference to this threads chat channel library.
See Also:
ChannelsLibrary

commands

public static final CommonCommands commands()
Returns a reference to this threads command shortcut and common event handler library.

Returns:
a reference to this threads command shortcut and common event handler library.
See Also:
CommonCommands

achievements

public static final AchievementLibrary achievements()
Returns a reference to this threads achievement system library.

Returns:
a reference to this threads achievement library.
See Also:
AchievementLibrary

english

public static final EnglishParsing english()
Returns a reference to this threads english grammar and input utility library.

Returns:
a reference to this threads english grammar and input utility library.
See Also:
EnglishParsing

slavery

public static final SlaveryLibrary slavery()
Returns a reference to this threads slavery and geas library.

Returns:
a reference to this threads slavery and geas library.
See Also:
SlaveryLibrary

journals

public static final JournalsLibrary journals()
Returns a reference to this threads message board and journal library.

Returns:
a reference to this threads message board and journal library.
See Also:
JournalsLibrary

coffeeFilter

public static final TelnetFilter coffeeFilter()
Returns a reference to this threads telnet input/output filtering library.

Returns:
a reference to this threads telnet input/output filtering library.
See Also:
TelnetFilter

coffeeMaker

public static final GenericBuilder coffeeMaker()
Returns a reference to this threads GenObject low level construction library.

Returns:
a reference to this threads GenObject low level construction library.
See Also:
GenericBuilder

sessions

public static final SessionsList sessions()
Returns a reference to this threads telnet session management library.

Returns:
a reference to this threads telnet session management library.
See Also:
SessionsList

flags

public static final CMFlagLibrary flags()
Returns a reference to this threads flag checking shortcut library.

Returns:
a reference to this threads flag checking shortcut library.
See Also:
CMFlagLibrary

xml

public static final XMLLibrary xml()
Returns a reference to this threads xml parsing library.

Returns:
a reference to this threads xml parsing library.
See Also:
XMLLibrary

socials

public static final SocialsList socials()
Returns a reference to this threads social command collection/management library.

Returns:
a reference to this threads social command collection/management library.
See Also:
SocialsList

utensils

public static final CMMiscUtils utensils()
Returns a reference to this threads random world utilities library.

Returns:
a reference to this threads random world utilities library.
See Also:
CMMiscUtils

coffeeTables

public static final StatisticsLibrary coffeeTables()
Returns a reference to this threads statistics library.

Returns:
a reference to this threads statistics library.
See Also:
StatisticsLibrary

leveler

public static final ExpLevelLibrary leveler()
Returns a reference to this threads leveling and experience gaining library.

Returns:
a reference to this threads leveling and experience gaining library.
See Also:
ExpLevelLibrary

map

public static final WorldMap map()
Returns a reference to this threads areas and rooms access/management library.

Returns:
a reference to this threads areas and rooms access/management library.
See Also:
WorldMap

quests

public static final QuestManager quests()
Returns a reference to this threads quest collection/management library.

Returns:
a reference to this threads quest collection/management library.
See Also:
QuestManager

percolator

public static final AreaGenerationLibrary percolator()
Returns a reference to this threads random map/object generation library.

Returns:
a reference to this threads random map/object generation library.
See Also:
AreaGenerationLibrary

ableMapper

public static final AbilityMapper ableMapper()
Returns a reference to this threads abilities collection/management library.

Returns:
a reference to this threads abilities collection/management library.
See Also:
AbilityMapper

ableComponents

public static final AbilityComponents ableComponents()
Returns a reference to this threads abilities components management library.

Returns:
a reference to this threads abilities components management library.
See Also:
AbilityComponents

encoder

public static final TextEncoders encoder()
Returns a reference to this threads string hashing and compression library.

Returns:
a reference to this threads string hashing and compression library.
See Also:
TextEncoders

smtp

public static final SMTPLibrary smtp()
Returns a reference to this threads email sending library.

Returns:
a reference to this threads email sending library.
See Also:
SMTPLibrary

lang

public static final LanguageLibrary lang()
Returns a reference to this threads localization library.

Returns:
a reference to this threads localization library.
See Also:
LanguageLibrary

dice

public static final DiceLibrary dice()
Returns a reference to this threads random dice roll library.

Returns:
a reference to this threads random dice roll library.
See Also:
DiceLibrary

factions

public static final FactionManager factions()
Returns a reference to this threads faction collection/management library.

Returns:
a reference to this threads faction collection/management library.
See Also:
FactionManager

clans

public static final ClanManager clans()
Returns a reference to this threads clan collection/management library.

Returns:
a reference to this threads clan collection/management library.
See Also:
ClanManager

polls

public static final PollManager polls()
Returns a reference to this threads player poll collection/management library.

Returns:
a reference to this threads player poll collection/management library.
See Also:
PollManager

time

public static final TimeManager time()
Returns a reference to this threads real time utility library.

Returns:
a reference to this threads real time utility library.
See Also:
TimeManager

color

public static final ColorLibrary color()
Returns a reference to this threads ansi color library.

Returns:
a reference to this threads ansi color library.
See Also:
ColorLibrary

login

public static final CharCreationLibrary login()
Returns a reference to this threads login and char creation library.

Returns:
a reference to this threads login and char creation library.
See Also:
CharCreationLibrary

expertises

public static final ExpertiseLibrary expertises()
Returns a reference to this threads expertise collection/management library.

Returns:
a reference to this threads expertise collection/management library.
See Also:
ExpertiseLibrary

players

public static final PlayerLibrary players()
Returns a reference to this threads player and account collection/management library.

Returns:
a reference to this threads player and account collection/management library.
See Also:
PlayerLibrary

catalog

public static final CatalogLibrary catalog()
Returns a reference to this threads cataloged mob/item collection/management library.

Returns:
a reference to this threads cataloged mob/item collection/management library.
See Also:
CatalogLibrary

titles

public static final AutoTitlesLibrary titles()
Returns a reference to this threads player titles collection/management library.

Returns:
a reference to this threads player titles collection/management library.
See Also:
AutoTitlesLibrary

ableParms

public static final AbilityParameters ableParms()
Returns a reference to this threads recipe maker and skill parameter library.

Returns:
a reference to this threads recipe maker and skill parameter library.
See Also:
AbilityParameters

genEd

public static final GenericEditor genEd()
Returns a reference to this threads generic object builder/editor and prompting library.

Returns:
a reference to this threads generic object builder/editor and prompting library.
See Also:
GenericEditor

tech

public static final TechLibrary tech()
Returns a reference to this threads tech and electricity library.

Returns:
a reference to this threads tech and electricity library.
See Also:
TechLibrary

protocol

public static final ProtocolLibrary protocol()
Returns a reference to this threads mud protocol mxp/msdp/etc library.

Returns:
a reference to this threads mud protocol mxp/msdp/etc library.
See Also:
ProtocolLibrary

_database

public final DatabaseEngine _database()
Returns a reference to this instances database engine library.

Returns:
a reference to this instances database engine library.
See Also:
DatabaseEngine

_threads

public final ThreadEngine _threads()
Returns a reference to this instances Thread access library.

Returns:
a reference to this instances Thread access library.
See Also:
ThreadEngine

_intermud

public final I3Interface _intermud()
Returns a reference to this instances Intermud3 access library.

Returns:
a reference to this instances Intermud3 access library.
See Also:
I3Interface

_itemBuilder

public final ItemBalanceLibrary _itemBuilder()
Returns a reference to this instances item balancing library.

Returns:
a reference to this instances item balancing library.
See Also:
ItemBalanceLibrary

_webMacroFilter

public final WebMacroLibrary _webMacroFilter()
Returns a reference to this instances web macro filtering library.

Returns:
a reference to this instances web macro filtering library.
See Also:
WebMacroLibrary

_lister

public final ListingLibrary _lister()
Returns a reference to this instances string/item/object listing library.

Returns:
a reference to this instances string/item/object listing library.
See Also:
ListingLibrary

_beanCounter

public final MoneyLibrary _beanCounter()
Returns a reference to this instances money handling library.

Returns:
a reference to this instances money handling library.
See Also:
MoneyLibrary

_coffeeShops

public final ShoppingLibrary _coffeeShops()
Returns a reference to this instances store front/shopping library.

Returns:
a reference to this instances store front/shopping library.
See Also:
ShoppingLibrary

_materials

public final MaterialLibrary _materials()
Returns a reference to this instances raw resource/material item library.

Returns:
a reference to this instances raw resource/material item library.
See Also:
MaterialLibrary

_combat

public final CombatLibrary _combat()
Returns a reference to this instances combat library.

Returns:
a reference to this instances combat library.
See Also:
CombatLibrary

_help

public final HelpLibrary _help()
Returns a reference to this instances help file library.

Returns:
a reference to this instances help file library.
See Also:
HelpLibrary

_tracking

public final TrackingLibrary _tracking()
Returns a reference to this instances mob tracking/movement library.

Returns:
a reference to this instances mob tracking/movement library.
See Also:
TrackingLibrary

_law

public final LegalLibrary _law()
Returns a reference to this instances legal and property library.

Returns:
a reference to this instances legal and property library.
See Also:
LegalLibrary

_masking

public final MaskingLibrary _masking()
Returns a reference to this instances object masking/filtering library.

Returns:
a reference to this instances object masking/filtering library.
See Also:
MaskingLibrary

_channels

public final ChannelsLibrary _channels()
Returns a reference to this instances chat channel library.

Returns:
a reference to this instances chat channel library.
See Also:
ChannelsLibrary

_commands

public final CommonCommands _commands()
Returns a reference to this instances command shortcut and common event handler library.

Returns:
a reference to this instances command shortcut and common event handler library.
See Also:
CommonCommands

_achievements

public final AchievementLibrary _achievements()
Returns a reference to this instances achievement system library.

Returns:
a reference to this instances achievement library.
See Also:
AchievementLibrary

_english

public final EnglishParsing _english()
Returns a reference to this instances english grammar and input utility library.

Returns:
a reference to this instances english grammar and input utility library.
See Also:
EnglishParsing

_slavery

public final SlaveryLibrary _slavery()
Returns a reference to this instances slavery and geas library.

Returns:
a reference to this instances slavery and geas library.
See Also:
SlaveryLibrary

_journals

public final JournalsLibrary _journals()
Returns a reference to this instances message board and journal library.

Returns:
a reference to this instances message board and journal library.
See Also:
JournalsLibrary

_coffeeFilter

public final TelnetFilter _coffeeFilter()
Returns a reference to this instances telnet input/output filtering library.

Returns:
a reference to this instances telnet input/output filtering library.
See Also:
TelnetFilter

_coffeeMaker

public final GenericBuilder _coffeeMaker()
Returns a reference to this instances GenObject low level construction library.

Returns:
a reference to this instances GenObject low level construction library.
See Also:
GenericBuilder

_sessions

public final SessionsList _sessions()
Returns a reference to this instances telnet session management library.

Returns:
a reference to this instances telnet session management library.
See Also:
SessionsList

_flags

public final CMFlagLibrary _flags()
Returns a reference to this instances flag checking shortcut library.

Returns:
a reference to this instances flag checking shortcut library.
See Also:
CMFlagLibrary

_xml

public final XMLLibrary _xml()
Returns a reference to this instances xml parsing library.

Returns:
a reference to this instances xml parsing library.
See Also:
XMLLibrary

_socials

public final SocialsList _socials()
Returns a reference to this instances social command collection/management library.

Returns:
a reference to this instances social command collection/management library.
See Also:
SocialsList

_utensils

public final CMMiscUtils _utensils()
Returns a reference to this instances random world utilities library.

Returns:
a reference to this instances random world utilities library.
See Also:
CMMiscUtils

_coffeeTables

public final StatisticsLibrary _coffeeTables()
Returns a reference to this instances statistics library.

Returns:
a reference to this instances statistics library.
See Also:
StatisticsLibrary

_leveler

public final ExpLevelLibrary _leveler()
Returns a reference to this instances leveling and experience gaining library.

Returns:
a reference to this instances leveling and experience gaining library.
See Also:
ExpLevelLibrary

_map

public final WorldMap _map()
Returns a reference to this instances areas and rooms access/management library.

Returns:
a reference to this instances areas and rooms access/management library.
See Also:
WorldMap

_quests

public final QuestManager _quests()
Returns a reference to this instances quest collection/management library.

Returns:
a reference to this instances quest collection/management library.
See Also:
QuestManager

_percolator

public final AreaGenerationLibrary _percolator()
Returns a reference to this instances random map/object generation library.

Returns:
a reference to this instances random map/object generation library.
See Also:
AreaGenerationLibrary

_ableMapper

public final AbilityMapper _ableMapper()
Returns a reference to this instances abilities collection/management library.

Returns:
a reference to this instances abilities collection/management library.
See Also:
AbilityMapper

_ableComponents

public final AbilityComponents _ableComponents()
Returns a reference to this instances abilities components management library.

Returns:
a reference to this instances abilities components management library.
See Also:
AbilityComponents

_encoder

public final TextEncoders _encoder()
Returns a reference to this instances string hashing and compression library.

Returns:
a reference to this instances string hashing and compression library.
See Also:
TextEncoders

_smtp

public final SMTPLibrary _smtp()
Returns a reference to this instances email sending library.

Returns:
a reference to this instances email sending library.
See Also:
SMTPLibrary

_lang

public final LanguageLibrary _lang()
Returns a reference to this instances localization library.

Returns:
a reference to this instances localization library.
See Also:
LanguageLibrary

_dice

public final DiceLibrary _dice()
Returns a reference to this instances random dice roll library.

Returns:
a reference to this instances random dice roll library.
See Also:
DiceLibrary

_factions

public final FactionManager _factions()
Returns a reference to this instances faction collection/management library.

Returns:
a reference to this instances faction collection/management library.
See Also:
FactionManager

_clans

public final ClanManager _clans()
Returns a reference to this instances clan collection/management library.

Returns:
a reference to this instances clan collection/management library.
See Also:
ClanManager

_polls

public final PollManager _polls()
Returns a reference to this instances player poll collection/management library.

Returns:
a reference to this instances player poll collection/management library.
See Also:
PollManager

_time

public final TimeManager _time()
Returns a reference to this instances real time utility library.

Returns:
a reference to this instances real time utility library.
See Also:
TimeManager

_color

public final ColorLibrary _color()
Returns a reference to this instances ansi color library.

Returns:
a reference to this instances ansi color library.
See Also:
ColorLibrary

_login

public final CharCreationLibrary _login()
Returns a reference to this instances login and char creation library.

Returns:
a reference to this instances login and char creation library.
See Also:
CharCreationLibrary

_expertises

public final ExpertiseLibrary _expertises()
Returns a reference to this instances expertise collection/management library.

Returns:
a reference to this instances expertise collection/management library.
See Also:
ExpertiseLibrary

_players

public final PlayerLibrary _players()
Returns a reference to this instances player and account collection/management library.

Returns:
a reference to this instances player and account collection/management library.
See Also:
PlayerLibrary

_catalog

public final CatalogLibrary _catalog()
Returns a reference to this instances cataloged mob/item collection/management library.

Returns:
a reference to this instances cataloged mob/item collection/management library.
See Also:
CatalogLibrary

_titles

public final AutoTitlesLibrary _titles()
Returns a reference to this instances player titles collection/management library.

Returns:
a reference to this instances player titles collection/management library.
See Also:
AutoTitlesLibrary

_ableParms

public final AbilityParameters _ableParms()
Returns a reference to this instances recipe maker and skill parameter library.

Returns:
a reference to this instances recipe maker and skill parameter library.
See Also:
AbilityParameters

_genEd

public final GenericEditor _genEd()
Returns a reference to this instances generic object builder/editor and prompting library.

Returns:
a reference to this instances generic object builder/editor and prompting library.
See Also:
GenericEditor

_tech

public final TechLibrary _tech()
Returns a reference to this instances tech and electricity library.

Returns:
a reference to this instances tech and electricity library.
See Also:
TechLibrary

_protocol

public final ProtocolLibrary _protocol()
Returns a reference to this instances mud protocol mxp/msdp/etc library.

Returns:
a reference to this instances mud protocol mxp/msdp/etc library.
See Also:
ProtocolLibrary

convertToLibraryCode

public static final CMLib.Library convertToLibraryCode(java.lang.Object O)
Return the Library Enum entry that represents the ancestor of the given library object.

Parameters:
O - the library object
Returns:
the Library Enum entry
See Also:
CMLib.Library

registerLibrary

public static final void registerLibrary(CMLibrary O)
Register the given library object as belonging to the thread group that called this method.

Parameters:
O - the library to register
See Also:
CMLibrary

killThread

public static final void killThread(java.lang.Thread t,
                                    long sleepTime,
                                    int attempts)
Do your best to shut down the given thread, trying for at most sleepTime ms, and making as many number attempts as given.

Parameters:
t - the thread to kill
sleepTime - ms to wait for the thread to die between attempts
attempts - the number of attempts to make

s_sleep

public static final boolean s_sleep(long millis)
Sleep for the given ms without throwing an exception

Parameters:
millis - the ms to sleep
Returns:
true

propertiesLoaded

public static final void propertiesLoaded()
Signify to the library library (this), that the ini file has been loaded, and that all registered libraries need to be likewise notified.


activateLibraries

public static final void activateLibraries()
Signify to the library library (this) that all of the library classes have been registered, and that any missing libraries are to share code with the thread 0 (base) set.


library

public static final CMLibrary library(char tcode,
                                      CMLib.Library lcode)
Return the library belonging to the given thread group code, and the given Library Enum

Parameters:
tcode - the thread group code
lcode - the Library Enum
Returns:
the appropriate library belonging to the thread group and code
See Also:
CMLib.Library, CMLibrary

libraries

public static final java.util.Enumeration<CMLibrary> libraries(CMLib.Library code)
Returns an enumeration of all library objects of the Library Enum type given across all thread groups.

Parameters:
code - the Library Enum
Returns:
an enumeration of all library objects in all threads of that type
See Also:
CMLib.Library

getLibraryThreadID

public static final char getLibraryThreadID(CMLib.Library code,
                                            CMLibrary lib)
Return the private thread id that belongs to the given library

Parameters:
code - the library code
lib - the library to look for
Returns:
that libraries code

registerLibraries

public static final void registerLibraries(java.util.Enumeration<CMLibrary> e)
Calls registerLibrary on all the given CMLibrary objects

Parameters:
e - an enumeration of CMLibrary objects
See Also:
CMLibrary, registerLibrary(CMLibrary)

countRegistered

public static final int countRegistered()
Returns how many CMLibrary objects have been registered for this thread group.

Returns:
a count of CMLibrary objects registered

unregistered

public static final java.lang.String unregistered()
Returns a comma-delimited list of the ordinal numbers of those libraries which have not been registered for this thread group.

Returns:
a string list of unregistered library ordinals