Eamon CS  3.1.0
EamonDD.Framework.Plugin.IEngine Interface Reference

More...

Inheritance diagram for EamonDD.Framework.Plugin.IEngine:
Eamon.Framework.Plugin.IEngine EamonDD.Game.Plugin.Engine EamonRT.Framework.Plugin.IEngine EamonRT.Game.Plugin.Engine AlternateBeginnersCave.Framework.Plugin.IEngine ARuncibleCargo.Framework.Plugin.IEngine BeginnersCaveII.Framework.Plugin.IEngine BeginnersForest.Framework.Plugin.IEngine Dharmaquest.Framework.Plugin.IEngine EamonRT.Game.Plugin.Engine LandOfTheMountainKing.Framework.Plugin.IEngine OrbOfMyLife.Framework.Plugin.IEngine SampleAdventure.Framework.Plugin.IEngine StrongholdOfKahrDur.Framework.Plugin.IEngine TheBeginnersCave.Framework.Plugin.IEngine TheDeepCanyon.Framework.Plugin.IEngine ThePyramidOfAnharos.Framework.Plugin.IEngine TheSubAquanLaboratory.Framework.Plugin.IEngine TheTempleOfNgurct.Framework.Plugin.IEngine TheTrainingGround.Framework.Plugin.IEngine TheVileGrimoireOfJaldial.Framework.Plugin.IEngine TheWayfarersInn.Framework.Plugin.IEngine WrenholdsSecretVigil.Framework.Plugin.IEngine

Public Member Functions

bool IsAdventureFilesetLoaded ()
 
bool IsCharacterInventoryLoaded ()
 
void DdProcessArgv (bool secondPass, ref bool ddfnFlag, ref bool nlFlag)
 
- Public Member Functions inherited from Eamon.Framework.Plugin.IEngine
void HandleException (Exception ex, string stackTraceFile, string errorMessage)
 
void ResolvePortabilityClassMappings ()
 
void ProcessArgv (string[] args)
 
RetCode LoadPluginClassMappings ()
 Loads the ClassMappingsDictionary with all interface to class mapping Key/Value pairs necessary to allow the currently loaded Eamon CS plugin to run. More...
 
RetCode LoadPluginClassMappings01 (Assembly plugin)
 Probes the currently executing library/plugin (Assembly) for all classes adorned with the ClassMappings attribute, pairs each class with its corresponding interface, and updates the ClassMappingsDictionary accordingly. More...
 
RetCode PushRulesetVersion (long rulesetVersion)
 
RetCode PopRulesetVersion ()
 
RetCode ClearRvStack ()
 
RetCode GetRvStackTop (ref long rvStackTop)
 
CreateInstance< T > (Type ifaceType, Action< T > initialize=null)
 
CreateInstance< T > (Action< T > initialize=null)
 
CloneInstance< T > (T source)
 
bool CompareInstances< T > (T object1, T object2)
 
bool IsRulesetVersion (params long[] versions)
 
string GetPrefixedFileName (string fileName)
 
void ConvertDatafileFromXmlToDat (string fileName)
 
RetCode PushDatabase ()
 
RetCode PushDatabase (IDatabase database)
 
RetCode PopDatabase (bool freeDatabase=true)
 
RetCode GetDatabase (long index, ref IDatabase database)
 
RetCode SaveDatabase (string fileName)
 
RetCode RestoreDatabase (string fileName)
 
RetCode ClearDbStack ()
 
RetCode GetDbStackTop (ref long dbStackTop)
 
void InitSystem ()
 
void DeinitSystem ()
 
void ResetProperties (PropertyResetCode resetCode)
 
void ReplaceDatafileValues (string fileName, string[] patterns, string[] replacements)
 
void UpgradeDatafile (string fileName)
 
string Upgrade300DatafileGetCharArtFileName (string characterFileName)
 
IList< ICharArtListDataUpgrade300DatafileParseCharacters (string xmlString)
 
IArtifact Upgrade300DatafileGetCharArtifact (ICharArtListData charArtData, string propertyName, XElement element)
 
string Upgrade300DatafileStripEquipment (string xmlString)
 
IPrep GetPrep (long index)
 Gets the sentence preposition (e.g., "to", "from", "inside", etc). More...
 
string GetArticle (long index)
 Gets the sentence article (e.g., "a", "some", "the", etc). More...
 
