Eamon CS  3.1.0
Public Member Functions | Properties | List of all members
Firestorm.Framework.Plugin.IEngine Interface Reference

More...

Inheritance diagram for Firestorm.Framework.Plugin.IEngine:
EamonRT.Framework.Plugin.IEngine EamonDD.Framework.Plugin.IEngine Eamon.Framework.Plugin.IEngine Firestorm.Game.Plugin.Engine

Public Member Functions

void PrintPebblesLeft (IArtifact artifact)
 
void PrintHealingHerbsLeft (IArtifact artifact)
 
long GetGU (long index)
 
string GetRM (long index)
 
long GetRN (long index)
 
- Public Member Functions inherited from EamonRT.Framework.Plugin.IEngine
void PrintPlayerRoom (IRoom room)
 
void PrintToWhom ()
 
void PrintFromWhom ()
 
void PrintVerbWhoOrWhat (ICommand command)
 
void PrintVerbPrepWhoOrWhat (ICommand command)
 
void PrintFromPrepWhat (ICommand command)
 
void PrintPutObjPrepWhat (ICommand command, IArtifact artifact)
 
void PrintUseObjOnWhoOrWhat (IArtifact artifact)
 
void PrintWhamHitObj (IArtifact artifact)
 
void PrintMonsterAlive (IArtifact artifact)
 
void PrintLightOut (IArtifact artifact)
 
void PrintDeadBodyComesToLife (IArtifact artifact)
 
void PrintArtifactVanishes (IArtifact artifact)
 
void PrintArtifactBreaks (IRoom room, IMonster monster, IArtifact artifact, bool prependNewLine=false)
 
void PrintEnterExtinguishLightChoice (IArtifact artifact)
 
void PrintArtifactIsWorth (IArtifact artifact, long goldAmount)
 
void PrintEnemiesNearby ()
 
void PrintNothingHappens ()
 
void PrintFullDesc (IArtifact artifact, bool showName, bool showVerboseName)
 
void PrintMonsterCantFindExit (IMonster monster, IRoom room, string monsterName, bool isPlural, bool fleeing)
 
void PrintMonsterMembersExitRoom (IMonster monster, IRoom room, string monsterName, bool isPlural, bool fleeing)
 
void PrintMonsterExitsRoom (IMonster monster, IRoom room, string monsterName, bool isPlural, bool fleeing, Direction direction)
 
void PrintMonsterEntersRoom (IMonster monster, IRoom room, string monsterName, bool isPlural, bool fleeing, Direction direction)
 
void PrintMonsterGetsAngry (IMonster monster, bool printFinalNewLine=true)
 
void PrintMonsterEmotes (IMonster monster, bool friendSmile=true)
 
void PrintFullDesc (IMonster monster, bool showName, bool showVerboseName)
 
void PrintHealthImproves (IMonster monster)
 
void PrintHealthStatus (IMonster monster, bool includeUninjuredGroupMonsters)
 
void PrintDoesntHaveIt (IMonster monster)
 
void PrintTooManyWeapons ()
 
void PrintDeliverGoods ()
 
void PrintYourWeaponsAre ()
 
void PrintEnterWeaponToSell ()
 
void PrintAllWoundsHealed ()
 
void PrintYouHavePerished ()
 
void PrintRestoreSavedGame ()
 
void PrintStartOver ()
 
void PrintAcceptDeath ()
 
void PrintEnterDeadMenuChoice ()
 
void PrintReallyWantToStartOver ()
 
void PrintReallyWantToAcceptDeath ()
 
void PrintWakingUpMonsters ()
 
void PrintBaseProgramVersion ()
 
void PrintWelcomeToEamonCS ()
 
void PrintWelcomeBack ()
 
void PrintEnterSeeIntroStoryChoice ()
 
void PrintEnterWeaponNumberChoice ()
 
void PrintNoIntroStory ()
 
void PrintSavedGamesDeleted ()
 
void PrintRestartGameUsingResume ()
 
void PrintMemorialService ()
 
void PrintSavedGames ()
 
void PrintSaveSlot (long saveSlot, string saveName, bool printFinalNewLine=false)
 
void PrintQuickSave (long saveSlot, string saveName)
 
void PrintUsingSlotInstead (long saveSlot)
 
void PrintEnterSaveSlotChoice (long numMenuItems)
 
void PrintEnterRestoreSlotChoice (long numMenuItems)
 
void PrintChangingHim (string himStr)
 
void PrintChangingHer (string herStr)
 
void PrintChangingIt (string itStr)
 
void PrintChangingThem (string themStr)
 
void PrintDiscardMessage (string inputStr)
 
void PrintGoodsPayment (bool goodsExist, long goldAmount)
 
void PrintMacroReplacedPagedString (string str, StringBuilder buf)
 
void BuildRevealContentsListDescString (IMonster monster, IArtifact artifact, IList< IArtifact > revealContentsList, ContainerType containerType, bool showCharOwned, IRecordNameListArgs recordNameListArgs=null)
 
long WeaponPowerCompare (IArtifact artifact1, IArtifact artifact2)
 
long WeaponPowerCompare (long artifactUid1, long artifactUid2)
 
IArtifact GetMostPowerfulWeapon (IList< IArtifact > artifactList)
 
long GetMostPowerfulWeaponUid (IList< IArtifact > artifactList)
 
void EnforceCharMonsterWeightLimits (IRoom room=null, bool printOutput=false)
 
void NormalizeArtifactValuesAndWeights ()
 
