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

Public Member Functions

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

Properties

virtual string[] CommandSepTokens [get, protected set]
 
virtual string[] PronounTokens [get, protected set]
 
virtual string ToughDesc [get, protected set]
 
virtual string CourageDesc [get, protected set]
 
virtual int ArtNameLen = 40 [get, protected set]
 
virtual int ArtStateDescLen = 64 [get, protected set]
 
virtual int ArtDescLen = 256 [get, protected set]
 
virtual int CharNameLen = 32 [get, protected set]
 
virtual int EffDescLen = 256 [get, protected set]
 
virtual int FsNameLen = 40 [get, protected set]
 
virtual int FsFileNameLen = 64 [get, protected set]
 
virtual int HntQuestionLen = 256 [get, protected set]
 
virtual int HntAnswerLen = 256 [get, protected set]
 
virtual int ModNameLen = 40 [get, protected set]
 
virtual int ModDescLen = 256 [get, protected set]
 
virtual int ModAuthorLen = 40 [get, protected set]
 
virtual int ModVolLabelLen = 7 [get, protected set]
 
virtual int ModSerialNumLen = 3 [get, protected set]
 
virtual int MonNameLen = 40 [get, protected set]
 
virtual int MonStateDescLen = 64 [get, protected set]
 
virtual int MonDescLen = 256 [get, protected set]
 
virtual int RmNameLen = 50 [get, protected set]
 
virtual int RmDescLen = 256 [get, protected set]
 
virtual long AxePrice = 25 [get, protected set]
 
virtual long BowPrice = 40 [get, protected set]
 
virtual long MacePrice = 20 [get, protected set]
 
virtual long SpearPrice = 25 [get, protected set]
 
virtual long SwordPrice = 30 [get, protected set]
 
virtual long ShieldPrice = 50 [get, protected set]
 
virtual long LeatherArmorPrice = 100 [get, protected set]
 
virtual long ChainMailPrice = 250 [get, protected set]
 
virtual long PlateMailPrice = 500 [get, protected set]
 
virtual long BlastPrice = 1000 [get, protected set]
 
virtual long HealPrice = 500 [get, protected set]
 
virtual long SpeedPrice = 4000 [get, protected set]
 
virtual long PowerPrice = 100 [get, protected set]
 
virtual long RecallPrice = 100 [get, protected set]
 
virtual long StatGainPrice = 4500 [get, protected set]
 
virtual long WeaponTrainingPrice = 1000 [get, protected set]
 
virtual long ArmorTrainingPrice = 1000 [get, protected set]
 
virtual long SpellTrainingPrice = 1000 [get, protected set]
 
virtual long InfoBoothPrice = 30 [get, protected set]
 
virtual long FountainPrice = 20 [get, protected set]
 
virtual long NumRecords = 1000 [get, protected set]
 
virtual long NumCharacterWeapons = 4 [get, protected set]
 
virtual long NumCharacterArtifacts [get, protected set]
 
virtual long NumArtifactCategories = 4 [get, protected set]
 
virtual long NumArtifactCategoryFields = 20 [get, protected set]
 
virtual int BufSize = 1024 [get, protected set]
 
virtual int BufSize01 = 6 [get, protected set]
 
virtual int BufSize02 = 1 [get, protected set]
 
virtual int BufSize03 = 64 [get, protected set]
 
virtual string ResolveEffectRegexPattern = @"[^\*]\*[0-9]{3}|\*\*[0-9]{3}" [get, protected set]
 
virtual string ResolveUidMacroRegexPattern = @"[^\*]\*[0-9]{3}|\*\*[0-9]{3}|[^@]@[0-9]{3}|@@[0-9]{3}" [get, protected set]
 
virtual string ValidWorkDirRegexPattern = @"^(NONE)$|^(\.)$|^(\.\.\\\.\.\\Adventures\\[a-zA-Z0-9]+)$|^(\.\.\/\.\.\/Adventures\/[a-zA-Z0-9]+)$" [get, protected set]
 
virtual string CommandSepRegexPattern = @"\.|\!|\?|;|,| (?:and|then|also) " [get, protected set]
 
virtual string PronounRegexPattern = @" (?:those|them|that|him|her|it) " [get, protected set]
 
virtual string EverythingRegexPattern = @" everything " [get, protected set]
 
virtual string ExceptRegexPattern = @" (?:except|excluding|omitting) " [get, protected set]
 
virtual string RecIdepErrorFmtStr = "The {0} field refers to {1} Uid {2}, {3}." [get, protected set]
 
virtual string AndroidAdventuresDir = @"..\EamonPM.Android\Assets\Adventures" [get, protected set]
 
virtual string AdventuresDir = @"..\..\Adventures" [get, protected set]
 
virtual string QuickLaunchDir = @"..\..\QuickLaunch" [get, protected set]
 
virtual string DefaultWorkDir = "." [get, protected set]
 
virtual string ProcessMutexName [get, protected set]
 
virtual string EamonCSSlnFile = @"..\..\Eamon-CS.sln" [get, protected set]
 
virtual string StackTraceFile = @".\STACKTRACE.TXT" [get, protected set]
 
virtual string GlobalLaunchParametersFile = @".\GLOBAL_LAUNCH_PARAMETERS.TXT" [get, protected set]
 
virtual string ProgVersion = "3.1.0" [get, protected set]
 
virtual long InfiniteDrinkableEdible = 9999 [get, protected set]
 
virtual long DirectionExit = -999 [get, protected set]
 
virtual long LimboLocation = 0 [get, protected set]
 
virtual long MinWeaponComplexity = -50 [get, protected set]
 
virtual long MaxWeaponComplexity = 50 [get, protected set]
 
virtual long MinGoldValue = -99999 [get, protected set]
 
virtual long MaxGoldValue = 999999 [get, protected set]
 
virtual long MaxPathLen = 256 [get, protected set]
 
virtual long MaxRecursionLevel = 100 [get, protected set]
 
virtual int WindowWidth = 80 [get, protected set]
 
virtual int WindowHeight = 50 [get, protected set]
 
virtual int BufferWidth = 80 [get, protected set]
 
virtual int BufferHeight = 9999 [get, protected set]
 
virtual long RightMargin = 78 [get, protected set]
 
virtual long NumRows = 22 [get, protected set]
 
virtual IDictionary< Type, Type > ClassMappingsDictionary = new Dictionary<Type, Type>() [get, set]
 
virtual ITextReader In [get, set]
 
virtual ITextWriter Out [get, set]
 
virtual ITextWriter Error [get, set]
 
virtual IMutex Mutex [get, set]
 
virtual ITransferProtocol TransferProtocol [get, set]
 
virtual IDirectory Directory [get, set]
 
virtual IFile File [get, set]
 
virtual IPath Path [get, set]
 
virtual ISharpSerializer SharpSerializer [get, set]
 
virtual IThread Thread [get, set]
 
virtual MemoryStream CloneStream = new MemoryStream() [get, set]
 
virtual long MutatePropertyCounter = 1 [get, set]
 
virtual string WorkDir = "" [get, set]
 
virtual string FilePrefix = "" [get, set]
 
virtual long? RulesetVersion [get]
 
virtual bool EnableMutateProperties [get]
 
virtual bool EnableStdio = true [get, set]
 
virtual bool EnableNegativeRoomUidLinks [get, set]
 
virtual bool EnableScreenReaderMode [get, set]
 
virtual bool EnableCommandHistory [get, set]
 
virtual bool EnableEnhancedCombat [get, set]
 
virtual bool IgnoreMutex [get, set]
 
virtual bool DisableValidation [get, set]
 
virtual bool RunGameEditor [get, set]
 
virtual bool DeleteGameStateFromMainHall [get, set]
 
virtual bool GetMainMenuInput [get, set]
 
virtual Action< IDictionary< Type, Type > > LoadPortabilityClassMappings [get, set]
 
virtual IList< long > RulesetVersionList [get, set]
 
virtual IDatabaseDatabase [get]
 
virtual IRoom RevealContentRoom [get, set]
 
virtual IMonster RevealContentMonster [get, set]
 
virtual IList< IArtifactRevealContentArtifactList [get, set]
 
virtual IList< Action > RevealContentFuncList [get, set]
 
virtual long RevealContentCounter [get, set]
 
virtual string LineSep [get, set]
 
virtual bool LineWrapUserInput [get, set]
 
virtual IRecordDb< IConfigCFGDB [get, set]
 
virtual IRecordDb< IFilesetFSDB [get, set]
 
virtual IRecordDb< ICharacterCHRDB [get, set]
 
virtual IRecordDb< IModuleMODDB [get, set]
 
virtual IRecordDb< IRoomRDB [get, set]
 
virtual IRecordDb< IArtifactADB [get, set]
 
virtual IRecordDb< IEffectEDB [get, set]
 
virtual IRecordDb< IMonsterMDB [get, set]
 
virtual IRecordDb< IHintHDB [get, set]
 
virtual IRecordDb< IGameStateGSDB [get, set]
 
virtual IList< IDatabaseDatabaseList [get, set]
 