string GetNumberString (long index)
 
string GetFieldDescName (long index)
 
string GetFieldDescName (FieldDesc fieldDesc)
 
string GetStatusName (long index)
 Gets the name for a given Status. More...
 
string GetStatusName (Status status)
 Gets the name for a given Status. More...
 
string GetClothingName (long index)
 Gets the name for a given Clothing. More...
 
string GetClothingName (Clothing clothing)
 Gets the name for a given Clothing. More...
 
string GetCombatCodeDesc (long index)
 Gets the description for a given CombatCode. More...
 
string GetCombatCodeDesc (CombatCode combatCode)
 Gets the description for a given CombatCode. More...
 
string GetParryCodeDesc (long index)
 Gets the description for a given ParryCode. More...
 
string GetParryCodeDesc (ParryCode parryCode)
 Gets the description for a given ParryCode. More...
 
string GetContainerDisplayCodeDesc (long index)
 
string GetContainerDisplayCodeDesc (ContainerDisplayCode containerDisplayCode)
 
string GetLightLevelName (long index)
 Gets the name for a given LightLevel. More...
 
string GetLightLevelName (LightLevel lightLevel)
 Gets the name for a given LightLevel. More...
 
IStat GetStat (long index)
 Gets the data for a given Stat. More...
 
IStat GetStat (Stat stat)
 Gets the data for a given Stat. More...
 
ISpell GetSpell (long index)
 Gets the data for a given Spell. More...
 
ISpell GetSpell (Spell spell)
 Gets the data for a given Spell. More...
 
IWeapon GetWeapon (long index)
 Gets the data for a given Weapon. More...
 
IWeapon GetWeapon (Weapon weapon)
 Gets the data for a given Weapon. More...
 
IArmor GetArmor (long index)
 Gets the data for a given Armor. More...
 
IArmor GetArmor (Armor armor)
 Gets the data for a given Armor. More...
 
IDirection GetDirection (long index)
 Gets the data for a given Direction. More...
 
IDirection GetDirection (Direction direction)
 Gets the data for a given Direction. More...
 
IArtifactType GetArtifactType (long index)
 Gets the data for a given ArtifactType. More...
 
IArtifactType GetArtifactType (ArtifactType artifactType)
 Gets the data for a given ArtifactType. More...
 
bool IsSuccess (RetCode rc)
 Indicates whether an operation succeeded. More...
 
bool IsFailure (RetCode rc)
 Indicates whether an operation failed. More...
 
bool IsValidPluralType (PluralType pluralType)
 Indicates whether a plural type is valid. More...
 
bool IsValidArtifactType (ArtifactType artifactType)
 Indicates whether an artifact type is valid. More...
 
bool IsValidArtifactArmor (long armor, bool includeShields=true)
 Indicates whether an armor value is valid for a wearable Artifact. More...
 
bool IsValidMonsterArmor (long armor)
 Indicates whether an armor value is valid for a Monster. More...
 
bool IsValidMonsterCourage (long courage)
 Indicates whether a courage value is valid for a Monster. More...
 
bool IsValidMonsterFriendliness (Friendliness friendliness)
 
bool IsValidMonsterFriendlinessPct (Friendliness friendliness)
 
bool IsValidDirection (Direction dir)
 
bool IsValidRoomUid01 (long roomUid)
 
bool IsValidRoomDirectionDoorUid01 (long roomUid)
 
bool IsArtifactFieldStrength (long value)
 
bool IsUnmovable (long weight)
 
bool IsUnmovable01 (long weight)
 
long GetMonsterHealthStatusIndex (long hardiness, long dmgTaken)
 
long GetWeightCarryableGronds (long hardiness)
 
long GetWeightCarryableDos (long hardiness)
 
long GetIntellectBonusPct (long intellect)
 
long GetCharmMonsterPct (long charisma)
 
long GetPluralTypeEffectUid (PluralType pluralType)
 
long GetArmorFactor (long armorUid, long shieldUid)
 
long GetCharismaFactor (long charisma)
 
long GetMonsterFriendlinessPct (Friendliness friendliness)
 
long GetArtifactFieldStrength (long value)
 
long GetMerchantAskPrice (double price, double rtio)
 
long GetMerchantBidPrice (double price, double rtio)
 
long GetMerchantAdjustedCharisma (long charisma)
 
double GetMerchantRtio (long charisma)
 