void AddUniqueCharsToArtifactAndMonsterNames ()
 
void AddMissingDescs ()
 
void InitSaArray ()
 
void CreateCommands ()
 
void InitRooms ()
 
void InitArtifacts ()
 
void InitMonsters ()
 
void InitMonsterScaledHardinessValues ()
 
void ConvertArtifactToCharArtifact (IArtifact artifact, IArtifactCategory ac)
 
IMonster ConvertArtifactToMonster (IArtifact artifact, Action< IMonster > initialize=null, bool addToDatabase=false)
 
void ConvertCharacterToMonster ()
 
void ConvertMonsterToCharacter (IMonster monster, IList< IArtifact > weaponList)
 
void ResetMonsterStats (IMonster monster)
 
void SetArmorClass ()
 
void ConvertToCarriedInventory (IList< IArtifact > weaponList)
 
void SellExcessWeapons (IList< IArtifact > weaponList)
 
void SellInventoryToMerchant (bool sellInventory=true)
 
void DeadMenu (bool printLineSep, ref bool restoreGame)
 
void LightOut (IArtifact artifact)
 
void MonsterGetsAggravated (IMonster monster, bool printFinalNewLine=true)
 
void MonsterDies (IMonster actorMonster, IMonster dobjMonster)
 
void ProcessMonsterDeathEvents (IMonster monster)
 
string GetMonsterWeaponName (IMonster monster)
 
void RevealDisguisedMonster (IRoom room, IArtifact artifact)
 
void RevealEmbeddedArtifact (IRoom room, IArtifact artifact)
 
void RevealContainerContents (IRoom room, IMonster monster, IArtifact artifact, long location, bool printOutput)
 
void RevealContainerContents02 (IRoom room, IMonster monster, IArtifact artifact, long location, ContainerType[] containerTypes, IList< string > containerContentsList=null)
 
IArtifact GetBlockedDirectionArtifact (long ro, long r2, Direction dir)
 
ICommand GetCommandUsingToken (IMonster monster, string token, bool synonymMatch=true, bool partialMatch=true)
 
void CheckDoor (IRoom room, IArtifact artifact, ref bool found, ref long roomUid)
 
void CheckNumberOfExits (IRoom room, IMonster monster, bool fleeing, ref long numExits)
 
void GetRandomMoveDirection (IRoom room, IMonster monster, bool fleeing, ref Direction direction, ref bool found, ref long roomUid)
 
void GetRandomMoveDirection (IRoom room, IMonster monster, bool fleeing, ref Direction direction)
 
void MoveMonsterToRandomAdjacentRoom (IRoom room, IMonster monster, bool fleeing, bool pauseCombat, bool printOutput=true)
 
IList< IMonster > GetRandomMonsterList (long numMonsters, params Func< IMonster, bool >[] whereClauseFuncs)
 
IList< IGameBase > FilterRecordList (IList< IGameBase > recordList, string name)
 
IList< IArtifact > GetReadyableWeaponList (IMonster monster)
 
IList< IMonster > GetEmotingMonsterList (IRoom room, IMonster monster, bool friendSmile=true)
 
IList< IArtifact > BuildLoopWeaponArtifactList (IMonster monster)
 
IList< IArtifact > GetImportedPlayerInventory ()
 Gets the original carried/worn inventory brought by the player into the game. More...
 
void HideImportedPlayerInventory ()
 Hides the original carried/worn inventory brought by the player into the game by moving each Artifact into Limbo. More...
 
void RestoreImportedPlayerInventory ()
 Restores the original carried/worn inventory brought by the player into the game by moving each Artifact back to its initial location. More...
 
RetCode BuildCommandList (IList< ICommand > commands, CommandType cmdType, StringBuilder buf, ref bool newSeen)
 
StringBuilder NormalizePlayerInput (StringBuilder buf)
 
StringBuilder ReplacePrepositions (StringBuilder buf)
 
bool IsValidRandomMoveDirection (long oldRoomUid, long newRoomUid)
 
bool IsQuotedStringCommand (ICommand command)
 
bool ResurrectDeadBodies (IRoom room, params Func< IArtifact, bool >[] whereClauseFuncs)
 
bool MakeArtifactsVanish (IRoom room, params Func< IArtifact, bool >[] whereClauseFuncs)
 
bool SaveThrow (Stat stat, long bonus=0)
 
void DamageWeaponsAndArmor (IRoom room, IMonster monster, long damage=1, bool recurse=false)
 
void InjurePartyAndDamageEquipment (IInjureAndDamageArgs injureAndDamageArgs, ref bool gotoCleanup)
 
void CheckActionList (IList< Action > actionList)
 
void CheckPlayerSkillGains ()
 
void CheckRevealContainerContents ()
 
void CheckToProcessActionLists ()
 
void CheckToExtinguishLightSource ()
 
void PauseCombat ()
 
void TransportRoomContentsBetweenRooms (IRoom oldRoom, IRoom newRoom, bool includeEmbedded=true)
 
void TransportPlayerBetweenRooms (IRoom oldRoom, IRoom newRoom, IEffect effect)
 
void CreateArtifactSynonyms (long artifactUid, params string[] synonyms)
 
void CreateMonsterSynonyms (long monsterUid, params string[] synonyms)
 
void GetOddsToHit (IMonster actorMonster, IMonster dobjMonster, IArtifactCategory ac, long af, ref long oddsToHit)
 
void CreateInitialState (bool printLineSep)
 
void MoveMonsters (params Func< IMonster, bool >[] whereClauseFuncs)
 
void RtProcessArgv (bool secondPass, ref bool nlFlag)
 
- Public Member Functions inherited from EamonDD.Framework.Plugin.IEngine
bool IsAdventureFilesetLoaded ()
 
bool IsCharacterInventoryLoaded ()
 
void DdProcessArgv (bool secondPass, ref bool ddfnFlag, ref bool nlFlag)
 
- Public Member Functions inherited from Eamon.Framework.Plugin.IEngine
void HandleException (Exception ex, string stackTraceFile, string errorMessage)
 
void ResolvePortabilityClassMappings ()
 
void ProcessArgv (string[] args)
 
RetCode LoadPluginClassMappings ()
 Loads the ClassMappingsDictionary with all interface to class mapping Key/Value pairs necessary to allow the currently loaded Eamon CS plugin to run. More...
 
RetCode LoadPluginClassMappings01 (Assembly plugin)
 Probes the currently executing library/plugin (Assembly) for all classes adorned with the ClassMappings attribute, pairs each class with its corresponding interface, and updates the ClassMappingsDictionary accordingly. More...
 
RetCode PushRulesetVersion (long rulesetVersion)
 
RetCode PopRulesetVersion ()
 
RetCode ClearRvStack ()
 
RetCode GetRvStackTop (ref long rvStackTop)
 
T CreateInstance< T > (Type ifaceType, Action< T > initialize=null)
 
T CreateInstance< T > (Action< T > initialize=null)
 
T CloneInstance< T > (T source)
 
bool CompareInstances< T > (T object1, T object2)
 
bool IsRulesetVersion (params long[] versions)
 
string GetPrefixedFileName (string fileName)
 
void ConvertDatafileFromXmlToDat (string fileName)
 
RetCode PushDatabase ()
 
RetCode PushDatabase (IDatabase database)
 
RetCode PopDatabase (bool freeDatabase=true)
 
RetCode GetDatabase (long index, ref IDatabase database)
 
RetCode SaveDatabase (string fileName)
 
RetCode RestoreDatabase (string fileName)
 
RetCode ClearDbStack ()
 
RetCode GetDbStackTop (ref long dbStackTop)
 
void InitSystem ()
 
void DeinitSystem ()
 
void ResetProperties (PropertyResetCode resetCode)
 
void ReplaceDatafileValues (string fileName, string[] patterns, string[] replacements)
 
void UpgradeDatafile (string fileName)
 
string Upgrade300DatafileGetCharArtFileName (string characterFileName)
 
IList< ICharArtListData > Upgrade300DatafileParseCharacters (string xmlString)
 
IArtifact Upgrade300DatafileGetCharArtifact (ICharArtListData charArtData, string propertyName, XElement element)
 
string Upgrade300DatafileStripEquipment (string xmlString)
 
IPrep GetPrep (long index)
 Gets the sentence preposition (e.g., "to", "from", "inside", etc). More...
 
string GetArticle (long index)
 Gets the sentence article (e.g., "a", "some", "the", etc). More...
 
string GetNumberString (long index)
 
string GetFieldDescName (long index)
 
string GetFieldDescName (FieldDesc fieldDesc)
 
string GetStatusName (long index)
 Gets the name for a given Status. More...
 
string GetStatusName (Status status)
 Gets the name for a given Status. More...
 
string GetClothingName (long index)
 Gets the name for a given Clothing. More...
 
string GetClothingName (Clothing clothing)
 Gets the name for a given Clothing. More...
 
string GetCombatCodeDesc (long index)
 Gets the description for a given CombatCode. More...
 
string GetCombatCodeDesc (CombatCode combatCode)
 Gets the description for a given CombatCode. More...
 
string GetParryCodeDesc (long index)
 Gets the description for a given ParryCode. More...
 
string GetParryCodeDesc (ParryCode parryCode)
 Gets the description for a given ParryCode. More...
 
string GetContainerDisplayCodeDesc (long index)
 
string GetContainerDisplayCodeDesc (ContainerDisplayCode containerDisplayCode)
 
string GetLightLevelName (long index)
 Gets the name for a given LightLevel. More...
 
string GetLightLevelName (LightLevel lightLevel)
 Gets the name for a given LightLevel. More...
 
IStat GetStat (long index)
 Gets the data for a given Stat. More...
 
IStat GetStat (Stat stat)
 Gets the data for a given Stat. More...
 
ISpell GetSpell (long index)
 Gets the data for a given Spell. More...
 
ISpell GetSpell (Spell spell)
 Gets the data for a given Spell. More...
 
IWeapon GetWeapon (long index)
 Gets the data for a given Weapon. More...
 
IWeapon GetWeapon (Weapon weapon)
 Gets the data for a given Weapon. More...
 
IArmor GetArmor (long index)
 Gets the data for a given Armor. More...
 
IArmor GetArmor (Armor armor)
 Gets the data for a given Armor. More...
 
IDirection GetDirection (long index)
 Gets the data for a given Direction. More...
 
IDirection GetDirection (Direction direction)
 Gets the data for a given Direction. More...
 
IArtifactType GetArtifactType (long index)
 Gets the data for a given ArtifactType. More...
 
IArtifactType GetArtifactType (ArtifactType artifactType)
 Gets the data for a given ArtifactType. More...
 
bool IsSuccess (RetCode rc)
 Indicates whether an operation succeeded. More...
 
bool IsFailure (RetCode rc)
 Indicates whether an operation failed. More...
 
bool IsValidPluralType (PluralType pluralType)
 Indicates whether a plural type is valid. More...
 
