Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface Summary
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.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.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.
AutoTitlesLibrary The library for managing the various 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.
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.
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.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.
DiceLibrary The Dice library governs random numbers in various ranges, various hit point generation algorithms, and selecting objects from various lists at random.
EnglishParsing  
ExpertiseLibrary  
ExpertiseLibrary.ExpertiseDefinition  
ExpertiseLibrary.SkillCost Class for the cost of a skill, or similar things perhaps
ExpertiseLibrary.SkillCostDefinition Class for the definition of the cost of a skill
ExpLevelLibrary  
FactionManager  
GenericBuilder  
GenericEditor  
GenericEditor.CMEval  
HelpLibrary  
I3Interface  
ItemBalanceLibrary  
JournalsLibrary  
JournalsLibrary.CommandJournal  
JournalsLibrary.ForumJournal  
JournalsLibrary.JournalMetaData  
JournalsLibrary.MsgMkrCallback  
JournalsLibrary.SMTPJournal  
LanguageLibrary  
LegalLibrary  
ListingLibrary  
ListingLibrary.ListStringer  
MaskingLibrary  
MaskingLibrary.CompiledZMask  
MaskingLibrary.CompiledZMaskEntry  
MaterialLibrary  
MoneyLibrary  
MoneyLibrary.DebtItem  
MoneyLibrary.MoneyDenomination  
PlayerLibrary  
PlayerLibrary.ThinPlayer  
PollManager  
ProtocolLibrary  
ProtocolLibrary.MCPPackage Interface allowing java or javascript plugins to the MCP protocol
QuestManager  
QuestManager.HolidayData  
SessionsList  
ShoppingLibrary  
SlaveryLibrary  
SlaveryLibrary.GeasStep  
SlaveryLibrary.GeasSteps  
SMTPLibrary  
SMTPLibrary.SMTPClient  
SocialsList  
StatisticsLibrary  
TechLibrary  
TelnetFilter  
TextEncoders  
ThreadEngine  
TimeManager  
TrackingLibrary  
TrackingLibrary.RFilter  
TrackingLibrary.RFilters  
TrackingLibrary.TrackingFlags  
WebMacroLibrary  
WorldMap  
WorldMap.LocatedPair  
XMLLibrary  
XMLLibrary.XMLTag  
 

Class Summary
MaterialLibrary.DeadResourceRecord A record detailing information about destoryed resources, used mostly for common skills that consume them.
PlayerLibrary.ThinnerPlayer  
 

Enum Summary
AbilityMapper.Cost An enum usually used to index an array of different kinds of skill use costs.
AbilityParameters.ParmType The column or single parameter types
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.
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.
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.
DatabaseEngine.DatabaseTables An enum of all the database table types.
ExpertiseLibrary.CostType Enumeration of the types of costs of gaining this ability
ExpertiseLibrary.Flag  
GenericBuilder.GenItemCode  
GenericBuilder.GenMOBBonusFakeStats  
GenericBuilder.GenMOBCode  
JournalsLibrary.CommandJournalFlags  
JournalsLibrary.ForumJournalFlags  
JournalsLibrary.MsgMkrResolution  
MaskingLibrary.ZapperKey  
ProtocolLibrary.GMCPCommand  
QuestManager.QMCommand  
SlaveryLibrary.Step  
TelnetFilter.Pronoun  
TrackingLibrary.TrackingFlag