bool IsCharYOrN (char ch)
 Indicates whether a character is one of ['Y', 'N']. More...
 
bool IsCharGOrAOrN (char ch)
 Indicates whether a character is one of ['G', 'A', 'N']. More...
 
bool IsCharSOrTOrROrX (char ch)
 Indicates whether a character is one of ['S', 'T', 'R', 'X']. More...
 
bool IsCharNOrSOrEOrW (char ch)
 Indicates whether a character is one of ['N', 'S', 'E', 'W']. More...
 
bool IsChar0Or1 (char ch)
 Indicates whether a character is one of ['0', '1']. More...
 
bool IsChar0To2 (char ch)
 Indicates whether a character is one of ['0', '1', '2']. More...
 
bool IsChar0To3 (char ch)
 Indicates whether a character is one of ['0', '1', '2', '3']. More...
 
bool IsChar1To3 (char ch)
 Indicates whether a character is one of ['1', '2', '3']. More...
 
bool IsChar1To4 (char ch)
 Indicates whether a character is one of ['1', '2', '3', '4']. More...
 
bool IsCharDigit (char ch)
 Indicates whether a character is a numeric digit. More...
 
bool IsCharDigitOrX (char ch)
 Indicates whether a character is a numeric digit or 'X'. More...
 
bool IsCharPlusMinusDigit (char ch)
 Indicates whether a character is a numeric digit or one of ['+', '-']. More...
 
bool IsCharAlpha (char ch)
 Indicates whether a character is alphabetic. More...
 
bool IsCharAlphaSpace (char ch)
 Indicates whether a character is alphabetic or space. More...
 
bool IsCharAlnum (char ch)
 Indicates whether a character is alphabetic or numeric digit. More...
 
bool IsCharAlnumSpace (char ch)
 Indicates whether a character is alphabetic, numeric digit or space. More...
 
bool IsCharAlnumPeriodUnderscore (char ch)
 Indicates whether a character is alphabetic, numeric digit, period or underscore. More...
 
bool IsCharPrint (char ch)
 Indicates whether a character is printable. More...
 
bool IsCharPound (char ch)
 Indicates whether a character is '#'. More...
 
bool IsCharQuote (char ch)
 Indicates whether a character is a quote. More...
 
bool IsCharAny (char ch)
 Indicates whether a character is any character at all. More...
 
bool IsCharAnyButDquoteCommaColon (char ch)
 Indicates whether a character is any character but one of ['"', ',', ':']. More...
 