bool IsValidArtifactType (ArtifactType artifactType)
 Indicates whether an artifact type is valid. More...
 
bool IsValidArtifactArmor (long armor, bool includeShields=true)
 Indicates whether an armor value is valid for a wearable Artifact. More...
 
bool IsValidMonsterArmor (long armor)
 Indicates whether an armor value is valid for a Monster. More...
 
bool IsValidMonsterCourage (long courage)
 Indicates whether a courage value is valid for a Monster. More...
 
bool IsValidMonsterFriendliness (Friendliness friendliness)
 
bool IsValidMonsterFriendlinessPct (Friendliness friendliness)
 
bool IsValidDirection (Direction dir)
 
bool IsValidRoomUid01 (long roomUid)
 
bool IsValidRoomDirectionDoorUid01 (long roomUid)
 
bool IsArtifactFieldStrength (long value)
 
bool IsUnmovable (long weight)
 
bool IsUnmovable01 (long weight)
 
long GetMonsterHealthStatusIndex (long hardiness, long dmgTaken)
 
long GetWeightCarryableGronds (long hardiness)
 
long GetWeightCarryableDos (long hardiness)
 
long GetIntellectBonusPct (long intellect)
 
long GetCharmMonsterPct (long charisma)
 
long GetPluralTypeEffectUid (PluralType pluralType)
 
long GetArmorFactor (long armorUid, long shieldUid)
 
long GetCharismaFactor (long charisma)
 
long GetMonsterFriendlinessPct (Friendliness friendliness)
 
long GetArtifactFieldStrength (long value)
 
long GetMerchantAskPrice (double price, double rtio)
 
long GetMerchantBidPrice (double price, double rtio)
 
long GetMerchantAdjustedCharisma (long charisma)
 
double GetMerchantRtio (long charisma)
 
bool IsCharYOrN (char ch)
 Indicates whether a character is one of ['Y', 'N']. More...
 
bool IsCharGOrAOrN (char ch)
 Indicates whether a character is one of ['G', 'A', 'N']. More...
 
bool IsCharSOrTOrROrX (char ch)
 Indicates whether a character is one of ['S', 'T', 'R', 'X']. More...
 
bool IsCharNOrSOrEOrW (char ch)
 Indicates whether a character is one of ['N', 'S', 'E', 'W']. More...
 
bool IsChar0Or1 (char ch)
 Indicates whether a character is one of ['0', '1']. More...
 
bool IsChar0To2 (char ch)
 Indicates whether a character is one of ['0', '1', '2']. More...
 
bool IsChar0To3 (char ch)
 Indicates whether a character is one of ['0', '1', '2', '3']. More...
 
bool IsChar1To3 (char ch)
 Indicates whether a character is one of ['1', '2', '3']. More...
 
bool IsChar1To4 (char ch)
 Indicates whether a character is one of ['1', '2', '3', '4']. More...
 
bool IsCharDigit (char ch)
 Indicates whether a character is a numeric digit. More...
 
bool IsCharDigitOrX (char ch)
 Indicates whether a character is a numeric digit or 'X'. More...
 
bool IsCharPlusMinusDigit (char ch)
 Indicates whether a character is a numeric digit or one of ['+', '-']. More...
 
bool IsCharAlpha (char ch)
 Indicates whether a character is alphabetic. More...
 
bool IsCharAlphaSpace (char ch)
 Indicates whether a character is alphabetic or space. More...
 
bool IsCharAlnum (char ch)
 Indicates whether a character is alphabetic or numeric digit. More...
 
bool IsCharAlnumSpace (char ch)
 Indicates whether a character is alphabetic, numeric digit or space. More...
 
bool IsCharAlnumPeriodUnderscore (char ch)
 Indicates whether a character is alphabetic, numeric digit, period or underscore. More...
 
bool IsCharPrint (char ch)
 Indicates whether a character is printable. More...
 
bool IsCharPound (char ch)
 Indicates whether a character is '#'. More...
 
bool IsCharQuote (char ch)
 Indicates whether a character is a quote. More...
 
bool IsCharAny (char ch)
 Indicates whether a character is any character at all. More...
 
bool IsCharAnyButDquoteCommaColon (char ch)
 Indicates whether a character is any character but one of ['"', ',', ':']. More...
 