virtual IDictionary< long, Func< string > > MacroFuncs [get, set]
 
virtual Action< IRoom, IMonster, IArtifact, long, bool > RevealContainerContentsFunc [get, set]
 
virtual IPrep[] Preps [get, set]
 
virtual string[] Articles [get, set]
 
virtual string UnknownName [get, set]
 
virtual Random Rand [get, set]
 
virtual string[] NumberStrings [get, set]
 
virtual string[] FieldDescNames [get, set]
 
virtual string[] StatusNames [get, set]
 Gets or sets an array containing the name for each Status. More...
 
virtual string[] ClothingNames [get, set]
 Gets or sets an array containing the name for each Clothing. More...
 
virtual string[] CombatCodeDescs [get, set]
 Gets or sets an array containing the description for each CombatCode. More...
 
virtual string[] ParryCodeDescs [get, set]
 Gets or sets an array containing the description for each ParryCode. More...
 
virtual string[] ContainerDisplayCodeDescs [get, set]
 
virtual string[] LightLevelNames [get, set]
 Gets or sets an array containing the name for each LightLevel. More...
 
virtual IStat[] Stats [get, set]
 Gets or sets an array containing data for each Stat. More...
 
virtual ISpell[] Spells [get, set]
 Gets or sets an array containing data for each Spell. More...
 
virtual IWeapon[] Weapons [get, set]
 Gets or sets an array containing data for each Weapon. More...
 
virtual IArmor[] Armors [get, set]
 Gets or sets an array containing data for each Armor. More...
 
virtual IDirection[] Directions [get, set]
 Gets or sets an array containing data for each Direction. More...
 
virtual IArtifactType[] ArtifactTypes [get, set]
 Gets or sets an array containing data for each ArtifactType. More...
 
- 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...
 

Constructor & Destructor Documentation

◆ Engine()

Eamon.Game.Plugin.Engine.Engine ( )

Member Function Documentation

◆ AddUniqueCharsToRecordNames()

virtual bool Eamon.Game.Plugin.Engine.AddUniqueCharsToRecordNames ( IList< IGameBase recordList)
virtual

Parameters
recordList
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ AppendFieldDesc() [1/2]

virtual void Eamon.Game.Plugin.Engine.AppendFieldDesc ( FieldDesc  fieldDesc,
StringBuilder  buf,
string  fullDesc,
string  briefDesc 
)
virtual

Parameters
fieldDesc
buf
fullDesc
briefDesc

Implements Eamon.Framework.Plugin.IEngine.

◆ AppendFieldDesc() [2/2]

virtual void Eamon.Game.Plugin.Engine.AppendFieldDesc ( FieldDesc  fieldDesc,
StringBuilder  buf,
StringBuilder  fullDesc,
StringBuilder  briefDesc 
)
virtual

Parameters
fieldDesc
buf
fullDesc
briefDesc

Implements Eamon.Framework.Plugin.IEngine.

◆ BuildPrompt()

virtual string Eamon.Game.Plugin.Engine.BuildPrompt ( long  bufSize,
char  fillChar,
long  number,
string  msg,
string  emptyVal 
)
virtual

Parameters
bufSize
fillChar
number
msg
emptyVal
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ BuildValue()

virtual string Eamon.Game.Plugin.Engine.BuildValue ( long  bufSize,
char  fillChar,
long  offset,
long  longVal,
string  stringVal,
string  lookupMsg 
)
virtual

Parameters
bufSize
fillChar
offset
longVal
stringVal
lookupMsg
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ Capitalize()

virtual string Eamon.Game.Plugin.Engine.Capitalize ( string  str)
virtual

Parameters
str
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ClearDbStack()

virtual RetCode Eamon.Game.Plugin.Engine.ClearDbStack ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ClearRvStack()

virtual RetCode Eamon.Game.Plugin.Engine.ClearRvStack ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ CloneInstance< T >()

virtual T Eamon.Game.Plugin.Engine.CloneInstance< T > ( source)
virtual

Parameters
source
Returns

Implements Eamon.Framework.Plugin.IEngine.

Type Constraints
T :class 

◆ CompareInstances< T >()

virtual bool Eamon.Game.Plugin.Engine.CompareInstances< T > ( object1,
object2 
)
virtual

Parameters
object1
object2
Returns

Implements Eamon.Framework.Plugin.IEngine.

Type Constraints
T :class 

◆ ConvertContainerToTreasure()

virtual void Eamon.Game.Plugin.Engine.ConvertContainerToTreasure ( IArtifact  artifact,
ContainerType  containerType = ContainerType.In 
)
virtual

Parameters
artifact
containerType

Implements Eamon.Framework.Plugin.IEngine.

◆ ConvertDatafileFromXmlToDat()

virtual void Eamon.Game.Plugin.Engine.ConvertDatafileFromXmlToDat ( string  fileName)
virtual

Parameters
fileName

Implements Eamon.Framework.Plugin.IEngine.

◆ ConvertTreasureToContainer()

virtual void Eamon.Game.Plugin.Engine.ConvertTreasureToContainer ( IArtifact  artifact,
ContainerType  containerType = ContainerType.In 
)
virtual

Parameters
artifact
containerType

Implements Eamon.Framework.Plugin.IEngine.

◆ ConvertWeaponToGoldOrTreasure()

virtual void Eamon.Game.Plugin.Engine.ConvertWeaponToGoldOrTreasure ( IArtifact  artifact,
bool  convertToGold 
)
virtual

Parameters
artifact
convertToGold

Implements Eamon.Framework.Plugin.IEngine.

◆ CreateInstance< T >() [1/2]

virtual T Eamon.Game.Plugin.Engine.CreateInstance< T > ( Action< T >  initialize = null)
virtual

Parameters
initialize
Returns

Implements Eamon.Framework.Plugin.IEngine.

Type Constraints
T :class 

◆ CreateInstance< T >() [2/2]

virtual T Eamon.Game.Plugin.Engine.CreateInstance< T > ( Type  ifaceType,
Action< T >  initialize = null 
)
virtual

Parameters
ifaceType
initialize
Returns

Implements Eamon.Framework.Plugin.IEngine.

Type Constraints
T :class 

◆ DeinitSystem()

virtual void Eamon.Game.Plugin.Engine.DeinitSystem ( )
virtual

◆ EvalContainerType< T >()

virtual T Eamon.Game.Plugin.Engine.EvalContainerType< T > ( ContainerType  containerType,
inValue,
onValue,
underValue,
behindValue 
)
virtual

Evaluates the ContainerType, returning a value of type T.

Parameters
containerType
inValue
onValue
underValue
behindValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ EvalFriendliness< T >()

virtual T Eamon.Game.Plugin.Engine.EvalFriendliness< T > ( Friendliness  friendliness,
enemyValue,
neutralValue,
friendValue 
)
virtual

Evaluates the Friendliness, returning a value of type T.

Parameters
friendliness
enemyValue
neutralValue
friendValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ EvalGender< T >()

virtual T Eamon.Game.Plugin.Engine.EvalGender< T > ( Gender  gender,
maleValue,
femaleValue,
neutralValue 
)
virtual

Evaluates the Gender, returning a value of type T.

Parameters
gender
maleValue
femaleValue
neutralValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ EvalLightLevel< T >()

virtual T Eamon.Game.Plugin.Engine.EvalLightLevel< T > ( LightLevel  lightLevel,
darkValue,
lightValue 
)
virtual

Evaluates the LightLevel, returning a value of type T.

Parameters
lightLevel
darkValue
lightValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ EvalPlural< T >()

virtual T Eamon.Game.Plugin.Engine.EvalPlural< T > ( bool  isPlural,
singularValue,
pluralValue 
)
virtual

Evaluates the plural value, returning a value of type T.

Parameters
isPlural
singularValue
pluralValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ EvalRoomType< T >()

virtual T Eamon.Game.Plugin.Engine.EvalRoomType< T > ( RoomType  roomType,
indoorsValue,
outdoorsValue 
)
virtual

Evaluates the RoomType, returning a value of type T.

Parameters
roomType
indoorsValue
outdoorsValue
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArmor() [1/2]

virtual IArmor Eamon.Game.Plugin.Engine.GetArmor ( Armor  armor)
virtual

Gets the data for a given Armor.

Parameters
armor
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArmor() [2/2]

virtual IArmor Eamon.Game.Plugin.Engine.GetArmor ( long  index)
virtual

Gets the data for a given Armor.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArmorFactor()

virtual long Eamon.Game.Plugin.Engine.GetArmorFactor ( long  armorUid,
long  shieldUid 
)
virtual

Parameters
armorUid
shieldUid
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArmorPriceOrValue()

virtual double Eamon.Game.Plugin.Engine.GetArmorPriceOrValue ( Armor  armor,
bool  calcPrice,
ref bool  isMarcosArmor 
)
virtual

Parameters
armor
calcPrice
isMarcosArmor
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArticle()

virtual string Eamon.Game.Plugin.Engine.GetArticle ( long  index)
virtual

Gets the sentence article (e.g., "a", "some", "the", etc).

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArtifactFieldStrength()