bool IsCharAnyButBackForwardSlash (char ch)
 Indicates whether a character is any character but one of ['\', '/']. More...
 
char ModifyCharToUpper (char ch)
 Given a character, produce its upper case equivalent, if any. More...
 
char ModifyCharToNullOrX (char ch)
 Given a character, produce either 'X' or '\0'. More...
 
char ModifyCharToNull (char ch)
 Given a character, produce '\0'. More...
 
Direction GetDirection (string directionName)
 
ContainerType GetContainerType (ArtifactType artifactType)
 
IConfig GetConfig ()
 
IGameState GetGameState ()
 Gets the GameState record. More...
 
IModule GetModule ()
 Gets the Module record. More...
 
void Shuffle< T > (IList< T > list)
 
GetRandomElement< T > (T[] array, Func< long > indexFunc=null)
 
GetNonRepeatingRandomElement< T > (IList< T > sourceList, IList< T > usedList, Action< IList< T >> shuffleFunc=null)
 
GetNonRepeatingRandomElement01< T > (IList< T > sourceList, bool shuffle=false, Action< IList< T >> shuffleFunc=null)
 
EvalFriendliness< T > (Friendliness friendliness, T enemyValue, T neutralValue, T friendValue)
 Evaluates the Friendliness, returning a value of type T. More...
 
EvalGender< T > (Gender gender, T maleValue, T femaleValue, T neutralValue)
 Evaluates the Gender, returning a value of type T. More...
 
EvalContainerType< T > (ContainerType containerType, T inValue, T onValue, T underValue, T behindValue)
 Evaluates the ContainerType, returning a value of type T. More...
 
EvalRoomType< T > (RoomType roomType, T indoorsValue, T outdoorsValue)
 Evaluates the RoomType, returning a value of type T. More...
 
EvalLightLevel< T > (LightLevel lightLevel, T darkValue, T lightValue)
 Evaluates the LightLevel, returning a value of type T. More...
 
EvalPlural< T > (bool isPlural, T singularValue, T pluralValue)
 Evaluates the plural value, returning a value of type T. More...
 
string BuildPrompt (long bufSize, char fillChar, long number, string msg, string emptyVal)
 
string BuildValue (long bufSize, char fillChar, long offset, long longVal, string stringVal, string lookupMsg)
 
string WordWrap (string str, StringBuilder buf, long margin, IWordWrapArgs args, bool clearBuf=true)
 
string WordWrap (string str, StringBuilder buf, bool clearBuf=true)
 
string LineWrap (string str, StringBuilder buf, long startColumn, bool clearBuf=true)
 
string GetStringFromNumber (long num, bool addSpace, StringBuilder buf)
 
long GetNumberFromString (string str)
 
RetCode RollDice (long numDice, long numSides, ref long[] dieRolls)
 Rolls a number of dice, storing the resulting values in an array. More...
 
long RollDice (long numDice, long numSides, long modifier)
 Rolls a number of dice, returning a sum of the results. More...
 
RetCode SumHighestRolls (long[] dieRolls, long numRollsToSum, ref long result)
 Given an array of die rolls, sum the highest of them and return the result. More...
 
string Capitalize (string str)
 
void UnlinkOnFailure ()
 Deletes a set of game-related files from the filesystem. More...
 
void TruncatePluralTypeEffectDesc (PluralType pluralType, long maxSize)
 
void TruncatePluralTypeEffectDesc (IEffect effect)
 
RetCode SplitPath (string fullPath, ref string directory, ref string fileName, ref string extension, bool appendDirectorySeparatorChar=true)
 
RetCode StripPrepsAndArticles (StringBuilder buf, ref bool mySeen)
 
void PrintTitle (string title, bool inBox)
 
void PrintEffectDesc (IEffect effect, bool printFinalNewLine=true)
 
void PrintEffectDesc (long effectUid, bool printFinalNewLine=true)
 
void PrintZapDirectHit ()
 Prints the Blast spell description. More...
 
RetCode ValidateRecordsAfterDatabaseLoaded ()
 
RetCode StatDisplay (IStatDisplayArgs args)
 
RetCode GetRecordNameList (IList< IGameBase > recordList, IRecordNameListArgs args, StringBuilder buf)
 
RetCode GetRecordNameCount (IList< IGameBase > recordList, string name, bool exactMatch, ref long count)
 
RetCode ListRecords (IList< IGameBase > recordList, bool capitalize, bool showExtraInfo, StringBuilder buf)
 
RetCode ResolveUidMacros (string str, StringBuilder buf, bool resolveFuncs, bool recurse, ref long invalidUid)
 
RetCode ResolveUidMacros (string str, StringBuilder buf, bool resolveFuncs, bool recurse)
 
double GetWeaponPriceOrValue (string name, long complexity, Weapon type, long dice, long sides, long numHands, bool calcPrice, ref bool isMarcosWeapon)
 
double GetWeaponPriceOrValue (IArtifact weapon, bool calcPrice, ref bool isMarcosWeapon)
 
double GetArmorPriceOrValue (Armor armor, bool calcPrice, ref bool isMarcosArmor)
 
void AppendFieldDesc (FieldDesc fieldDesc, StringBuilder buf, StringBuilder fullDesc, StringBuilder briefDesc)
 
void AppendFieldDesc (FieldDesc fieldDesc, StringBuilder buf, string fullDesc, string briefDesc)
 
IList< IArtifactGetArtifactList (params Func< IArtifact, bool >[] whereClauseFuncs)
 
IList< IMonsterGetMonsterList (params Func< IMonster, bool >[] whereClauseFuncs)
 
IList< IGameBaseGetRecordList (params Func< IGameBase, bool >[] whereClauseFuncs)
 
IList< IMonsterGetFriendlyMonsterList (IMonster monster)
 
IList< IMonsterGetHostileMonsterList (IMonster monster)
 
IArtifact GetNthArtifact (IList< IArtifact > artifactList, long which, Func< IArtifact, bool > whereClauseFunc)
 
IMonster GetNthMonster (IList< IMonster > monsterList, long which, Func< IMonster, bool > whereClauseFunc)
 
IGameBase GetNthRecord (IList< IGameBase > recordList, long which, Func< IGameBase, bool > whereClauseFunc)
 
bool StripUniqueCharsFromRecordNames (IList< IGameBase > recordList)
 
bool AddUniqueCharsToRecordNames (IList< IGameBase > recordList)
 
bool SwapGreaterArmorUidWithLesserShieldUid (ICharacter character)
 
bool ShouldSleepAfterInput (StringBuilder buf, char inputFillChar)
 
void ConvertWeaponToGoldOrTreasure (IArtifact artifact, bool convertToGold)
 
void ConvertTreasureToContainer (IArtifact artifact, ContainerType containerType=ContainerType.In)
 
void ConvertContainerToTreasure (IArtifact artifact, ContainerType containerType=ContainerType.In)
 

Properties

new StringBuilder Buf [get, set]
 
string[] Argv [get, set]
 
long WordWrapCurrColumn [get, set]
 
char WordWrapLastChar [get, set]
 
string ConfigFileName [get, set]
 
IDdMenu DdMenu [get, set]
 
IMenu Menu [get, set]
 
IModule Module [get, set]
 
IConfig Config [get, set]
 
bool BortCommand [get, set]
 
bool DdSuppressPostInputSleep [get, set]
 
bool ConfigsModified [get, set]
 
bool FilesetsModified [get, set]
 
bool CharactersModified [get, set]
 
bool ModulesModified [get, set]
 
bool RoomsModified [get, set]
 
bool ArtifactsModified [get, set]
 
bool CharArtsModified [get, set]
 
bool EffectsModified [get, set]
 
bool MonstersModified [get, set]
 
bool HintsModified [get, set]
 
- Properties inherited from Eamon.Framework.Plugin.IEngine
StringBuilder Buf [get, set]
 
string[] CommandSepTokens [get]
 
string[] PronounTokens [get]
 
string ToughDesc [get]
 
string CourageDesc [get]
 
int ArtNameLen [get]
 Gets the maximum length of an Artifact Name. More...
 
int ArtStateDescLen [get]
 Gets the maximum length of an Artifact StateDesc. More...
 
int ArtDescLen [get]
 Gets the maximum length of an Artifact Desc. More...
 
int CharNameLen [get]
 Gets the maximum length of a Character Name. More...
 
int EffDescLen [get]
 Gets the maximum length of an Effect Desc. More...
 
int FsNameLen [get]
 Gets the maximum length of a Fileset Name. More...
 
int FsFileNameLen [get]
 Gets the maximum length of a Fileset file name (e.g., PluginFileName, etc). More...
 
int HntQuestionLen [get]
 Gets the maximum length of a Hint Question. More...
 
int HntAnswerLen [get]
 Gets the maximum length of a Hint Answer. More...
 
int ModNameLen [get]
 Gets the maximum length of a Module Name. More...
 
int ModDescLen [get]
 Gets the maximum length of a Module Desc. More...
 
int ModAuthorLen [get]
 Gets the maximum length of a Module Author. More...
 
int ModVolLabelLen [get]
 Gets the maximum length of a Module VolLabel. More...
 
int ModSerialNumLen [get]
 Gets the maximum length of a Module SerialNum. More...
 
int MonNameLen [get]
 Gets the maximum length of a Monster Name. More...
 
int MonStateDescLen [get]
 Gets the maximum length of a Monster StateDesc. More...
 
int MonDescLen [get]
 Gets the maximum length of a Monster Desc. More...
 
int RmNameLen [get]
 Gets the maximum length of a Room Name. More...
 
int RmDescLen [get]
 Gets the maximum length of a Room Desc. More...
 
long AxePrice [get]
 Gets the base price, in gold pieces, of an axe sold by Marcos Cavielli. More...
 
long BowPrice [get]
 Gets the base price, in gold pieces, of a bow sold by Marcos Cavielli. More...
 
long MacePrice [get]
 Gets the base price, in gold pieces, of a mace sold by Marcos Cavielli. More...
 
long SpearPrice [get]
 Gets the base price, in gold pieces, of a spear sold by Marcos Cavielli. More...
 
long SwordPrice [get]
 Gets the base price, in gold pieces, of a sword sold by Marcos Cavielli. More...
 
long ShieldPrice [get]
 Gets the base price, in gold pieces, of a shield sold by Marcos Cavielli. More...
 
long LeatherArmorPrice [get]
 Gets the base price, in gold pieces, of some leather armor sold by Marcos Cavielli. More...
 
long ChainMailPrice [get]
 Gets the base price, in gold pieces, of some chain mail armor sold by Marcos Cavielli. More...
 
long PlateMailPrice [get]
 Gets the base price, in gold pieces, of some plate mail armor sold by Marcos Cavielli. More...
 
long BlastPrice [get]
 Gets the base price, in gold pieces, of the Blast spell sold by Hokas Tokas. More...
 
long HealPrice [get]
 Gets the base price, in gold pieces, of the Heal spell sold by Hokas Tokas. More...
 
long SpeedPrice [get]
 Gets the base price, in gold pieces, of the Speed spell sold by Hokas Tokas. More...
 
long PowerPrice [get]
 Gets the base price, in gold pieces, of the Power spell sold by Hokas Tokas. More...
 
long RecallPrice [get]
 Gets the base price, in gold pieces, of being recalled from an adventure by a local wizard, as noted by the Burly Irishman at the Front Desk. More...
 
long StatGainPrice [get]
 Gets the base price, in gold pieces, of having a Stat boosted by the Good Witch. More...
 
long WeaponTrainingPrice [get]
 Gets the base price, in gold pieces, of having a weapon training session with Don Diego. More...
 
long ArmorTrainingPrice [get]
 Gets the base price, in gold pieces, of having an armor training session with the giant. More...
 
long SpellTrainingPrice [get]
 Gets the base price, in gold pieces, of having a spell training session with the licensed wizard. More...
 
long InfoBoothPrice [get]
 Gets the base price, in gold pieces, of purchasing services from the practice area info booth. More...
 
long FountainPrice [get]
 Gets the base price, in gold pieces, of interacting with the village fountain statue. More...
 
long NumRecords [get]
 Gets the maximum number of Records allowed in a database table. More...
 
long NumCharacterWeapons [get]
 Gets the maximum number of weapon Artifacts allowed in a Character's inventory. More...
 
long NumCharacterArtifacts [get]
 Gets the maximum number of Artifacts allowed in a Character's inventory. More...
 
long NumArtifactCategories [get]
 Gets the maximum number of Categories assignable to a single Artifact. More...
 
long NumArtifactCategoryFields [get]
 
int BufSize [get]
 Gets the default size for large, discardable StringBuilders created during system processing. More...
 
int BufSize01 [get]
 Gets the default size for small, discardable StringBuilders created during system processing. More...
 
int BufSize02 [get]
 Gets the default size for tiny, discardable StringBuilders created during system processing. More...
 
int BufSize03 [get]
 Gets the default size for medium, discardable StringBuilders created during system processing. More...
 
string ResolveEffectRegexPattern [get]
 
string ResolveUidMacroRegexPattern [get]
 
string ValidWorkDirRegexPattern [get]
 
string CommandSepRegexPattern [get]
 
string PronounRegexPattern [get]
 
string EverythingRegexPattern [get]
 
string ExceptRegexPattern [get]
 
string RecIdepErrorFmtStr [get]
 Gets the format string used to produce error messages during Record interdependency checking. More...
 
string AndroidAdventuresDir [get]
 Gets the Adventures directory path on Android platforms, relative to the working directory. More...
 
string AdventuresDir [get]
 Gets the Adventures directory path on non-Android platforms, relative to the working directory. More...
 
string QuickLaunchDir [get]
 Gets the QuickLaunch directory path, relative to the working directory. More...
 
string DefaultWorkDir [get]
 
string ProcessMutexName [get]
 Gets the name of the Mutex used to synchronize Eamon CS processes. More...
 
string EamonCSSlnFile [get]
 Gets the Eamon CS Solution path and file name, relative to the working directory. More...
 
string StackTraceFile [get]
 Gets the relative path and name of the error file dumped when an unexpected system shutdown occurs. More...
 
string GlobalLaunchParametersFile [get]
 Gets the Global Launch Parameters path and file name, relative to the working directory. More...
 
string ProgVersion [get]
 Gets the Eamon CS system version displayed on program startup. More...
 
long InfiniteDrinkableEdible [get]
 Gets a value indicating whether a Drinkable or Edible Artifact has infinite quantity. More...
 
long DirectionExit [get]
 Gets the Room Uid constant representing an exit from a game. More...
 
long LimboLocation [get]
 Gets the Room Uid constant representing "limbo". More...
 
long MinWeaponComplexity [get]
 Gets the minimum allowed weapon Complexity. More...
 
long MaxWeaponComplexity [get]
 Gets the maximum allowed weapon Complexity. More...
 
long MinGoldValue [get]
 Gets the minimum amount of gold the player character can carry or hold in the bank. More...
 
long MaxGoldValue [get]
 Gets the maximum amount of gold the player character can carry or hold in the bank. More...
 
long MaxPathLen [get]
 
long MaxRecursionLevel [get]
 Gets the maximum recursion level for macro replacement. More...
 
int WindowWidth [get]
 
int WindowHeight [get]
 
int BufferWidth [get]
 
int BufferHeight [get]
 
long RightMargin [get]
 
long NumRows [get]
 
IDictionary< Type, Type > ClassMappingsDictionary [get, set]
 Gets or sets the Dictionary that stores interface to class mappings as Key/Value pairs, used for dependency injection. More...
 
ITextReader In [get, set]
 Gets or sets the text reader that accepts user input from the console window. More...
 
ITextWriter Out [get, set]
 Gets or sets the text writer that prints text to the console window. More...
 
ITextWriter Error [get, set]
 Gets or sets the text writer that prints error messages to the console window. More...
 
IMutex Mutex [get, set]
 Gets or sets a mutex (mutual exclusion lock) that ensures only one Eamon CS process runs in a given operating system at a time. More...
 
ITransferProtocol TransferProtocol [get, set]
 
IDirectory Directory [get, set]
 Gets or sets the platform-independent Directory manager that Eamon CS relies on for all directory-related operations. More...
 
IFile File [get, set]
 Gets or sets the platform-independent File manager that Eamon CS relies on for all file-related operations. More...
 
IPath Path [get, set]
 Gets or sets the platform-independent file system Path manager that Eamon CS relies on for all file system path-related operations. More...
 
ISharpSerializer SharpSerializer [get, set]
 
IThread Thread [get, set]
 Gets or sets the platform-independent Thread manager that Eamon CS relies on for all thread-related operations. More...
 
MemoryStream CloneStream [get, set]
 
long MutatePropertyCounter [get, set]
 
string WorkDir [get, set]
 
string FilePrefix [get, set]
 
long RulesetVersion [get]
 Gets a value indicating which Eamon ruleset applies to the current game. More...
 
bool EnableMutateProperties [get]
 Gets a value indicating whether "mutating properties" (those that are dynamically calculated) should be enabled. More...
 
bool EnableStdio [get, set]
 
bool EnableNegativeRoomUidLinks [get, set]
 
bool EnableScreenReaderMode [get, set]
 
bool EnableCommandHistory [get, set]
 
bool EnableEnhancedCombat [get, set]
 
bool IgnoreMutex [get, set]
 Gets or sets a value indicating whether the Mutex should be ignored, allowing unlimited Eamon CS processes to run simultaneously. More...
 
bool DisableValidation [get, set]
 Gets or sets a value indicating whether validation should be disabled when Records are loaded. More...
 
bool RunGameEditor [get, set]
 
bool DeleteGameStateFromMainHall [get, set]
 
bool GetMainMenuInput [get, set]
 
Action< IDictionary< Type, Type > > LoadPortabilityClassMappings [get, set]
 
IDatabase Database [get]
 
IRoom RevealContentRoom [get, set]
 
IMonster RevealContentMonster [get, set]
 
IList< IArtifactRevealContentArtifactList [get, set]
 
IList< Action > RevealContentFuncList [get, set]
 
long RevealContentCounter [get, set]
 
string LineSep [get, set]
 
bool LineWrapUserInput [get, set]
 
IRecordDb< IConfigCFGDB [get, set]
 Gets or sets the Config database quick-accessor. More...
 
IRecordDb< IFilesetFSDB [get, set]
 Gets or sets the Fileset database quick-accessor. More...
 
IRecordDb< ICharacterCHRDB [get, set]
 Gets or sets the Character database quick-accessor. More...
 
IRecordDb< IModuleMODDB [get, set]
 Gets or sets the Module database quick-accessor. More...
 
IRecordDb< IRoomRDB [get, set]
 Gets or sets the Room database quick-accessor. More...
 
IRecordDb< IArtifactADB [get, set]
 Gets or sets the Artifact database quick-accessor. More...
 
IRecordDb< IEffectEDB [get, set]
 Gets or sets the Effect database quick-accessor. More...
 
IRecordDb< IMonsterMDB [get, set]
 Gets or sets the Monster database quick-accessor. More...
 
IRecordDb< IHintHDB [get, set]
 Gets or sets the Hint database quick-accessor. More...
 
IRecordDb< IGameStateGSDB [get, set]
 Gets or sets the GameState database quick-accessor. More...
 
IDictionary< long, Func< string > > MacroFuncs [get, set]
 Gets or sets a collection of functions used to resolve macros embedded in Desc, ArtifactStateDesc and Monster StateDesc properties. More...
 
Action< IRoom, IMonster, IArtifact, long, bool > RevealContainerContentsFunc [get, set]
 
IPrep[] Preps [get, set]
 Gets or sets an array of sentence prepositions (e.g., "to", "from", "inside", etc). More...
 
string[] Articles [get, set]
 Gets or sets an array of sentence articles (e.g., "a", "some", "the", etc). More...
 
string UnknownName [get, set]
 Gets or sets a generic string representing an unknown name (e.g., "???"). More...
 

Detailed Description

Member Function Documentation

◆ DdProcessArgv()

void EamonDD.Framework.Plugin.IEngine.DdProcessArgv ( bool  secondPass,
ref bool  ddfnFlag,
ref bool  nlFlag 
)

Parameters
secondPass
ddfnFlag
nlFlag

Implemented in EamonDD.Game.Plugin.Engine.

◆ IsAdventureFilesetLoaded()

bool EamonDD.Framework.Plugin.IEngine.IsAdventureFilesetLoaded ( )

Returns

Implemented in EamonDD.Game.Plugin.Engine.

◆ IsCharacterInventoryLoaded()

bool EamonDD.Framework.Plugin.IEngine.IsCharacterInventoryLoaded ( )

Returns

Implemented in EamonDD.Game.Plugin.Engine.

Property Documentation

◆ Argv

string [] EamonDD.Framework.Plugin.IEngine.Argv
getset

◆ ArtifactsModified

bool EamonDD.Framework.Plugin.IEngine.ArtifactsModified
getset

◆ BortCommand

bool EamonDD.Framework.Plugin.IEngine.BortCommand
getset

◆ Buf

new StringBuilder EamonDD.Framework.Plugin.IEngine.Buf
getset

◆ CharactersModified

bool EamonDD.Framework.Plugin.IEngine.CharactersModified
getset

◆ CharArtsModified

bool EamonDD.Framework.Plugin.IEngine.CharArtsModified
getset

◆ Config

IConfig EamonDD.Framework.Plugin.IEngine.Config
getset

◆ ConfigFileName

string EamonDD.Framework.Plugin.IEngine.ConfigFileName
getset

◆ ConfigsModified

bool EamonDD.Framework.Plugin.IEngine.ConfigsModified
getset

◆ DdMenu

IDdMenu EamonDD.Framework.Plugin.IEngine.DdMenu
getset

◆ DdSuppressPostInputSleep

bool EamonDD.Framework.Plugin.IEngine.DdSuppressPostInputSleep
getset

◆ EffectsModified

bool EamonDD.Framework.Plugin.IEngine.EffectsModified
getset

◆ FilesetsModified

bool EamonDD.Framework.Plugin.IEngine.FilesetsModified
getset

◆ HintsModified

bool EamonDD.Framework.Plugin.IEngine.HintsModified
getset

◆ Menu

IMenu EamonDD.Framework.Plugin.IEngine.Menu
getset

◆ Module

IModule EamonDD.Framework.Plugin.IEngine.Module
getset

◆ ModulesModified

bool EamonDD.Framework.Plugin.IEngine.ModulesModified
getset

◆ MonstersModified

bool EamonDD.Framework.Plugin.IEngine.MonstersModified
getset

◆ RoomsModified

bool EamonDD.Framework.Plugin.IEngine.RoomsModified
getset

◆ WordWrapCurrColumn

long EamonDD.Framework.Plugin.IEngine.WordWrapCurrColumn
getset

◆ WordWrapLastChar

char EamonDD.Framework.Plugin.IEngine.WordWrapLastChar
getset


The documentation for this interface was generated from the following file: