Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface Summary

Interface	Description
AbilityComponents	Library for configureing and managing the rules for what resource components (magic dust, tools, etc) are required every time a particular skill is used.
AbilityComponents.AbilityLimits	Ability Limits object, denoting how many of different types of common skills and langs that a player can learn, including an entry for a specific skill.
AbilityMapper	The Ability Mapper Library handles everything dealing with the relationship between players, races, etc and Abilities (Skills, Spells, Prayers, etc).
AbilityMapper.AbilityMapping	An official Ability Mapping, used by many of the AbilityMapper classes.
AbilityMapper.CompoundingRule	A definition class for a mana compounding rule.
AbilityMapper.QualifyingID	A mapping between an Ability ID and it's qualifying level
AbilityParameters	Abilities, like common skills and others, have parameter definition strings that tell the system about any parameters that modify how the ability works.
AbilityParameters.AbilityParmEditor	The main interface for the individual column editors.
AbilityParameters.AbilityRecipeData	An AbilityParameters interface for passing around a completely decoded CraftorAbility (Common Skill) recipe list, ready for manipulation by users.
AchievementLibrary	The achievement library forms the basis of the achievement system, which accepts player events as input, as well as the file based achievement definition files, and tracks player and account completion of achievements through trackers.
AchievementLibrary.AbilityAward	The AbilityAward interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.Achievement	The achievement interface provides basic information about the specific achievement, as defined in the achievements.ini definition file.
AchievementLibrary.AmountAward	The award interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.Award	The award interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.CurrencyAward	The award interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.ExpertiseAward	The ExpertiseAward interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.StatAward	The award interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.TattooAward	The TattooAward interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.TitleAward	The award interface provides pre-parsed award information for those who complete the achievement.
AchievementLibrary.Tracker	A tracker object assigned to a particular player or account for a particular achievement, allowing the achievement to track progress if it needs to, or just providing a way to quickly query completion otherwise.
AreaGenerationLibrary	The AreaGenerationLibrary is the random generator, which takes a special flavor of xml as input to randomly generate anything from strings, to mobs and items, whole populated rooms, or entire areas.
AreaGenerationLibrary.LayoutManager	Area generators work by first laying out a set of rooms into a configuration called a Layout.
AreaGenerationLibrary.LayoutNode	A layout node represents a single room in a layout manager.
AutoAwardsLibrary	The library for managing the various automatic player awards, such as auto-titles, which are player titles that can, according to a mask, be automatically added and removed from players as they meet, and stop meeting, various criterium.
AutoAwardsLibrary.AutoProperties	Class to store the definitional information about a single set of AutoProperties
AutoAwardsLibrary.AutoTitle	Class to store the definitional information about a single AutoTitle
CatalogLibrary	The Catalog Library maintains the prototypes of various Items and Mobs who are keyed by their Name.
CatalogLibrary.CataData	CataData is the metadata about each entry in the catalog.
CatalogLibrary.RoomContent	An interface for getting a manipulable list of the content of a room.
ChannelsLibrary	The main chat channels management library.
ChannelsLibrary.ChannelMsg	The entry for the channel que, containing the CMMsg object that was sent as the original message as well as the timestamp when it was sent.
ChannelsLibrary.CMChannel	Basic Channel definition
CharCreationLibrary	This library manages everything related to logging a player or account in, creating a character, the account menu, certain login procedures, the rules around player names, start rooms, death rooms, and morgue rooms.
CharCreationLibrary.LoginSession	This is the main login state machine transaction object.
CityMap	For the sake of efficient look-ups, the engine keeps certain kinds of objects cached together, regardless of where they are in the world.
ClanManager	This library manages the list of Clans in the game, and helps administer their most basic functions.
CMFlagLibrary	The Flag Library is full of shortcut methods for checking the state of objects in a high level way.
CMLibrary	This is the base interface for all CoffeeMud libraries.
CMMiscUtils	The MiscUtils (Miscellaneous Utilities) library should not exist.
ColorLibrary	The color library does just what it says, provides access to methods to translate colors from words, to ansi codes, to html tags, and combine them all in ways appropriate for their use.
ColorLibrary.Color256	The object with information about all supported ANSI-256 colors
ColorLibrary.ColorState	A color state is a class saved for users so the system knows what the current color situation is, which allows it to go back when it changes.
CombatLibrary	Fighting, healing, determining combatants, death, attacking, damaging, and formations.
CommonCommands	Message handlers for the basic common commands, like get, drop, put, etc.
DatabaseEngine	Not really much point in saying a lot here.
DatabaseEngine.AckRecord	Table category: DBRACE, DBCHARCLASS, DBABILITY A data record for a generic race or class or generic ability.
DatabaseEngine.AckStats	Table category: DBRACE A record of the creation timstamp for a generic race
DatabaseEngine.PlayerData	Table category: DBPLAYERDATA A record of Data information from the database.
DatabaseEngine.PollData	Table category: DBPOLLS Raw record entry for the DBPOLLS table, where each record represents an entire poll and all of its results.
DatabaseEngine.RoomContent	Table category: CMROCH, CMROIT A record from one of the above tables A room content object
DiceLibrary	The Dice library governs random numbers in various ranges, various hit point generation algorithms, and selecting objects from various lists at random.
EnglishParsing	A library that deals specifically with language-specific string manipulation, and input parsing.
ExpertiseLibrary	The ExpertiseLibrary manages a list of optional, purchaseable player attributes, called expertises.
ExpertiseLibrary.ExpertiseDefinition	Class definiing a single level of a particular expertise, along with all requirements to gain it.
ExpLevelLibrary	Library which handles the gaining and losing of experience, as well as the gaining and losing of levels.
FactionManager	The Faction Manager is a storage class for all game Factions, handling lookups, storage, retrieval, and relations between them.
GalacticMap	The Galactic Map of All Space Objects is more than a simple object cache of things in space, but a sophisticated system for tracking where those things are in relation to each other, and finding things around a particular part of space quickly.
GenericBuilder	The Generic CMObject Building library is the heart and core of CoffeeMud 2.0, formerly called "Generic".
GenericEditor	The command line user interface for almost all On Line Editor functions goes through this library.
GenericEditor.CMEval	An interface for implementing a custom evaluator for prompts requiring lists of things.
HelpLibrary	Help File system for online users, providing not only lookup for named entries, but derived help data for various map and game objects.
I3Interface	Interface library between the mud and the InterMud 3 and Intermud 2 networks.
ItemBalanceLibrary	The setting of combat values on armor and weapons to the end of more balanced combat is managed here.
JournalsLibrary	Journals are any set of ordered messages, threaded or unthreaded, which are stored in a database and divided into categories, called Journals or Forums.
JournalsLibrary.CommandJournal	Command Journals are another category of Journal that is accessed from the command line (as oppposed to SMTP Journals accessed via email, Forums accessed via web page, and standard Journal accessed via item).
JournalsLibrary.ForumJournal	Journals with a meta-flags entry, typically Forums, are described by the accessors of this interface.
JournalsLibrary.JournalMetaData	ForumJournals are journals accessed via the web, and are typically threaded in their messages.
JournalsLibrary.MsgMkrCallback	Since The Message Maker advanced cl editor is async, this interface exists to provide a callBack to the message maker.
JournalsLibrary.SMTPJournal	An accessor interface for a view of a journal that is exposed to an email system.
LanguageLibrary	The localization library for CoffeeMud works by building a set of property files that do string matching and replacement from all of the game strings that start with L().
LegalLibrary	The primary legal matters handled by this library are property law: who is permitted to do what, where.
ListingLibrary	Providing data in a readable format is an important part of the user interface, especially for Archons who need access to charts and data for their work.
ListingLibrary.ListStringer	An interface to provide a custom conversion from an arbitrary object type to a string, which might include String to String conversions.
MaskingLibrary	A ZapperMask is a set of conditions, typically of the form VALUE in SET, KEY=VALUE or VALUE, etc.
MaskingLibrary.CompiledZMask	A Compiled ZapperMask is a set of conditions, typically of the form VALUE in SET, KEY=VALUE or VALUE, etc.
MaskingLibrary.CompiledZMaskEntry	A Compiled Mask Entry is a condition, typically of the form VALUE in SET, or KEY=VALUE, or VALUE in RANGE.
MaterialLibrary	At the center of CoffeeMuds crafting system are raw resources.
MaterialLibrary.DeadResourceRecord	A record detailing information about destoryed resources, used mostly for common skills that consume them.
MoneyLibrary	This library manages the official list of all currencies used in the game, including the built-in default currencies: "" (DEFAULT), GOLD, COPPER, CREDIT, DOLLAR, and VICTORY This also manages the creation and distribution of actual money items in the known currencies.
MoneyLibrary.DebtItem	Interface for an object referencing a debt from one to another, denominated in base currency, and carrying a due date and interest rate.
MoneyLibrary.MoneyDefinition	Interface for an object referencing an entire currency system, including all of its denominations.
MoneyLibrary.MoneyDenomination	Interface for an object referencing a single denomination of a specific currency.
PlayerLibrary	The Player Manager is primarily a cache and lookup utility library for player character mobs and player accounts if the account system is enabled.
PlayerLibrary.ThinnerPlayer	The absolute smallest whole view of a player char is the ThinnerPlayer interface, which requires the least work pulling from the database, short of pulling only a single field.
PlayerLibrary.ThinPlayer	Sometimes the system does not need the entire mob object and all associated attributes to make decisions about a particular player char.
PollManager	All encompassing Polling library, which handles not only caching fully loaded polls, but accessing polls from the database, creating them, editing them, participating in them, and seeing the results of them.
ProtocolLibrary	Library for supporting various in-line MUD protocols.
ProtocolLibrary.MCPPackage	Interface allowing java or javascript plugins to the MCP protocol
QuestManager	Manager for all game Quests and Holidays.
QuestManager.HolidayData	Interface for the raw definition data for a Holiday
SessionsList	Sessions are managed connections to a host telnet port through which the players interact.
ShoppingLibrary	This library handles everything related to shopkeepers and merchants.
SlaveryLibrary	Process handling for slaves and the victims of a Geas.
SlaveryLibrary.GeasStep	A process handler for an individual requires step in a geas or command.
SlaveryLibrary.GeasSteps	The main stepping object for the slave/geas victim, which tracks multiple high-level steps, even of which must be completed for the task itself to be completed.
SMTPLibrary	This library is an SMTP client, and probably won't remain a library forever, as it really belongs in common.
SMTPLibrary.SMTPClient	Interface for the underlying smtp client class, as opposed to tbe big bad library with its fancy abstract methods.
SocialsList	Collection manager for all the socials in the game, with utility functions for dealing with external socials as well.
StatisticsLibrary	Library for updating player statistics and tables.
TechLibrary	The Tech library mainly deals with technical items, and making them work.
TelnetFilter	Library for handling the conversion of raw mud output strings to final strings that are sent directly to the users socket connection for rendering by their client.
TextEncoders	Text/String encoders and decoders.
ThreadEngine	Low level task and thread management system, which contains its own internal respect for the "thread group id" system used by CoffeeMud.
TimeManager	A timestamp conversion library, for generating readable times and dates, as well as parsing strings into millisecond timestamps.
TrackingLibrary	The Tracking and NPC movement library.
TrackingLibrary.RFilter	A filtering interface for rooms, or for moving from a host room to a target room.
TrackingLibrary.RFilters	A filtering interface for rooms, or for moving from a host room to a target room.
TrackingLibrary.TrackingFlags	A collection of tracking flags, which are really just RFilter objects wrappers.
WebMacroLibrary	A helper library for the web server that implements the CMVP pages by interfacing with the web macro system, whereby the web server gains access to the rest of the mud runtime.
WorldHuntLibrary	Utility library for global map searches.
WorldMap	The main container for all of the worlds areas and rooms, along with cross-references and various indexed objects associated with it.
WorldMap.LocatedPair	Helper class for world searches, as it returns both the thing Found, as well as the room in which it was found.
XMLLibrary	XML parsing and xml document building library.
XMLLibrary.XMLTag

Class Summary

Class	Description
AreaGenerationLibrary.UpdateSet	The result set from an update
ExpLevelLibrary.ModXP	Class for tracking conditional changes to XP.

Enum Summary

Enum	Description
AbilityMapper.AbilCostType	An enum usually used to index an array of different kinds of skill use costs.
AbilityMapper.SecretFlag	The secret flag type for an ability mapping.
AbilityParameters.ParmType	The column or single parameter types
AchievementLibrary.AchievementFlag	Legal values for the FLAGS field in an achievement.
AchievementLibrary.AchievementLoadFlag	Flags to denote how awards are given when achievements are granted, especially on character creation and/or remort.
AchievementLibrary.AwardType	The award type is an enumeration of the different types of awards that can be granted for completing an achievement.
AchievementLibrary.Event	Events define the type of achievement, describing specific arguments that the achievement of each event type needs.
AreaGenerationLibrary.LayoutFlags	Enum of the type of room layoutnode
AreaGenerationLibrary.LayoutRuns	If this room layoutnode is a street type, what direction does it run?
AreaGenerationLibrary.LayoutTags	Enum of the types of tags that room layoutnodes can be flagged with.
AreaGenerationLibrary.LayoutTypes	Enum of the type of room layoutnode.
CatalogLibrary.CatalogKind	An enumeration for the two general catalog object kinds.
CatalogLibrary.CataSpawn	The spawn conditions for mobs or items.
ChannelsLibrary.ChannelFlag	The channel flags that define extra stuff that appears in or gets automatically sent on a given channel.
CharCreationLibrary.LoginResult	A response object from one of the login system methods, basically telling the caller something about the results of what was attempted.
CharCreationLibrary.NewCharNameCheckResult	A response object from one of the name checking methods, telling the caller some specifics about the attempt to create a new character by testing a new name.
CMFlagLibrary.ComingOrGoing	A disposition enum for various flagg methods.
CMMiscUtils.ItemState	A enum for item state flags
ColorLibrary.Color	These are the straight color codes and character codes such as blink adn so forth.
ColorLibrary.SpecialColor	The special color codes are named color codes which are usually renameable by the user to other basic colors.
CombatLibrary.CombatSystem	An enumeration of the several combat systems.
CommonCommands.LookView	Enum for special mob room view settings, decoded from player mob attributes.
DatabaseEngine.DatabaseTables	An enum of all the database table types.
DatabaseEngine.ReadRoomDisableFlag	Flags for reading room content
ExpertiseLibrary.XType	The Expertise Type num, which describes what skill aspect that this expertise will modify
ExpLevelLibrary.ModXP.DirectionCheck	Enum for tracking direction of an xp change
FactionManager.FAbilityMaskType	This enum identifies the different types of ability masks and flags that are found in faciton definitions.
GenericBuilder.GenItemBonusFakeStats	An enum for properties found on Item objects that are derivative, or otherwise not available in this form from the Modifiable interface.
GenericBuilder.GenItemCode	Enum for the most basic fields common to all objects that implement the Item interface.
GenericBuilder.GenMOBBonusFakeStats	An enum for properties found on MOB objects that are derivative, or otherwise not available in this form from the Modifiable interface.
GenericBuilder.GenMOBCode	The basic enum of GenMOB Modifiable codes used by the Modifiable interface on all mob derivatives.
GenericBuilder.GenPhysBonusFakeStats	An enum for properties found on many different Physical objects that are derivative, or otherwise not available from the Modifiable interface.
HelpLibrary.HelpSection	An enum for how to search help files.
JournalsLibrary.CommandJournalFlags	This enum defines flags that apply to command journals.
JournalsLibrary.ForumJournalFlags	Journals with a meta-flags entry, typically Forums, have numerous flags that define them.
JournalsLibrary.MsgMkrResolution	The return value of the resolution of the message maker closing.
MaskingLibrary.ZapperKey	The set of mask types.
PlayerLibrary.PlayerCode	The player library can query individual fields from player characters regardless of whether the player is cached or not.
PlayerLibrary.PlayerSortCode	For systems that list users and allow sorting, here is an enum of the popular sort codes, along with popular alias for the code names.
ProtocolLibrary.GMCPCommand	Enumeration of all support GMCP commands
QuestManager.QMCommand	Enum of official data types for the QuestMaker Wizard templates.
TelnetFilter.Pronoun	One of the most useful enums in the game, this reminds us of all the pronoun placeholder tags that get replaced at runtime by this very filter library by the contextually appropriate word.
TrackingLibrary.TrackingFlag	A Tracking Flag is a form of RFiler that is an enum that includes various pre-configured rfilters used throughout the engine.
TrackingLibrary.TrailFlag	Trail flags when building a description of trail description.