bool IsCharAnyButBackForwardSlash (char ch)
 Indicates whether a character is any character but one of ['\', '/']. More...
 
char ModifyCharToUpper (char ch)
 Given a character, produce its upper case equivalent, if any. More...
 
char ModifyCharToNullOrX (char ch)
 Given a character, produce either 'X' or '\0'. More...
 
char ModifyCharToNull (char ch)
 Given a character, produce '\0'. More...
 
Direction GetDirection (string directionName)
 
ContainerType GetContainerType (ArtifactType artifactType)
 
IConfig GetConfig ()
 
IGameState GetGameState ()
 Gets the GameState record. More...
 
IModule GetModule ()
 Gets the Module record. More...
 
void Shuffle< T > (IList< T > list)
 
T GetRandomElement< T > (T[] array, Func< long > indexFunc=null)
 
T GetNonRepeatingRandomElement< T > (IList< T > sourceList, IList< T > usedList, Action< IList< T >> shuffleFunc=null)
 
T GetNonRepeatingRandomElement01< T > (IList< T > sourceList, bool shuffle=false, Action< IList< T >> shuffleFunc=null)
 
T EvalFriendliness< T > (Friendliness friendliness, T enemyValue, T neutralValue, T friendValue)
 Evaluates the Friendliness, returning a value of type T. More...
 
T EvalGender< T > (Gender gender, T maleValue, T femaleValue, T neutralValue)
 Evaluates the Gender, returning a value of type T. More...
 
T EvalContainerType< T > (ContainerType containerType, T inValue, T onValue, T underValue, T behindValue)
 Evaluates the ContainerType, returning a value of type T. More...
 
T EvalRoomType< T > (RoomType roomType, T indoorsValue, T outdoorsValue)
 Evaluates the RoomType, returning a value of type T. More...
 
T EvalLightLevel< T > (LightLevel lightLevel, T darkValue, T lightValue)
 Evaluates the LightLevel, returning a value of type T. More...
 
T EvalPlural< T > (bool isPlural, T singularValue, T pluralValue)
 Evaluates the plural value, returning a value of type T. More...
 
string BuildPrompt (long bufSize, char fillChar, long number, string msg, string emptyVal)
 
string BuildValue (long bufSize, char fillChar, long offset, long longVal, string stringVal, string lookupMsg)
 
string WordWrap (string str, StringBuilder buf, long margin, IWordWrapArgs args, bool clearBuf=true)
 
string WordWrap (string str, StringBuilder buf, bool clearBuf=true)
 
string LineWrap (string str, StringBuilder buf, long startColumn, bool clearBuf=true)
 
string GetStringFromNumber (long num, bool addSpace, StringBuilder buf)
 
long GetNumberFromString (string str)
 
RetCode RollDice (long numDice, long numSides, ref long[] dieRolls)
 Rolls a number of dice, storing the resulting values in an array. More...
 
long RollDice (long numDice, long numSides, long modifier)
 Rolls a number of dice, returning a sum of the results. More...
 
RetCode SumHighestRolls (long[] dieRolls, long numRollsToSum, ref long result)
 Given an array of die rolls, sum the highest of them and return the result. More...
 
string Capitalize (string str)
 
void UnlinkOnFailure ()
 Deletes a set of game-related files from the filesystem. More...
 
void TruncatePluralTypeEffectDesc (PluralType pluralType, long maxSize)
 
void TruncatePluralTypeEffectDesc (IEffect effect)
 
RetCode SplitPath (string fullPath, ref string directory, ref string fileName, ref string extension, bool appendDirectorySeparatorChar=true)
 
RetCode StripPrepsAndArticles (StringBuilder buf, ref bool mySeen)
 
void PrintTitle (string title, bool inBox)
 
void PrintEffectDesc (IEffect effect, bool printFinalNewLine=true)
 
void PrintEffectDesc (long effectUid, bool printFinalNewLine=true)
 
void PrintZapDirectHit ()
 Prints the Blast spell description. More...
 
RetCode ValidateRecordsAfterDatabaseLoaded ()
 
RetCode StatDisplay (IStatDisplayArgs args)
 
RetCode GetRecordNameList (IList< IGameBase > recordList, IRecordNameListArgs args, StringBuilder buf)
 
RetCode GetRecordNameCount (IList< IGameBase > recordList, string name, bool exactMatch, ref long count)
 
RetCode ListRecords (IList< IGameBase > recordList, bool capitalize, bool showExtraInfo, StringBuilder buf)
 
RetCode ResolveUidMacros (string str, StringBuilder buf, bool resolveFuncs, bool recurse, ref long invalidUid)
 
RetCode ResolveUidMacros (string str, StringBuilder buf, bool resolveFuncs, bool recurse)
 
double GetWeaponPriceOrValue (string name, long complexity, Weapon type, long dice, long sides, long numHands, bool calcPrice, ref bool isMarcosWeapon)
 
double GetWeaponPriceOrValue (IArtifact weapon, bool calcPrice, ref bool isMarcosWeapon)
 
double GetArmorPriceOrValue (Armor armor, bool calcPrice, ref bool isMarcosArmor)
 
void AppendFieldDesc (FieldDesc fieldDesc, StringBuilder buf, StringBuilder fullDesc, StringBuilder briefDesc)
 
void AppendFieldDesc (FieldDesc fieldDesc, StringBuilder buf, string fullDesc, string briefDesc)
 
IList< IArtifact > GetArtifactList (params Func< IArtifact, bool >[] whereClauseFuncs)
 
IList< IMonster > GetMonsterList (params Func< IMonster, bool >[] whereClauseFuncs)
 
IList< IGameBase > GetRecordList (params Func< IGameBase, bool >[] whereClauseFuncs)
 
IList< IMonster > GetFriendlyMonsterList (IMonster monster)
 
IList< IMonster > GetHostileMonsterList (IMonster monster)
 
IArtifact GetNthArtifact (IList< IArtifact > artifactList, long which, Func< IArtifact, bool > whereClauseFunc)
 
IMonster GetNthMonster (IList< IMonster > monsterList, long which, Func< IMonster, bool > whereClauseFunc)
 
IGameBase GetNthRecord (IList< IGameBase > recordList, long which, Func< IGameBase, bool > whereClauseFunc)
 
bool StripUniqueCharsFromRecordNames (IList< IGameBase > recordList)
 
bool AddUniqueCharsToRecordNames (IList< IGameBase > recordList)
 
bool SwapGreaterArmorUidWithLesserShieldUid (ICharacter character)
 
bool ShouldSleepAfterInput (StringBuilder buf, char inputFillChar)
 
void ConvertWeaponToGoldOrTreasure (IArtifact artifact, bool convertToGold)
 
void ConvertTreasureToContainer (IArtifact artifact, ContainerType containerType=ContainerType.In)
 
void ConvertContainerToTreasure (IArtifact artifact, ContainerType containerType=ContainerType.In)
 

Properties

new StringBuilder Buf [get, set]
 
new StringBuilder Buf01 [get, set]
 
long[] GU [get, set]
 
string[] RM [get, set]
 
long[] RN [get, set]
 
long SecretBonus [get]
 
bool RestoreGame [get, set]
 
- Properties inherited from EamonRT.Framework.Plugin.IEngine
new StringBuilder Buf [get, set]
 
StringBuilder Buf01 [get, set]
 
string PageSep [get]
 Gets the page separator sequence used to delineate the pages of a multi-page text block. More...
 
IList< ICommand > CommandList [get, set]
 
IList< ICommand > LastCommandList [get, set]
 
IList< Action > MiscEventFuncList [get, set]
 
IList< Action > MiscEventFuncList02 [get, set]
 
IList< Action > MiscEventFuncList03 [get, set]
 
IList< Action > SkillIncreaseFuncList [get, set]
 
IList< long > LoopMonsterUidList [get, set]
 
long ActionListCounter [get, set]
 
long PauseCombatActionsCounter [get, set]
 Gets or sets a value that tracks the number of Monster actions performed during a combat round. More...
 
long LoopMonsterUidListIndex [get, set]
 
long LoopMonsterUid [get, set]
 
long LoopMemberNumber [get, set]
 
long LoopAttackNumber [get, set]
 
long LoopGroupCount [get, set]
 
long LoopFailedMoveMemberCount [get, set]
 
IMonster LoopLastDobjMonster [get, set]
 
IIntroStory IntroStory [get, set]
 
IMainLoop MainLoop [get, set]
 
ISentenceParser SentenceParser [get, set]
 
ICommandParser CommandParser [get, set]
 
IState InitialState [get, set]
 
IState CurrState [get, set]
 
IState NextState [get, set]
 
IGameState GameState [get, set]
 
ICharacter Character [get, set]
 
ExitType ExitType [get, set]
 
string CommandPrompt [get, set]
 Gets the command prompt presented to the player when requesting input. More...
 
ICommand CurrCommand [get]
 
ICommand NextCommand [get]
 
ICommand LastCommand [get]
 
bool CommandPromptSeen [get, set]
 
bool ShouldPreTurnProcess [get, set]
 Gets or sets a value indicating whether "pre-turn" processing should be done at the beginning of a new round. More...
 
bool PauseCombatAfterSkillGains [get, set]
 
bool UseRevealContentMonsterTheName [get, set]
 
bool RtSuppressPostInputSleep [get, set]
 
bool PlayerMoved [get, set]
 
bool GameRunning [get]
 Indicates whether the EamonRT main game loop is currently running. More...
 
bool DeleteGameStateAfterLoop [get]
 
bool StartOver [get]
 
bool ErrorExit [get]
 
bool ExportCharacterGoToMainHall [get]
 
bool ExportCharacter [get]
 
bool DeleteCharacter [get]
 
long StartRoom [get, set]
 Gets or sets the RoomUid of the player character's initial location at the beginning of the game. More...
 
long NumSaveSlots [get, set]
 Gets or sets the number of Saved Game slots available for use in the game. More...
 
long ScaledHardinessUnarmedMaxDamage [get, set]
 
double ScaledHardinessMaxDamageDivisor [get, set]
 
bool EnforceMonsterWeightLimits [get, set]
 Indicates whether non-player character Monsters should have carried inventory weight limits. More...
 
bool UseMonsterScaledHardinessValues [get, set]
 
bool AutoDisplayUnseenArtifactDescs [get, set]
 
bool ExposeContainersRecursively [get, set]
 
PoundCharPolicy PoundCharPolicy [get, set]
 The game engine policy for appending pound characters ('#') to Artifacts with duplicate names. More...
 
PercentCharPolicy PercentCharPolicy [get, set]
 The game engine policy for appending percent characters ('') to Monsters with duplicate names. More...
 
- Properties inherited from EamonDD.Framework.Plugin.IEngine
new StringBuilder Buf [get, set]
 
string[] Argv [get, set]
 
long WordWrapCurrColumn [get, set]
 
char WordWrapLastChar [get, set]
 
string ConfigFileName [get, set]
 
IDdMenu DdMenu [get, set]
 
IMenu Menu [get, set]
 
IModule Module [get, set]
 
IConfig Config [get, set]
 
bool BortCommand [get, set]
 
bool DdSuppressPostInputSleep [get, set]
 
bool ConfigsModified [get, set]
 
bool FilesetsModified [get, set]
 
bool CharactersModified [get, set]
 
bool ModulesModified [get, set]
 
bool RoomsModified [get, set]
 
bool ArtifactsModified [get, set]
 
bool CharArtsModified [get, set]
 
bool EffectsModified [get, set]
 
bool MonstersModified [get, set]
 
bool HintsModified [get, set]
 
- Properties inherited from Eamon.Framework.Plugin.IEngine
StringBuilder Buf [get, set]
 
string[] CommandSepTokens [get]
 
string[] PronounTokens [get]
 
string ToughDesc [get]
 
string CourageDesc [get]
 
int ArtNameLen [get]
 Gets the maximum length of an Artifact Name. More...
 
int ArtStateDescLen [get]
 Gets the maximum length of an Artifact StateDesc. More...
 
int ArtDescLen [get]
 Gets the maximum length of an Artifact Desc. More...
 
int CharNameLen [get]
 Gets the maximum length of a Character Name. More...
 
int EffDescLen [get]
 Gets the maximum length of an Effect Desc. More...
 
int FsNameLen [get]
 Gets the maximum length of a Fileset Name. More...
 
int FsFileNameLen [get]
 Gets the maximum length of a Fileset file name (e.g., PluginFileName, etc). More...
 
int HntQuestionLen [get]
 Gets the maximum length of a Hint Question. More...
 
int HntAnswerLen [get]
 Gets the maximum length of a Hint Answer. More...
 
int ModNameLen [get]
 Gets the maximum length of a Module Name. More...
 
int ModDescLen [get]
 Gets the maximum length of a Module Desc. More...
 
int ModAuthorLen [get]
 Gets the maximum length of a Module Author. More...
 
int ModVolLabelLen [get]
 Gets the maximum length of a Module VolLabel. More...
 
int ModSerialNumLen [get]
 Gets the maximum length of a Module SerialNum. More...
 
int MonNameLen [get]
 Gets the maximum length of a Monster Name. More...
 
int MonStateDescLen [get]
 Gets the maximum length of a Monster StateDesc. More...
 
int MonDescLen [get]
 Gets the maximum length of a Monster Desc. More...
 
int RmNameLen [get]
 Gets the maximum length of a Room Name. More...
 
int RmDescLen [get]
 Gets the maximum length of a Room Desc. More...
 
long AxePrice [get]
 Gets the base price, in gold pieces, of an axe sold by Marcos Cavielli. More...
 
long BowPrice [get]
 Gets the base price, in gold pieces, of a bow sold by Marcos Cavielli. More...
 
long MacePrice [get]
 Gets the base price, in gold pieces, of a mace sold by Marcos Cavielli. More...
 
long SpearPrice [get]
 Gets the base price, in gold pieces, of a spear sold by Marcos Cavielli. More...
 
long SwordPrice [get]
 Gets the base price, in gold pieces, of a sword sold by Marcos Cavielli. More...
 
long ShieldPrice [get]
 Gets the base price, in gold pieces, of a shield sold by Marcos Cavielli. More...
 
long LeatherArmorPrice [get]
 Gets the base price, in gold pieces, of some leather armor sold by Marcos Cavielli. More...
 
long ChainMailPrice [get]
 Gets the base price, in gold pieces, of some chain mail armor sold by Marcos Cavielli. More...
 
long PlateMailPrice [get]
 Gets the base price, in gold pieces, of some plate mail armor sold by Marcos Cavielli. More...
 
long BlastPrice [get]
 Gets the base price, in gold pieces, of the Blast spell sold by Hokas Tokas. More...
 
long HealPrice [get]
 Gets the base price, in gold pieces, of the Heal spell sold by Hokas Tokas. More...
 
long SpeedPrice [get]
 Gets the base price, in gold pieces, of the Speed spell sold by Hokas Tokas. More...
 
long PowerPrice [get]
 Gets the base price, in gold pieces, of the Power spell sold by Hokas Tokas. More...
 
long RecallPrice [get]
 Gets the base price, in gold pieces, of being recalled from an adventure by a local wizard, as noted by the Burly Irishman at the Front Desk. More...
 
long StatGainPrice [get]
 Gets the base price, in gold pieces, of having a Stat boosted by the Good Witch. More...
 
long WeaponTrainingPrice [get]
 Gets the base price, in gold pieces, of having a weapon training session with Don Diego. More...
 
long ArmorTrainingPrice [get]
 Gets the base price, in gold pieces, of having an armor training session with the giant. More...
 
long SpellTrainingPrice [get]
 Gets the base price, in gold pieces, of having a spell training session with the licensed wizard. More...
 
long InfoBoothPrice [get]
 Gets the base price, in gold pieces, of purchasing services from the practice area info booth. More...
 
long FountainPrice [get]
 Gets the base price, in gold pieces, of interacting with the village fountain statue. More...
 
long NumRecords [get]
 Gets the maximum number of Records allowed in a database table. More...
 
long NumCharacterWeapons [get]
 Gets the maximum number of weapon Artifacts allowed in a Character's inventory. More...
 
long NumCharacterArtifacts [get]
 Gets the maximum number of Artifacts allowed in a Character's inventory. More...
 
long NumArtifactCategories [get]
 Gets the maximum number of Categories assignable to a single Artifact. More...
 
long NumArtifactCategoryFields [get]
 
int BufSize [get]
 Gets the default size for large, discardable StringBuilders created during system processing. More...
 
int BufSize01 [get]
 Gets the default size for small, discardable StringBuilders created during system processing. More...
 
int BufSize02 [get]
 Gets the default size for tiny, discardable StringBuilders created during system processing. More...
 
int BufSize03 [get]
 Gets the default size for medium, discardable StringBuilders created during system processing. More...
 
string ResolveEffectRegexPattern [get]
 
string ResolveUidMacroRegexPattern [get]
 
string ValidWorkDirRegexPattern [get]
 
string CommandSepRegexPattern [get]
 
string PronounRegexPattern [get]
 
string EverythingRegexPattern [get]
 
string ExceptRegexPattern [get]
 
string RecIdepErrorFmtStr [get]
 Gets the format string used to produce error messages during Record interdependency checking. More...
 
string AndroidAdventuresDir [get]
 Gets the Adventures directory path on Android platforms, relative to the working directory. More...
 
string AdventuresDir [get]
 Gets the Adventures directory path on non-Android platforms, relative to the working directory. More...
 
string QuickLaunchDir [get]
 Gets the QuickLaunch directory path, relative to the working directory. More...
 
string DefaultWorkDir [get]
 
string ProcessMutexName [get]
 Gets the name of the Mutex used to synchronize Eamon CS processes. More...
 
string EamonCSSlnFile [get]
 Gets the Eamon CS Solution path and file name, relative to the working directory. More...
 
string StackTraceFile [get]
 Gets the relative path and name of the error file dumped when an unexpected system shutdown occurs. More...
 
string GlobalLaunchParametersFile [get]
 Gets the Global Launch Parameters path and file name, relative to the working directory. More...
 
string ProgVersion [get]
 Gets the Eamon CS system version displayed on program startup. More...
 
long InfiniteDrinkableEdible [get]
 Gets a value indicating whether a Drinkable or Edible Artifact has infinite quantity. More...
 
long DirectionExit [get]
 Gets the Room Uid constant representing an exit from a game. More...
 
long LimboLocation [get]
 Gets the Room Uid constant representing "limbo". More...
 
long MinWeaponComplexity [get]
 Gets the minimum allowed weapon Complexity. More...
 
long MaxWeaponComplexity [get]
 Gets the maximum allowed weapon Complexity. More...
 
long MinGoldValue [get]
 Gets the minimum amount of gold the player character can carry or hold in the bank. More...
 
long MaxGoldValue [get]
 Gets the maximum amount of gold the player character can carry or hold in the bank. More...
 
long MaxPathLen [get]
 
long MaxRecursionLevel [get]
 Gets the maximum recursion level for macro replacement. More...
 
ulong DefaultArtExtAttributes [get]
 
ulong DefaultMonExtAttributes [get]
 
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 EnableNegativeArtifactValues [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< IArtifact > RevealContentArtifactList [get, set]
 
IList< Action > RevealContentFuncList [get, set]
 
long RevealContentCounter [get, set]
 
string LineSep [get, set]
 
bool LineWrapUserInput [get, set]
 
IRecordDb< IConfig > CFGDB [get, set]
 Gets or sets the Config database quick-accessor. More...
 
IRecordDb< IFileset > FSDB [get, set]
 Gets or sets the Fileset database quick-accessor. More...
 
IRecordDb< ICharacter > CHRDB [get, set]
 Gets or sets the Character database quick-accessor. More...
 
IRecordDb< IModule > MODDB [get, set]
 Gets or sets the Module database quick-accessor. More...
 
IRecordDb< IRoom > RDB [get, set]
 Gets or sets the Room database quick-accessor. More...
 
IRecordDb< IArtifact > ADB [get, set]
 Gets or sets the Artifact database quick-accessor. More...
 
IRecordDb< IEffect > EDB [get, set]
 Gets or sets the Effect database quick-accessor. More...
 
IRecordDb< IMonster > MDB [get, set]
 Gets or sets the Monster database quick-accessor. More...
 
IRecordDb< IHint > HDB [get, set]
 Gets or sets the Hint database quick-accessor. More...
 
IRecordDb< IGameState > GSDB [get, set]
 Gets or sets the GameState database quick-accessor. More...
 
IDictionary< long, Func< string > > MacroFuncs [get, set]
 Gets or sets a collection of functions used to resolve macros embedded in Desc, ArtifactStateDesc and Monster StateDesc properties. More...
 
Action< IRoom, IMonster, IArtifact, long, bool > RevealContainerContentsFunc [get, set]
 
IPrep[] Preps [get, set]
 Gets or sets an array of sentence prepositions (e.g., "to", "from", "inside", etc). More...
 
string[] Articles [get, set]
 Gets or sets an array of sentence articles (e.g., "a", "some", "the", etc). More...
 
string UnknownName [get, set]
 Gets or sets a generic string representing an unknown name (e.g., "???"). More...
 

Detailed Description

Member Function Documentation

◆ GetGU()

long Firestorm.Framework.Plugin.IEngine.GetGU ( long  index)

Implemented in Firestorm.Game.Plugin.Engine.

◆ GetRM()

string Firestorm.Framework.Plugin.IEngine.GetRM ( long  index)

Implemented in Firestorm.Game.Plugin.Engine.

◆ GetRN()

long Firestorm.Framework.Plugin.IEngine.GetRN ( long  index)

Implemented in Firestorm.Game.Plugin.Engine.

◆ PrintHealingHerbsLeft()

void Firestorm.Framework.Plugin.IEngine.PrintHealingHerbsLeft ( IArtifact  artifact)

Implemented in Firestorm.Game.Plugin.Engine.

◆ PrintPebblesLeft()

void Firestorm.Framework.Plugin.IEngine.PrintPebblesLeft ( IArtifact  artifact)

Implemented in Firestorm.Game.Plugin.Engine.

Property Documentation

◆ Buf

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

◆ Buf01

new StringBuilder Firestorm.Framework.Plugin.IEngine.Buf01
getset

◆ GU

long [] Firestorm.Framework.Plugin.IEngine.GU
getset

◆ RestoreGame

bool Firestorm.Framework.Plugin.IEngine.RestoreGame
getset

◆ RM

string [] Firestorm.Framework.Plugin.IEngine.RM
getset

◆ RN

long [] Firestorm.Framework.Plugin.IEngine.RN
getset

◆ SecretBonus

long Firestorm.Framework.Plugin.IEngine.SecretBonus
get
The documentation for this interface was generated from the following file: