public class CMLib
extends java.lang.Object
MudHost| Modifier and Type | Class | Description | 
|---|---|---|
| static class  | CMLib.Library | Collection of all the different official CoffeeMud libraries | 
| Constructor | Description | 
|---|---|
| CMLib() | Constructs a new CMLib object for the current thread group. | 
| Modifier and Type | Method | Description | 
|---|---|---|
| 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. | 
| CityMap | _city() | Returns a reference to this instances city objects 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. | 
| GalacticMap | _space() | Returns a reference to this instances space mapping 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. | 
| AutoAwardsLibrary | _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 AutoAwardsLibrary | awards() | Returns a reference to this threads player awards collection/management library. | 
| 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 CityMap | city() | Returns a reference to this threads city objects 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 java.util.Set<CMLibrary> | getLibrariesSharedWith(CMLib.Library codeTypeToGet,
                      CMLibrary lib) | Returns the set of CMLibrarys of the *GIVEN* code type that are shared with the
 given library instance of any type. | 
| static char | getLibraryThreadID(CMLib.Library code,
                  CMLibrary lib) | Return the private thread id that belongs to the given library | 
| static char | getLibraryThreadID(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 MudHost | host(char threadId) | 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 WorldHuntLibrary | hunt() | Returns a reference to this threads areas and rooms searching library. | 
| 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 GalacticMap | space() | Returns a reference to this threads space mapping 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 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. | 
public static final CMLib initialize()
public static final CMath math()
CMathpublic static final CMParms parms()
CMParmspublic static final CMStrings strings()
CMStringspublic static final CMClass classes()
CMClasspublic static final CMSecurity security()
CMSecuritypublic static final Directions directions()
Directionspublic static final Log log()
Logpublic static final Resources resources()
Resourcespublic static final CMProps props()
CMPropspublic static final java.util.List<MudHost> hosts()
MUDpublic static final MudHost host(char threadId)
threadId - the threadId of the host to getpublic static final MudHost host()
public static final MudHost mud(int port)
port - port to search forMudHostpublic static final java.util.Enumeration<CMLibrary> libraries()
CMLibrarypublic static final CMLib get(Session session)
session - the sessionpublic static final CMLib get(int id)
id - the idpublic static final DatabaseEngine database()
DatabaseEnginepublic static final ThreadEngine threads()
ThreadEnginepublic static final I3Interface intermud()
I3Interfacepublic static final ItemBalanceLibrary itemBuilder()
ItemBalanceLibrarypublic static final WebMacroLibrary webMacroFilter()
WebMacroLibrarypublic static final ListingLibrary lister()
ListingLibrarypublic static final MoneyLibrary beanCounter()
MoneyLibrarypublic static final ShoppingLibrary coffeeShops()
ShoppingLibrarypublic static final MaterialLibrary materials()
MaterialLibrarypublic static final CombatLibrary combat()
CombatLibrarypublic static final HelpLibrary help()
HelpLibrarypublic static final TrackingLibrary tracking()
TrackingLibrarypublic static final LegalLibrary law()
LegalLibrarypublic static final MaskingLibrary masking()
MaskingLibrarypublic static final ChannelsLibrary channels()
ChannelsLibrarypublic static final CommonCommands commands()
CommonCommandspublic static final AchievementLibrary achievements()
AchievementLibrarypublic static final EnglishParsing english()
EnglishParsingpublic static final SlaveryLibrary slavery()
SlaveryLibrarypublic static final GalacticMap space()
GalacticMappublic static final CityMap city()
CityMappublic static final JournalsLibrary journals()
JournalsLibrarypublic static final TelnetFilter coffeeFilter()
TelnetFilterpublic static final GenericBuilder coffeeMaker()
GenericBuilderpublic static final SessionsList sessions()
SessionsListpublic static final CMFlagLibrary flags()
CMFlagLibrarypublic static final XMLLibrary xml()
XMLLibrarypublic static final SocialsList socials()
SocialsListpublic static final CMMiscUtils utensils()
CMMiscUtilspublic static final StatisticsLibrary coffeeTables()
StatisticsLibrarypublic static final ExpLevelLibrary leveler()
ExpLevelLibrarypublic static final WorldMap map()
WorldMappublic static final WorldHuntLibrary hunt()
WorldHuntLibrarypublic static final QuestManager quests()
QuestManagerpublic static final AreaGenerationLibrary percolator()
AreaGenerationLibrarypublic static final AbilityMapper ableMapper()
AbilityMapperpublic static final AbilityComponents ableComponents()
AbilityComponentspublic static final TextEncoders encoder()
TextEncoderspublic static final SMTPLibrary smtp()
SMTPLibrarypublic static final LanguageLibrary lang()
LanguageLibrarypublic static final DiceLibrary dice()
DiceLibrarypublic static final FactionManager factions()
FactionManagerpublic static final ClanManager clans()
ClanManagerpublic static final PollManager polls()
PollManagerpublic static final TimeManager time()
TimeManagerpublic static final ColorLibrary color()
ColorLibrarypublic static final CharCreationLibrary login()
CharCreationLibrarypublic static final ExpertiseLibrary expertises()
ExpertiseLibrarypublic static final PlayerLibrary players()
PlayerLibrarypublic static final CatalogLibrary catalog()
CatalogLibrarypublic static final AutoAwardsLibrary awards()
AutoAwardsLibrarypublic static final AbilityParameters ableParms()
AbilityParameterspublic static final GenericEditor genEd()
GenericEditorpublic static final TechLibrary tech()
TechLibrarypublic static final ProtocolLibrary protocol()
ProtocolLibrarypublic final DatabaseEngine _database()
DatabaseEnginepublic final ThreadEngine _threads()
ThreadEnginepublic final I3Interface _intermud()
I3Interfacepublic final ItemBalanceLibrary _itemBuilder()
ItemBalanceLibrarypublic final WebMacroLibrary _webMacroFilter()
WebMacroLibrarypublic final ListingLibrary _lister()
ListingLibrarypublic final MoneyLibrary _beanCounter()
MoneyLibrarypublic final ShoppingLibrary _coffeeShops()
ShoppingLibrarypublic final MaterialLibrary _materials()
MaterialLibrarypublic final CombatLibrary _combat()
CombatLibrarypublic final HelpLibrary _help()
HelpLibrarypublic final TrackingLibrary _tracking()
TrackingLibrarypublic final LegalLibrary _law()
LegalLibrarypublic final MaskingLibrary _masking()
MaskingLibrarypublic final ChannelsLibrary _channels()
ChannelsLibrarypublic final CommonCommands _commands()
CommonCommandspublic final AchievementLibrary _achievements()
AchievementLibrarypublic final EnglishParsing _english()
EnglishParsingpublic final SlaveryLibrary _slavery()
SlaveryLibrarypublic final JournalsLibrary _journals()
JournalsLibrarypublic final TelnetFilter _coffeeFilter()
TelnetFilterpublic final GenericBuilder _coffeeMaker()
GenericBuilderpublic final GalacticMap _space()
GalacticMappublic final CityMap _city()
CityMappublic final SessionsList _sessions()
SessionsListpublic final CMFlagLibrary _flags()
CMFlagLibrarypublic final XMLLibrary _xml()
XMLLibrarypublic final SocialsList _socials()
SocialsListpublic final CMMiscUtils _utensils()
CMMiscUtilspublic final StatisticsLibrary _coffeeTables()
StatisticsLibrarypublic final ExpLevelLibrary _leveler()
ExpLevelLibrarypublic final WorldMap _map()
WorldMappublic final QuestManager _quests()
QuestManagerpublic final AreaGenerationLibrary _percolator()
AreaGenerationLibrarypublic final AbilityMapper _ableMapper()
AbilityMapperpublic final AbilityComponents _ableComponents()
AbilityComponentspublic final TextEncoders _encoder()
TextEncoderspublic final SMTPLibrary _smtp()
SMTPLibrarypublic final LanguageLibrary _lang()
LanguageLibrarypublic final DiceLibrary _dice()
DiceLibrarypublic final FactionManager _factions()
FactionManagerpublic final ClanManager _clans()
ClanManagerpublic final PollManager _polls()
PollManagerpublic final TimeManager _time()
TimeManagerpublic final ColorLibrary _color()
ColorLibrarypublic final CharCreationLibrary _login()
CharCreationLibrarypublic final ExpertiseLibrary _expertises()
ExpertiseLibrarypublic final PlayerLibrary _players()
PlayerLibrarypublic final CatalogLibrary _catalog()
CatalogLibrarypublic final AutoAwardsLibrary _titles()
AutoAwardsLibrarypublic final AbilityParameters _ableParms()
AbilityParameterspublic final GenericEditor _genEd()
GenericEditorpublic final TechLibrary _tech()
TechLibrarypublic final ProtocolLibrary _protocol()
ProtocolLibrarypublic static final CMLib.Library convertToLibraryCode(java.lang.Object O)
O - the library objectCMLib.Librarypublic static final void registerLibrary(CMLibrary O)
O - the library to registerCMLibrarypublic static final void killThread(java.lang.Thread t,
                                    long sleepTime,
                                    int attempts)
t - the thread to killsleepTime - ms to wait for the thread to die between attemptsattempts - the number of attempts to makepublic static final boolean s_sleep(long millis)
millis - the ms to sleeppublic static final void propertiesLoaded()
public static final void activateLibraries()
public static final CMLibrary library(char tcode, CMLib.Library lcode)
tcode - the thread group codelcode - the Library EnumCMLib.Library, 
CMLibrarypublic static final java.util.Enumeration<CMLibrary> libraries(CMLib.Library code)
code - the Library EnumCMLib.Librarypublic static final char getLibraryThreadID(CMLib.Library code, CMLibrary lib)
code - the library codelib - the library to look forpublic static final char getLibraryThreadID(CMLibrary lib)
lib - the library to look forpublic static final java.util.Set<CMLibrary> getLibrariesSharedWith(CMLib.Library codeTypeToGet, CMLibrary lib)
codeTypeToGet - the type of libraries to returnlib - the library instance all hosts must share to return a representative frompublic static final void registerLibraries(java.util.Enumeration<CMLibrary> e)
e - an enumeration of CMLibrary objectsCMLibrary, 
registerLibrary(CMLibrary)public static final int countRegistered()
public static final java.lang.String unregistered()