virtual long Eamon.Game.Plugin.Engine.GetArtifactFieldStrength ( long  value)
virtual

Parameters
value
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArtifactList()

virtual IList<IArtifact> Eamon.Game.Plugin.Engine.GetArtifactList ( params Func< IArtifact, bool >[]  whereClauseFuncs)
virtual

Parameters
whereClauseFuncs
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArtifactType() [1/2]

virtual IArtifactType Eamon.Game.Plugin.Engine.GetArtifactType ( ArtifactType  artifactType)
virtual

Gets the data for a given ArtifactType.

Parameters
artifactType
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetArtifactType() [2/2]

virtual IArtifactType Eamon.Game.Plugin.Engine.GetArtifactType ( long  index)
virtual

Gets the data for a given ArtifactType.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetCharismaFactor()

virtual long Eamon.Game.Plugin.Engine.GetCharismaFactor ( long  charisma)
virtual

Parameters
charisma
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetCharmMonsterPct()

virtual long Eamon.Game.Plugin.Engine.GetCharmMonsterPct ( long  charisma)
virtual

Parameters
charisma
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetClothingName() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetClothingName ( Clothing  clothing)
virtual

Gets the name for a given Clothing.

Parameters
clothing
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetClothingName() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetClothingName ( long  index)
virtual

Gets the name for a given Clothing.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetCombatCodeDesc() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetCombatCodeDesc ( CombatCode  combatCode)
virtual

Gets the description for a given CombatCode.

Parameters
combatCode
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetCombatCodeDesc() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetCombatCodeDesc ( long  index)
virtual

Gets the description for a given CombatCode.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetConfig()

virtual IConfig Eamon.Game.Plugin.Engine.GetConfig ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetContainerDisplayCodeDesc() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetContainerDisplayCodeDesc ( ContainerDisplayCode  containerDisplayCode)
virtual

Parameters
containerDisplayCode
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetContainerDisplayCodeDesc() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetContainerDisplayCodeDesc ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetContainerType()

virtual ContainerType Eamon.Game.Plugin.Engine.GetContainerType ( ArtifactType  artifactType)
virtual

Parameters
artifactType
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetDatabase()

virtual RetCode Eamon.Game.Plugin.Engine.GetDatabase ( long  index,
ref IDatabase  database 
)
virtual

Parameters
index
database
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetDbStackTop()

virtual RetCode Eamon.Game.Plugin.Engine.GetDbStackTop ( ref long  dbStackTop)
virtual

Parameters
dbStackTop
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetDirection() [1/3]

virtual IDirection Eamon.Game.Plugin.Engine.GetDirection ( Direction  direction)
virtual

Gets the data for a given Direction.

Parameters
direction
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetDirection() [2/3]

virtual IDirection Eamon.Game.Plugin.Engine.GetDirection ( long  index)
virtual

Gets the data for a given Direction.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetDirection() [3/3]

virtual Direction Eamon.Game.Plugin.Engine.GetDirection ( string  directionName)
virtual

Parameters
directionName
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetFieldDescName() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetFieldDescName ( FieldDesc  fieldDesc)
virtual

Parameters
fieldDesc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetFieldDescName() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetFieldDescName ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetFriendlyMonsterList()

virtual IList<IMonster> Eamon.Game.Plugin.Engine.GetFriendlyMonsterList ( IMonster  monster)
virtual

Parameters
monster
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetGameState()

virtual IGameState Eamon.Game.Plugin.Engine.GetGameState ( )
virtual

Gets the GameState record.

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetHostileMonsterList()

virtual IList<IMonster> Eamon.Game.Plugin.Engine.GetHostileMonsterList ( IMonster  monster)
virtual

◆ GetIntellectBonusPct()

virtual long Eamon.Game.Plugin.Engine.GetIntellectBonusPct ( long  intellect)
virtual

Parameters
intellect
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetLightLevelName() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetLightLevelName ( LightLevel  lightLevel)
virtual

Gets the name for a given LightLevel.

Parameters
lightLevel
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetLightLevelName() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetLightLevelName ( long  index)
virtual

Gets the name for a given LightLevel.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMerchantAdjustedCharisma()

virtual long Eamon.Game.Plugin.Engine.GetMerchantAdjustedCharisma ( long  charisma)
virtual

Parameters
charisma
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMerchantAskPrice()

virtual long Eamon.Game.Plugin.Engine.GetMerchantAskPrice ( double  price,
double  rtio 
)
virtual

Parameters
price
rtio
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMerchantBidPrice()

virtual long Eamon.Game.Plugin.Engine.GetMerchantBidPrice ( double  price,
double  rtio 
)
virtual

Parameters
price
rtio
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMerchantRtio()

virtual double Eamon.Game.Plugin.Engine.GetMerchantRtio ( long  charisma)
virtual

Parameters
charisma
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetModule()

virtual IModule Eamon.Game.Plugin.Engine.GetModule ( )
virtual

Gets the Module record.

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMonsterFriendlinessPct()

virtual long Eamon.Game.Plugin.Engine.GetMonsterFriendlinessPct ( Friendliness  friendliness)
virtual

Parameters
friendliness
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMonsterHealthStatusIndex()

virtual long Eamon.Game.Plugin.Engine.GetMonsterHealthStatusIndex ( long  hardiness,
long  dmgTaken 
)
virtual

Parameters
hardiness
dmgTaken
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetMonsterList()

virtual IList<IMonster> Eamon.Game.Plugin.Engine.GetMonsterList ( params Func< IMonster, bool >[]  whereClauseFuncs)
virtual

Parameters
whereClauseFuncs
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNonRepeatingRandomElement01< T >()

virtual T Eamon.Game.Plugin.Engine.GetNonRepeatingRandomElement01< T > ( IList< T >  sourceList,
bool  shuffle = false,
Action< IList< T >>  shuffleFunc = null 
)
virtual

Parameters
sourceList
shuffle
shuffleFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNonRepeatingRandomElement< T >()

virtual T Eamon.Game.Plugin.Engine.GetNonRepeatingRandomElement< T > ( IList< T >  sourceList,
IList< T >  usedList,
Action< IList< T >>  shuffleFunc = null 
)
virtual

Parameters
sourceList
usedList
shuffleFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNthArtifact()

virtual IArtifact Eamon.Game.Plugin.Engine.GetNthArtifact ( IList< IArtifact artifactList,
long  which,
Func< IArtifact, bool >  whereClauseFunc 
)
virtual

Parameters
artifactList
which
whereClauseFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNthMonster()

virtual IMonster Eamon.Game.Plugin.Engine.GetNthMonster ( IList< IMonster monsterList,
long  which,
Func< IMonster, bool >  whereClauseFunc 
)
virtual

Parameters
monsterList
which
whereClauseFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNthRecord()

virtual IGameBase Eamon.Game.Plugin.Engine.GetNthRecord ( IList< IGameBase recordList,
long  which,
Func< IGameBase, bool >  whereClauseFunc 
)
virtual

Parameters
recordList
which
whereClauseFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNumberFromString()

virtual long Eamon.Game.Plugin.Engine.GetNumberFromString ( string  str)
virtual

Parameters
str
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetNumberString()

virtual string Eamon.Game.Plugin.Engine.GetNumberString ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetParryCodeDesc() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetParryCodeDesc ( long  index)
virtual

Gets the description for a given ParryCode.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetParryCodeDesc() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetParryCodeDesc ( ParryCode  parryCode)
virtual

Gets the description for a given ParryCode.

Parameters
parryCode
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetPluralTypeEffectUid()

virtual long Eamon.Game.Plugin.Engine.GetPluralTypeEffectUid ( PluralType  pluralType)
virtual

Parameters
pluralType
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetPrefixedFileName()

virtual string Eamon.Game.Plugin.Engine.GetPrefixedFileName ( string  fileName)
virtual

Parameters
fileName
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetPrep()

virtual IPrep Eamon.Game.Plugin.Engine.GetPrep ( long  index)
virtual

Gets the sentence preposition (e.g., "to", "from", "inside", etc).

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetRandomElement< T >()

virtual T Eamon.Game.Plugin.Engine.GetRandomElement< T > ( T[]  array,
Func< long >  indexFunc = null 
)
virtual

Parameters
array
indexFunc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetRecordList()

virtual IList<IGameBase> Eamon.Game.Plugin.Engine.GetRecordList ( params Func< IGameBase, bool >[]  whereClauseFuncs)
virtual

Parameters
whereClauseFuncs
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetRecordNameCount()

virtual RetCode Eamon.Game.Plugin.Engine.GetRecordNameCount ( IList< IGameBase recordList,
string  name,
bool  exactMatch,
ref long  count 
)
virtual

Parameters
recordList
name
exactMatch
count
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetRecordNameList()

virtual RetCode Eamon.Game.Plugin.Engine.GetRecordNameList ( IList< IGameBase recordList,
IRecordNameListArgs  args,
StringBuilder  buf 
)
virtual

Parameters
recordList
args
buf
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetRvStackTop()

virtual RetCode Eamon.Game.Plugin.Engine.GetRvStackTop ( ref long  rvStackTop)
virtual

Parameters
rvStackTop
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetSpell() [1/2]

virtual ISpell Eamon.Game.Plugin.Engine.GetSpell ( long  index)
virtual

Gets the data for a given Spell.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetSpell() [2/2]

virtual ISpell Eamon.Game.Plugin.Engine.GetSpell ( Spell  spell)
virtual

Gets the data for a given Spell.

Parameters
spell
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetStat() [1/2]

virtual IStat Eamon.Game.Plugin.Engine.GetStat ( long  index)
virtual

Gets the data for a given Stat.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetStat() [2/2]

virtual IStat Eamon.Game.Plugin.Engine.GetStat ( Stat  stat)
virtual

Gets the data for a given Stat.

Parameters
stat
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetStatusName() [1/2]

virtual string Eamon.Game.Plugin.Engine.GetStatusName ( long  index)
virtual

Gets the name for a given Status.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetStatusName() [2/2]

virtual string Eamon.Game.Plugin.Engine.GetStatusName ( Status  status)
virtual

Gets the name for a given Status.

Parameters
status
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetStringFromNumber()

virtual string Eamon.Game.Plugin.Engine.GetStringFromNumber ( long  num,
bool  addSpace,
StringBuilder  buf 
)
virtual

Parameters
num
addSpace
buf
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeapon() [1/2]

virtual IWeapon Eamon.Game.Plugin.Engine.GetWeapon ( long  index)
virtual

Gets the data for a given Weapon.

Parameters
index
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeapon() [2/2]

virtual IWeapon Eamon.Game.Plugin.Engine.GetWeapon ( Weapon  weapon)
virtual

Gets the data for a given Weapon.

Parameters
weapon
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeaponPriceOrValue() [1/2]

virtual double Eamon.Game.Plugin.Engine.GetWeaponPriceOrValue ( IArtifact  weapon,
bool  calcPrice,
ref bool  isMarcosWeapon 
)
virtual

Parameters
weapon
calcPrice
isMarcosWeapon
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeaponPriceOrValue() [2/2]

virtual double Eamon.Game.Plugin.Engine.GetWeaponPriceOrValue ( string  name,
long  complexity,
Weapon  type,
long  dice,
long  sides,
long  numHands,
bool  calcPrice,
ref bool  isMarcosWeapon 
)
virtual

Parameters
name
complexity
type
dice
sides
numHands
calcPrice
isMarcosWeapon
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeightCarryableDos()

virtual long Eamon.Game.Plugin.Engine.GetWeightCarryableDos ( long  hardiness)
virtual

Parameters
hardiness
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ GetWeightCarryableGronds()

virtual long Eamon.Game.Plugin.Engine.GetWeightCarryableGronds ( long  hardiness)
virtual

Parameters
hardiness
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ HandleException()

virtual void Eamon.Game.Plugin.Engine.HandleException ( Exception  ex,
string  stackTraceFile,
string  errorMessage 
)
virtual

Parameters
ex
stackTraceFile
errorMessage

Implements Eamon.Framework.Plugin.IEngine.

◆ InitSystem()

virtual void Eamon.Game.Plugin.Engine.InitSystem ( )
virtual

◆ IsArtifactFieldStrength()

virtual bool Eamon.Game.Plugin.Engine.IsArtifactFieldStrength ( long  value)
virtual

Parameters
value
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsChar0Or1()

virtual bool Eamon.Game.Plugin.Engine.IsChar0Or1 ( char  ch)
virtual

Indicates whether a character is one of ['0', '1'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsChar0To2()

virtual bool Eamon.Game.Plugin.Engine.IsChar0To2 ( char  ch)
virtual

Indicates whether a character is one of ['0', '1', '2'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsChar0To3()

virtual bool Eamon.Game.Plugin.Engine.IsChar0To3 ( char  ch)
virtual

Indicates whether a character is one of ['0', '1', '2', '3'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsChar1To3()

virtual bool Eamon.Game.Plugin.Engine.IsChar1To3 ( char  ch)
virtual

Indicates whether a character is one of ['1', '2', '3'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsChar1To4()

virtual bool Eamon.Game.Plugin.Engine.IsChar1To4 ( char  ch)
virtual

Indicates whether a character is one of ['1', '2', '3', '4'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAlnum()

virtual bool Eamon.Game.Plugin.Engine.IsCharAlnum ( char  ch)
virtual

Indicates whether a character is alphabetic or numeric digit.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAlnumPeriodUnderscore()

virtual bool Eamon.Game.Plugin.Engine.IsCharAlnumPeriodUnderscore ( char  ch)
virtual

Indicates whether a character is alphabetic, numeric digit, period or underscore.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAlnumSpace()

virtual bool Eamon.Game.Plugin.Engine.IsCharAlnumSpace ( char  ch)
virtual

Indicates whether a character is alphabetic, numeric digit or space.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAlpha()

virtual bool Eamon.Game.Plugin.Engine.IsCharAlpha ( char  ch)
virtual

Indicates whether a character is alphabetic.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAlphaSpace()

virtual bool Eamon.Game.Plugin.Engine.IsCharAlphaSpace ( char  ch)
virtual

Indicates whether a character is alphabetic or space.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAny()

virtual bool Eamon.Game.Plugin.Engine.IsCharAny ( char  ch)
virtual

Indicates whether a character is any character at all.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAnyButBackForwardSlash()

virtual bool Eamon.Game.Plugin.Engine.IsCharAnyButBackForwardSlash ( char  ch)
virtual

Indicates whether a character is any character but one of ['\', '/'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharAnyButDquoteCommaColon()

virtual bool Eamon.Game.Plugin.Engine.IsCharAnyButDquoteCommaColon ( char  ch)
virtual

Indicates whether a character is any character but one of ['"', ',', ':'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharDigit()

virtual bool Eamon.Game.Plugin.Engine.IsCharDigit ( char  ch)
virtual

Indicates whether a character is a numeric digit.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharDigitOrX()

virtual bool Eamon.Game.Plugin.Engine.IsCharDigitOrX ( char  ch)
virtual

Indicates whether a character is a numeric digit or 'X'.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharGOrAOrN()

virtual bool Eamon.Game.Plugin.Engine.IsCharGOrAOrN ( char  ch)
virtual

Indicates whether a character is one of ['G', 'A', 'N'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharNOrSOrEOrW()

virtual bool Eamon.Game.Plugin.Engine.IsCharNOrSOrEOrW ( char  ch)
virtual

Indicates whether a character is one of ['N', 'S', 'E', 'W'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharPlusMinusDigit()

virtual bool Eamon.Game.Plugin.Engine.IsCharPlusMinusDigit ( char  ch)
virtual

Indicates whether a character is a numeric digit or one of ['+', '-'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharPound()

virtual bool Eamon.Game.Plugin.Engine.IsCharPound ( char  ch)
virtual

Indicates whether a character is '#'.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharPrint()

virtual bool Eamon.Game.Plugin.Engine.IsCharPrint ( char  ch)
virtual

Indicates whether a character is printable.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharQuote()

virtual bool Eamon.Game.Plugin.Engine.IsCharQuote ( char  ch)
virtual

Indicates whether a character is a quote.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharSOrTOrROrX()

virtual bool Eamon.Game.Plugin.Engine.IsCharSOrTOrROrX ( char  ch)
virtual

Indicates whether a character is one of ['S', 'T', 'R', 'X'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsCharYOrN()

virtual bool Eamon.Game.Plugin.Engine.IsCharYOrN ( char  ch)
virtual

Indicates whether a character is one of ['Y', 'N'].

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsFailure()

virtual bool Eamon.Game.Plugin.Engine.IsFailure ( RetCode  rc)
virtual

Indicates whether an operation failed.

Parameters
rc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsRulesetVersion()

virtual bool Eamon.Game.Plugin.Engine.IsRulesetVersion ( params long[]  versions)
virtual

Parameters
versions
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsSuccess()

virtual bool Eamon.Game.Plugin.Engine.IsSuccess ( RetCode  rc)
virtual

Indicates whether an operation succeeded.

Parameters
rc
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsUnmovable()

virtual bool Eamon.Game.Plugin.Engine.IsUnmovable ( long  weight)
virtual

Parameters
weight
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsUnmovable01()

virtual bool Eamon.Game.Plugin.Engine.IsUnmovable01 ( long  weight)
virtual

Parameters
weight
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidArtifactArmor()

virtual bool Eamon.Game.Plugin.Engine.IsValidArtifactArmor ( long  armor,
bool  includeShields = true 
)
virtual

Indicates whether an armor value is valid for a wearable Artifact.

Parameters
armor
includeShields
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidArtifactType()

virtual bool Eamon.Game.Plugin.Engine.IsValidArtifactType ( ArtifactType  artifactType)
virtual

Indicates whether an artifact type is valid.

Parameters
artifactType
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidDirection()

virtual bool Eamon.Game.Plugin.Engine.IsValidDirection ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidMonsterArmor()

virtual bool Eamon.Game.Plugin.Engine.IsValidMonsterArmor ( long  armor)
virtual

Indicates whether an armor value is valid for a Monster.

Parameters
armor
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidMonsterCourage()

virtual bool Eamon.Game.Plugin.Engine.IsValidMonsterCourage ( long  courage)
virtual

Indicates whether a courage value is valid for a Monster.

Parameters
courage
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidMonsterFriendliness()

virtual bool Eamon.Game.Plugin.Engine.IsValidMonsterFriendliness ( Friendliness  friendliness)
virtual

Parameters
friendliness
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidMonsterFriendlinessPct()

virtual bool Eamon.Game.Plugin.Engine.IsValidMonsterFriendlinessPct ( Friendliness  friendliness)
virtual

Parameters
friendliness
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidPluralType()

virtual bool Eamon.Game.Plugin.Engine.IsValidPluralType ( PluralType  pluralType)
virtual

Indicates whether a plural type is valid.

Parameters
pluralType
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidRoomDirectionDoorUid01()

virtual bool Eamon.Game.Plugin.Engine.IsValidRoomDirectionDoorUid01 ( long  roomUid)
virtual

Parameters
roomUid
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ IsValidRoomUid01()

virtual bool Eamon.Game.Plugin.Engine.IsValidRoomUid01 ( long  roomUid)
virtual

Parameters
roomUid
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ LineWrap()

virtual string Eamon.Game.Plugin.Engine.LineWrap ( string  str,
StringBuilder  buf,
long  startColumn,
bool  clearBuf = true 
)
virtual

Parameters
str
buf
startColumn
clearBuf
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ListRecords()

virtual RetCode Eamon.Game.Plugin.Engine.ListRecords ( IList< IGameBase recordList,
bool  capitalize,
bool  showExtraInfo,
StringBuilder  buf 
)
virtual

Parameters
recordList
capitalize
showExtraInfo
buf
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ LoadPluginClassMappings()

virtual RetCode Eamon.Game.Plugin.Engine.LoadPluginClassMappings ( )
virtual

Loads the ClassMappingsDictionary with all interface to class mapping Key/Value pairs necessary to allow the currently loaded Eamon CS plugin to run.

The mechanism used to accomplish this is easy to understand but somewhat hard to describe without providing a concrete example and referring you to other source code files to inspect their contents. Let's take a look at the game Wrenhold's Secret Vigil. Please inspect the following files in the order listed (they are also executed in this order by Eamon CS - a simplified call stack):

All of these files contain LoadPluginClassMappings. In the top three files, it is an override that calls into the level below by invoking base.LoadPluginClassMappings. So it immediately drills down to the bottom of the stack (to the Eamon library).

Then things get interesting. The lowest level calls LoadPluginClassMappings01 which probes the current Assembly (the Eamon library) using Reflection, looking for classes adorned with the ClassMappings attribute. It then adds Key/Value pairs for all found classes (along with their matching interfaces) to the ClassMappingsDictionary. At this point, the call stack unwinds to the next higher level (EamonDD), and the overridden LoadPluginClassMappings method makes the same call to LoadPluginClassMappings01 which performs the same function, only this time it probes EamonDD for classes. This process repeats until the stack is fully unwound and the original call to LoadPluginClassMappings (in Program.cs) returns.

At each level, all newly discovered class/interface pairs are added immediately to the ClassMappingsDictionary; however, for any new class that maps to a pre-existing interface already in the Dictionary, that new class becomes the Value for that interface's Key/Value pair. In other words, classes in higher layers override classes in lower layers when they map to the same interface. This is how, for example, in Wrenhold's Secret Vigil, you wind up with EamonRT.Framework.Components.ICombatComponent mapping to WrenholdsSecretVigil.Game.Components.CombatComponent. And why a call made to CreateInstance returns the game-specific CombatComponent object.

Returns

Implements Eamon.Framework.Plugin.IEngine.

Reimplemented in EamonRT.Game.Plugin.Engine, EamonDD.Game.Plugin.Engine, EamonMH.Game.Plugin.Engine, TheWayfarersInn.Game.Plugin.Engine, TheVileGrimoireOfJaldial.Game.Plugin.Engine, OrbOfMyLife.Game.Plugin.Engine, TheSubAquanLaboratory.Game.Plugin.Engine, ThePyramidOfAnharos.Game.Plugin.Engine, ARuncibleCargo.Game.Plugin.Engine, TheTempleOfNgurct.Game.Plugin.Engine, AlternateBeginnersCave.Game.Plugin.Engine, WrenholdsSecretVigil.Game.Plugin.Engine, Dharmaquest.Game.Plugin.Engine, TheBeginnersCave.Game.Plugin.Engine, TheDeepCanyon.Game.Plugin.Engine, BeginnersForest.Game.Plugin.Engine, BeginnersCaveII.Game.Plugin.Engine, StrongholdOfKahrDur.Game.Plugin.Engine, LandOfTheMountainKing.Game.Plugin.Engine, TheTrainingGround.Game.Plugin.Engine, and SampleAdventure.Game.Plugin.Engine.

◆ LoadPluginClassMappings01()

virtual RetCode Eamon.Game.Plugin.Engine.LoadPluginClassMappings01 ( Assembly  plugin)
virtual

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.

This is the third and final piece of the Eamon CS dependency injection puzzle. If you haven't done so, please review the remarks on ClassMappingsDictionary and LoadPluginClassMappings for necessary background information before reading these comments. This method is responsible for probing the passed in library/plugin (in C# terms, an Assembly) for classes adorned with the ClassMappings attribute. Then it iterates over each found class and obtains all ClassMappings attribute information for that class. (While in theory, each class can have multiple ClassMappings attributes applied to it, this is not currently done.) At this point, we know the class will be the Value part of a Key/Value pair, but we still don't know what interface to associate it with (the Key part). This is decided based on which ClassMappings constructor is called. If this constructor is used (e.g., [ClassMappings(typeof(Eamon.Framework.IGameState))]) then the passed in interface is used as the Key. Otherwise, for this constructor (e.g., [ClassMappings]), the name of the interface used as the Key will be synthesized by prepending "I" to the class name. So, for example, CombatComponent pairs with ICombatComponent. In this scenario, the class must always implement or inherit the interface; otherwise the system won't be able to find it. If the interface to be used as a Key can't be found, Eamon CS will issue an error and terminate the program. Assuming everything checks out, the class is then stored as the Value in the Dictionary with the interface as the Key. If the interface already existed in the Dictionary (having been inserted by a lower level of the system) then the old class associated with the interface is replaced with the new class. This allows lower-level interfaces to be associated with increasingly specialized higher-level classes, which is core to the functioning of Eamon CS.

Parameters
plugin
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ModifyCharToNull()

virtual char Eamon.Game.Plugin.Engine.ModifyCharToNull ( char  ch)
virtual

Given a character, produce '\0'.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ModifyCharToNullOrX()

virtual char Eamon.Game.Plugin.Engine.ModifyCharToNullOrX ( char  ch)
virtual

Given a character, produce either 'X' or '\0'.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ModifyCharToUpper()

virtual char Eamon.Game.Plugin.Engine.ModifyCharToUpper ( char  ch)
virtual

Given a character, produce its upper case equivalent, if any.

Parameters
ch
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ PopDatabase()

virtual RetCode Eamon.Game.Plugin.Engine.PopDatabase ( bool  freeDatabase = true)
virtual

Parameters
freeDatabase
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ PopRulesetVersion()

virtual RetCode Eamon.Game.Plugin.Engine.PopRulesetVersion ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ PrintEffectDesc() [1/2]

virtual void Eamon.Game.Plugin.Engine.PrintEffectDesc ( IEffect  effect,
bool  printFinalNewLine = true 
)
virtual

Parameters
effect
printFinalNewLine

Implements Eamon.Framework.Plugin.IEngine.

◆ PrintEffectDesc() [2/2]

virtual void Eamon.Game.Plugin.Engine.PrintEffectDesc ( long  effectUid,
bool  printFinalNewLine = true 
)
virtual

Parameters
effectUid
printFinalNewLine

Implements Eamon.Framework.Plugin.IEngine.

◆ PrintTitle()

virtual void Eamon.Game.Plugin.Engine.PrintTitle ( string  title,
bool  inBox 
)
virtual

Parameters
title
inBox

Implements Eamon.Framework.Plugin.IEngine.

◆ PrintZapDirectHit()

virtual void Eamon.Game.Plugin.Engine.PrintZapDirectHit ( )
virtual

Prints the Blast spell description.

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ProcessArgv()

virtual void Eamon.Game.Plugin.Engine.ProcessArgv ( string[]  args)
virtual

Parameters
args

Implements Eamon.Framework.Plugin.IEngine.

◆ PushDatabase() [1/2]

virtual RetCode Eamon.Game.Plugin.Engine.PushDatabase ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ PushDatabase() [2/2]

virtual RetCode Eamon.Game.Plugin.Engine.PushDatabase ( IDatabase  database)
virtual

Parameters
database
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ PushRulesetVersion()

virtual RetCode Eamon.Game.Plugin.Engine.PushRulesetVersion ( long  rulesetVersion)
virtual

Parameters
rulesetVersion
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ReplaceDatafileValues()

virtual void Eamon.Game.Plugin.Engine.ReplaceDatafileValues ( string  fileName,
string[]  patterns,
string[]  replacements 
)
virtual

Parameters
fileName
patterns
replacements

Implements Eamon.Framework.Plugin.IEngine.

◆ ResetProperties()

virtual void Eamon.Game.Plugin.Engine.ResetProperties ( PropertyResetCode  resetCode)
virtual

◆ ResolvePortabilityClassMappings()

virtual void Eamon.Game.Plugin.Engine.ResolvePortabilityClassMappings ( )
virtual

◆ ResolveUidMacros() [1/2]

virtual RetCode Eamon.Game.Plugin.Engine.ResolveUidMacros ( string  str,
StringBuilder  buf,
bool  resolveFuncs,
bool  recurse 
)
virtual

Parameters
str
buf
resolveFuncs
recurse
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ResolveUidMacros() [2/2]

virtual RetCode Eamon.Game.Plugin.Engine.ResolveUidMacros ( string  str,
StringBuilder  buf,
bool  resolveFuncs,
bool  recurse,
ref long  invalidUid 
)
virtual

Parameters
str
buf
resolveFuncs
recurse
invalidUid
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ RestoreDatabase()

virtual RetCode Eamon.Game.Plugin.Engine.RestoreDatabase ( string  fileName)
virtual

Parameters
fileName
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ RestoreRecords< T, U >()

virtual RetCode Eamon.Game.Plugin.Engine.RestoreRecords< T, U > ( IDbTable< T >  table)
virtual

Parameters
table
Returns
Type Constraints
T :class 
T :IGameBase 
U :class 
U :IHelper<T> 

◆ RollDice() [1/2]

virtual long Eamon.Game.Plugin.Engine.RollDice ( long  numDice,
long  numSides,
long  modifier 
)
virtual

Rolls a number of dice, returning a sum of the results.

Parameters
numDice
numSides
modifier
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ RollDice() [2/2]

virtual RetCode Eamon.Game.Plugin.Engine.RollDice ( long  numDice,
long  numSides,
ref long[]  dieRolls 
)
virtual

Rolls a number of dice, storing the resulting values in an array.

Parameters
numDice
numSides
dieRolls
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ SaveDatabase()

virtual RetCode Eamon.Game.Plugin.Engine.SaveDatabase ( string  fileName)
virtual

Parameters
fileName
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ ShouldSleepAfterInput()

virtual bool Eamon.Game.Plugin.Engine.ShouldSleepAfterInput ( StringBuilder  buf,
char  inputFillChar 
)
virtual

Parameters
buf
inputFillChar
Returns

Implements Eamon.Framework.Plugin.IEngine.

Reimplemented in EamonRT.Game.Plugin.Engine, EamonDD.Game.Plugin.Engine, and EamonMH.Game.Plugin.Engine.

◆ Shuffle< T >()

virtual void Eamon.Game.Plugin.Engine.Shuffle< T > ( IList< T >  list)
virtual

◆ SplitPath()

virtual RetCode Eamon.Game.Plugin.Engine.SplitPath ( string  fullPath,
ref string  directory,
ref string  fileName,
ref string  extension,
bool  appendDirectorySeparatorChar = true 
)
virtual

Parameters
fullPath
directory
fileName
extension
appendDirectorySeparatorChar
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ StatDisplay()

virtual RetCode Eamon.Game.Plugin.Engine.StatDisplay ( IStatDisplayArgs  args)
virtual

◆ StripPrepsAndArticles()

virtual RetCode Eamon.Game.Plugin.Engine.StripPrepsAndArticles ( StringBuilder  buf,
ref bool  mySeen 
)
virtual

Parameters
buf
mySeen
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ StripUniqueCharsFromRecordNames()

virtual bool Eamon.Game.Plugin.Engine.StripUniqueCharsFromRecordNames ( IList< IGameBase recordList)
virtual

Parameters
recordList
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ SumHighestRolls()

virtual RetCode Eamon.Game.Plugin.Engine.SumHighestRolls ( long[]  dieRolls,
long  numRollsToSum,
ref long  result 
)
virtual

Given an array of die rolls, sum the highest of them and return the result.

Parameters
dieRolls
numRollsToSum
result
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ SwapGreaterArmorUidWithLesserShieldUid()

virtual bool Eamon.Game.Plugin.Engine.SwapGreaterArmorUidWithLesserShieldUid ( ICharacter  character)
virtual

Parameters
character
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ TruncatePluralTypeEffectDesc() [1/2]

virtual void Eamon.Game.Plugin.Engine.TruncatePluralTypeEffectDesc ( IEffect  effect)
virtual

Parameters
effect

Implements Eamon.Framework.Plugin.IEngine.

◆ TruncatePluralTypeEffectDesc() [2/2]

virtual void Eamon.Game.Plugin.Engine.TruncatePluralTypeEffectDesc ( PluralType  pluralType,
long  maxSize 
)
virtual

Parameters
pluralType
maxSize

Implements Eamon.Framework.Plugin.IEngine.

◆ UnlinkOnFailure()

virtual void Eamon.Game.Plugin.Engine.UnlinkOnFailure ( )
virtual

Deletes a set of game-related files from the filesystem.

Implements Eamon.Framework.Plugin.IEngine.

◆ Upgrade300DatafileGetCharArtFileName()

virtual string Eamon.Game.Plugin.Engine.Upgrade300DatafileGetCharArtFileName ( string  characterFileName)
virtual

Parameters
characterFileName
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ Upgrade300DatafileGetCharArtifact()

virtual IArtifact Eamon.Game.Plugin.Engine.Upgrade300DatafileGetCharArtifact ( ICharArtListData  charArtData,
string  propertyName,
XElement  element 
)
virtual

Parameters
charArtData
propertyName
element
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ Upgrade300DatafileParseCharacters()

virtual IList<ICharArtListData> Eamon.Game.Plugin.Engine.Upgrade300DatafileParseCharacters ( string  xmlString)
virtual

Parameters
xmlString
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ Upgrade300DatafileStripEquipment()

virtual string Eamon.Game.Plugin.Engine.Upgrade300DatafileStripEquipment ( string  xmlString)
virtual

Parameters
xmlString
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ UpgradeDatafile()

virtual void Eamon.Game.Plugin.Engine.UpgradeDatafile ( string  fileName)
virtual

Parameters
fileName

Implements Eamon.Framework.Plugin.IEngine.

◆ ValidateRecordsAfterDatabaseLoaded()

virtual RetCode Eamon.Game.Plugin.Engine.ValidateRecordsAfterDatabaseLoaded ( )
virtual

Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ WordWrap() [1/2]

virtual string Eamon.Game.Plugin.Engine.WordWrap ( string  str,
StringBuilder  buf,
bool  clearBuf = true 
)
virtual

Parameters
str
buf
clearBuf
Returns

Implements Eamon.Framework.Plugin.IEngine.

◆ WordWrap() [2/2]

virtual string Eamon.Game.Plugin.Engine.WordWrap ( string  str,
StringBuilder  buf,
long  margin,
IWordWrapArgs  args,
bool  clearBuf = true 
)
virtual

Parameters
str
buf
margin
args
clearBuf
Returns

Implements Eamon.Framework.Plugin.IEngine.

Property Documentation

◆ ADB

virtual IRecordDb<IArtifact> Eamon.Game.Plugin.Engine.ADB
getset

◆ AdventuresDir

virtual string Eamon.Game.Plugin.Engine.AdventuresDir = @"..\..\Adventures"
getprotected set

◆ AndroidAdventuresDir

virtual string Eamon.Game.Plugin.Engine.AndroidAdventuresDir = @"..\EamonPM.Android\Assets\Adventures"
getprotected set

◆ Armors

virtual IArmor [] Eamon.Game.Plugin.Engine.Armors
getset

Gets or sets an array containing data for each Armor.

◆ ArmorTrainingPrice

virtual long Eamon.Game.Plugin.Engine.ArmorTrainingPrice = 1000
getprotected set

◆ ArtDescLen

virtual int Eamon.Game.Plugin.Engine.ArtDescLen = 256
getprotected set

◆ Articles

virtual string [] Eamon.Game.Plugin.Engine.Articles
getset

◆ ArtifactTypes

virtual IArtifactType [] Eamon.Game.Plugin.Engine.ArtifactTypes
getset

Gets or sets an array containing data for each ArtifactType.

◆ ArtNameLen

virtual int Eamon.Game.Plugin.Engine.ArtNameLen = 40
getprotected set

◆ ArtStateDescLen

virtual int Eamon.Game.Plugin.Engine.ArtStateDescLen = 64
getprotected set

◆ AxePrice

virtual long Eamon.Game.Plugin.Engine.AxePrice = 25
getprotected set

◆ BlastPrice

virtual long Eamon.Game.Plugin.Engine.BlastPrice = 1000
getprotected set

◆ BowPrice

virtual long Eamon.Game.Plugin.Engine.BowPrice = 40
getprotected set

◆ BufferHeight

virtual int Eamon.Game.Plugin.Engine.BufferHeight = 9999
getprotected set

◆ BufferWidth

virtual int Eamon.Game.Plugin.Engine.BufferWidth = 80
getprotected set

◆ BufSize

virtual int Eamon.Game.Plugin.Engine.BufSize = 1024
getprotected set

◆ BufSize01

virtual int Eamon.Game.Plugin.Engine.BufSize01 = 6
getprotected set

◆ BufSize02

virtual int Eamon.Game.Plugin.Engine.BufSize02 = 1
getprotected set

◆ BufSize03

virtual int Eamon.Game.Plugin.Engine.BufSize03 = 64
getprotected set

◆ CFGDB

virtual IRecordDb<IConfig> Eamon.Game.Plugin.Engine.CFGDB
getset

◆ ChainMailPrice

virtual long Eamon.Game.Plugin.Engine.ChainMailPrice = 250
getprotected set

◆ CharNameLen

virtual int Eamon.Game.Plugin.Engine.CharNameLen = 32
getprotected set

◆ CHRDB

virtual IRecordDb<ICharacter> Eamon.Game.Plugin.Engine.CHRDB
getset

◆ ClassMappingsDictionary

virtual IDictionary<Type, Type> Eamon.Game.Plugin.Engine.ClassMappingsDictionary = new Dictionary<Type, Type>()
getset

◆ CloneStream

virtual MemoryStream Eamon.Game.Plugin.Engine.CloneStream = new MemoryStream()
getset

◆ ClothingNames

virtual string [] Eamon.Game.Plugin.Engine.ClothingNames
getset

Gets or sets an array containing the name for each Clothing.

◆ CombatCodeDescs

virtual string [] Eamon.Game.Plugin.Engine.CombatCodeDescs
getset

Gets or sets an array containing the description for each CombatCode.

◆ CommandSepRegexPattern

virtual string Eamon.Game.Plugin.Engine.CommandSepRegexPattern = @"\.|\!|\?|;|,| (?:and|then|also) "
getprotected set

◆ CommandSepTokens

virtual string [] Eamon.Game.Plugin.Engine.CommandSepTokens
getprotected set

◆ ContainerDisplayCodeDescs

virtual string [] Eamon.Game.Plugin.Engine.ContainerDisplayCodeDescs
getset

◆ CourageDesc

virtual string Eamon.Game.Plugin.Engine.CourageDesc
getprotected set

◆ Database

virtual IDatabase? Eamon.Game.Plugin.Engine.Database
get

◆ DatabaseList

virtual IList<IDatabase> Eamon.Game.Plugin.Engine.DatabaseList
getset

◆ DefaultWorkDir

virtual string Eamon.Game.Plugin.Engine.DefaultWorkDir = "."
getprotected set

◆ DeleteGameStateFromMainHall

virtual bool Eamon.Game.Plugin.Engine.DeleteGameStateFromMainHall
getset

◆ DirectionExit

virtual long Eamon.Game.Plugin.Engine.DirectionExit = -999
getprotected set

◆ Directions

virtual IDirection [] Eamon.Game.Plugin.Engine.Directions
getset

Gets or sets an array containing data for each Direction.

◆ Directory

virtual IDirectory Eamon.Game.Plugin.Engine.Directory
getset

◆ DisableValidation

virtual bool Eamon.Game.Plugin.Engine.DisableValidation
getset

◆ EamonCSSlnFile

virtual string Eamon.Game.Plugin.Engine.EamonCSSlnFile = @"..\..\Eamon-CS.sln"
getprotected set

◆ EDB

virtual IRecordDb<IEffect> Eamon.Game.Plugin.Engine.EDB
getset

◆ EffDescLen

virtual int Eamon.Game.Plugin.Engine.EffDescLen = 256
getprotected set

◆ EnableCommandHistory

virtual bool Eamon.Game.Plugin.Engine.EnableCommandHistory
getset

◆ EnableEnhancedCombat

virtual bool Eamon.Game.Plugin.Engine.EnableEnhancedCombat
getset

◆ EnableMutateProperties

virtual bool Eamon.Game.Plugin.Engine.EnableMutateProperties
get

◆ EnableNegativeRoomUidLinks

virtual bool Eamon.Game.Plugin.Engine.EnableNegativeRoomUidLinks
getset

◆ EnableScreenReaderMode

virtual bool Eamon.Game.Plugin.Engine.EnableScreenReaderMode
getset

◆ EnableStdio

virtual bool Eamon.Game.Plugin.Engine.EnableStdio = true
getset

◆ Error

virtual ITextWriter Eamon.Game.Plugin.Engine.Error
getset

◆ EverythingRegexPattern

virtual string Eamon.Game.Plugin.Engine.EverythingRegexPattern = @" everything "
getprotected set

◆ ExceptRegexPattern

virtual string Eamon.Game.Plugin.Engine.ExceptRegexPattern = @" (?:except|excluding|omitting) "
getprotected set

◆ FieldDescNames

virtual string [] Eamon.Game.Plugin.Engine.FieldDescNames
getset

◆ File

virtual IFile Eamon.Game.Plugin.Engine.File
getset

◆ FilePrefix

virtual string Eamon.Game.Plugin.Engine.FilePrefix = ""
getset

◆ FountainPrice

virtual long Eamon.Game.Plugin.Engine.FountainPrice = 20
getprotected set

◆ FSDB

virtual IRecordDb<IFileset> Eamon.Game.Plugin.Engine.FSDB
getset

◆ FsFileNameLen

virtual int Eamon.Game.Plugin.Engine.FsFileNameLen = 64
getprotected set

◆ FsNameLen

virtual int Eamon.Game.Plugin.Engine.FsNameLen = 40
getprotected set

◆ GetMainMenuInput

virtual bool Eamon.Game.Plugin.Engine.GetMainMenuInput
getset

◆ GlobalLaunchParametersFile

virtual string Eamon.Game.Plugin.Engine.GlobalLaunchParametersFile = @".\GLOBAL_LAUNCH_PARAMETERS.TXT"
getprotected set

◆ GSDB

virtual IRecordDb<IGameState> Eamon.Game.Plugin.Engine.GSDB
getset

◆ HDB

virtual IRecordDb<IHint> Eamon.Game.Plugin.Engine.HDB
getset

◆ HealPrice

virtual long Eamon.Game.Plugin.Engine.HealPrice = 500
getprotected set

◆ HntAnswerLen

virtual int Eamon.Game.Plugin.Engine.HntAnswerLen = 256
getprotected set

◆ HntQuestionLen

virtual int Eamon.Game.Plugin.Engine.HntQuestionLen = 256
getprotected set

◆ IgnoreMutex

virtual bool Eamon.Game.Plugin.Engine.IgnoreMutex
getset

◆ In

virtual ITextReader Eamon.Game.Plugin.Engine.In
getset

◆ InfiniteDrinkableEdible

virtual long Eamon.Game.Plugin.Engine.InfiniteDrinkableEdible = 9999
getprotected set

◆ InfoBoothPrice

virtual long Eamon.Game.Plugin.Engine.InfoBoothPrice = 30
getprotected set

◆ LeatherArmorPrice

virtual long Eamon.Game.Plugin.Engine.LeatherArmorPrice = 100
getprotected set

◆ LightLevelNames

virtual string [] Eamon.Game.Plugin.Engine.LightLevelNames
getset

Gets or sets an array containing the name for each LightLevel.

◆ LimboLocation

virtual long Eamon.Game.Plugin.Engine.LimboLocation = 0
getprotected set

◆ LineSep

virtual string Eamon.Game.Plugin.Engine.LineSep
getset

◆ LineWrapUserInput

virtual bool Eamon.Game.Plugin.Engine.LineWrapUserInput
getset

◆ LoadPortabilityClassMappings

virtual Action<IDictionary<Type, Type> > Eamon.Game.Plugin.Engine.LoadPortabilityClassMappings
getset

◆ MacePrice

virtual long Eamon.Game.Plugin.Engine.MacePrice = 20
getprotected set

◆ MacroFuncs

virtual IDictionary<long, Func<string> > Eamon.Game.Plugin.Engine.MacroFuncs
getset

◆ MaxGoldValue

virtual long Eamon.Game.Plugin.Engine.MaxGoldValue = 999999
getprotected set

◆ MaxPathLen

virtual long Eamon.Game.Plugin.Engine.MaxPathLen = 256
getprotected set

◆ MaxRecursionLevel

virtual long Eamon.Game.Plugin.Engine.MaxRecursionLevel = 100
getprotected set

◆ MaxWeaponComplexity

virtual long Eamon.Game.Plugin.Engine.MaxWeaponComplexity = 50
getprotected set

◆ MDB

virtual IRecordDb<IMonster> Eamon.Game.Plugin.Engine.MDB
getset

◆ MinGoldValue

virtual long Eamon.Game.Plugin.Engine.MinGoldValue = -99999
getprotected set

◆ MinWeaponComplexity

virtual long Eamon.Game.Plugin.Engine.MinWeaponComplexity = -50
getprotected set

◆ ModAuthorLen

virtual int Eamon.Game.Plugin.Engine.ModAuthorLen = 40
getprotected set

◆ MODDB

virtual IRecordDb<IModule> Eamon.Game.Plugin.Engine.MODDB
getset

◆ ModDescLen

virtual int Eamon.Game.Plugin.Engine.ModDescLen = 256
getprotected set

◆ ModNameLen

virtual int Eamon.Game.Plugin.Engine.ModNameLen = 40
getprotected set

◆ ModSerialNumLen

virtual int Eamon.Game.Plugin.Engine.ModSerialNumLen = 3
getprotected set

◆ ModVolLabelLen

virtual int Eamon.Game.Plugin.Engine.ModVolLabelLen = 7
getprotected set

◆ MonDescLen

virtual int Eamon.Game.Plugin.Engine.MonDescLen = 256
getprotected set

◆ MonNameLen

virtual int Eamon.Game.Plugin.Engine.MonNameLen = 40
getprotected set

◆ MonStateDescLen

virtual int Eamon.Game.Plugin.Engine.MonStateDescLen = 64
getprotected set

◆ MutatePropertyCounter

virtual long Eamon.Game.Plugin.Engine.MutatePropertyCounter = 1
getset

◆ Mutex

virtual IMutex Eamon.Game.Plugin.Engine.Mutex
getset

◆ NumArtifactCategories

virtual long Eamon.Game.Plugin.Engine.NumArtifactCategories = 4
getprotected set

◆ NumArtifactCategoryFields

virtual long Eamon.Game.Plugin.Engine.NumArtifactCategoryFields = 20
getprotected set

◆ NumberStrings

virtual string [] Eamon.Game.Plugin.Engine.NumberStrings
getset

◆ NumCharacterArtifacts

virtual long Eamon.Game.Plugin.Engine.NumCharacterArtifacts
getprotected set

◆ NumCharacterWeapons

virtual long Eamon.Game.Plugin.Engine.NumCharacterWeapons = 4
getprotected set

◆ NumRecords

virtual long Eamon.Game.Plugin.Engine.NumRecords = 1000
getprotected set

◆ NumRows

virtual long Eamon.Game.Plugin.Engine.NumRows = 22
getprotected set

◆ Out

virtual ITextWriter Eamon.Game.Plugin.Engine.Out
getset

◆ ParryCodeDescs

virtual string [] Eamon.Game.Plugin.Engine.ParryCodeDescs
getset

Gets or sets an array containing the description for each ParryCode.

◆ Path

virtual IPath Eamon.Game.Plugin.Engine.Path
getset

◆ PlateMailPrice

virtual long Eamon.Game.Plugin.Engine.PlateMailPrice = 500
getprotected set

◆ PowerPrice

virtual long Eamon.Game.Plugin.Engine.PowerPrice = 100
getprotected set

◆ Preps

virtual IPrep [] Eamon.Game.Plugin.Engine.Preps
getset

◆ ProcessMutexName

virtual string Eamon.Game.Plugin.Engine.ProcessMutexName
getprotected set

◆ ProgVersion

virtual string Eamon.Game.Plugin.Engine.ProgVersion = "3.1.0"
getprotected set

◆ PronounRegexPattern

virtual string Eamon.Game.Plugin.Engine.PronounRegexPattern = @" (?:those|them|that|him|her|it) "
getprotected set

◆ PronounTokens

virtual string [] Eamon.Game.Plugin.Engine.PronounTokens
getprotected set

◆ QuickLaunchDir

virtual string Eamon.Game.Plugin.Engine.QuickLaunchDir = @"..\..\QuickLaunch"
getprotected set

◆ Rand

virtual Random Eamon.Game.Plugin.Engine.Rand
getset

◆ RDB

virtual IRecordDb<IRoom> Eamon.Game.Plugin.Engine.RDB
getset

◆ RecallPrice

virtual long Eamon.Game.Plugin.Engine.RecallPrice = 100
getprotected set

◆ RecIdepErrorFmtStr

virtual string Eamon.Game.Plugin.Engine.RecIdepErrorFmtStr = "The {0} field refers to {1} Uid {2}, {3}."
getprotected set

◆ ResolveEffectRegexPattern

virtual string Eamon.Game.Plugin.Engine.ResolveEffectRegexPattern = @"[^\*]\*[0-9]{3}|\*\*[0-9]{3}"
getprotected set

◆ ResolveUidMacroRegexPattern

virtual string Eamon.Game.Plugin.Engine.ResolveUidMacroRegexPattern = @"[^\*]\*[0-9]{3}|\*\*[0-9]{3}|[^@]@[0-9]{3}|@@[0-9]{3}"
getprotected set

◆ RevealContainerContentsFunc

virtual Action<IRoom, IMonster, IArtifact, long, bool> Eamon.Game.Plugin.Engine.RevealContainerContentsFunc
getset

◆ RevealContentArtifactList

virtual IList<IArtifact> Eamon.Game.Plugin.Engine.RevealContentArtifactList
getset

◆ RevealContentCounter

virtual long Eamon.Game.Plugin.Engine.RevealContentCounter
getset

◆ RevealContentFuncList

virtual IList<Action> Eamon.Game.Plugin.Engine.RevealContentFuncList
getset

◆ RevealContentMonster

virtual IMonster Eamon.Game.Plugin.Engine.RevealContentMonster
getset

◆ RevealContentRoom

virtual IRoom Eamon.Game.Plugin.Engine.RevealContentRoom
getset

◆ RightMargin

virtual long Eamon.Game.Plugin.Engine.RightMargin = 78
getprotected set

◆ RmDescLen

virtual int Eamon.Game.Plugin.Engine.RmDescLen = 256
getprotected set

◆ RmNameLen

virtual int Eamon.Game.Plugin.Engine.RmNameLen = 50
getprotected set

◆ RulesetVersion

virtual long? Eamon.Game.Plugin.Engine.RulesetVersion
get

◆ RulesetVersionList

virtual IList<long> Eamon.Game.Plugin.Engine.RulesetVersionList
getset

◆ RunGameEditor

virtual bool Eamon.Game.Plugin.Engine.RunGameEditor
getset

◆ SharpSerializer

virtual ISharpSerializer Eamon.Game.Plugin.Engine.SharpSerializer
getset

◆ ShieldPrice

virtual long Eamon.Game.Plugin.Engine.ShieldPrice = 50
getprotected set

◆ SpearPrice

virtual long Eamon.Game.Plugin.Engine.SpearPrice = 25
getprotected set

◆ SpeedPrice

virtual long Eamon.Game.Plugin.Engine.SpeedPrice = 4000
getprotected set

◆ Spells

virtual ISpell [] Eamon.Game.Plugin.Engine.Spells
getset

Gets or sets an array containing data for each Spell.

◆ SpellTrainingPrice

virtual long Eamon.Game.Plugin.Engine.SpellTrainingPrice = 1000
getprotected set

◆ StackTraceFile

virtual string Eamon.Game.Plugin.Engine.StackTraceFile = @".\STACKTRACE.TXT"
getprotected set

◆ StatGainPrice

virtual long Eamon.Game.Plugin.Engine.StatGainPrice = 4500
getprotected set

◆ Stats

virtual IStat [] Eamon.Game.Plugin.Engine.Stats
getset

Gets or sets an array containing data for each Stat.

◆ StatusNames

virtual string [] Eamon.Game.Plugin.Engine.StatusNames
getset

Gets or sets an array containing the name for each Status.

◆ SwordPrice

virtual long Eamon.Game.Plugin.Engine.SwordPrice = 30
getprotected set

◆ Thread

virtual IThread Eamon.Game.Plugin.Engine.Thread
getset

◆ ToughDesc

virtual string Eamon.Game.Plugin.Engine.ToughDesc
getprotected set

◆ TransferProtocol

virtual ITransferProtocol Eamon.Game.Plugin.Engine.TransferProtocol
getset

◆ UnknownName

virtual string Eamon.Game.Plugin.Engine.UnknownName
getset

◆ ValidWorkDirRegexPattern

virtual string Eamon.Game.Plugin.Engine.ValidWorkDirRegexPattern = @"^(NONE)$|^(\.)$|^(\.\.\\\.\.\\Adventures\\[a-zA-Z0-9]+)$|^(\.\.\/\.\.\/Adventures\/[a-zA-Z0-9]+)$"
getprotected set

◆ Weapons

virtual IWeapon [] Eamon.Game.Plugin.Engine.Weapons
getset

Gets or sets an array containing data for each Weapon.

◆ WeaponTrainingPrice

virtual long Eamon.Game.Plugin.Engine.WeaponTrainingPrice = 1000
getprotected set

◆ WindowHeight

virtual int Eamon.Game.Plugin.Engine.WindowHeight = 50
getprotected set

◆ WindowWidth

virtual int Eamon.Game.Plugin.Engine.WindowWidth = 80
getprotected set

◆ WorkDir

virtual string Eamon.Game.Plugin.Engine.WorkDir = ""
getset

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