Eamon CS  3.1.0
Eamon.Framework.IConfig Interface Reference

More...

Inheritance diagram for Eamon.Framework.IConfig:
Eamon.Framework.IGameBase ARuncibleCargo.Game.Config Eamon.Game.Config ARuncibleCargo.Game.Config

Public Member Functions

RetCode LoadGameDatabase (bool validate=true, bool printOutput=true)
 
RetCode SaveGameDatabase (bool printOutput=true)
 
RetCode DeleteGameState (string configFileName, bool startOver)
 
- Public Member Functions inherited from Eamon.Framework.IGameBase
void SetParentReferences ()
 
string GetPluralName (string fieldName)
 
string GetPluralName01 ()
 
string GetDecoratedName (string fieldName, ArticleType articleType, bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
string GetNoneName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
string GetArticleName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
string GetTheName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
RetCode BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)
 

Properties

bool ShowDesc [get, set]
 
bool ResolveEffects [get, set]
 
bool GenerateUids [get, set]
 
bool DeleteCharArts [get, set]
 
FieldDesc FieldDesc [get, set]
 
long WordWrapMargin [get, set]
 
string DdFilesetFileName [get, set]
 
string DdCharacterFileName [get, set]
 
string DdModuleFileName [get, set]
 
string DdRoomFileName [get, set]
 
string DdArtifactFileName [get, set]
 
string DdCharArtFileName [get, set]
 
string DdEffectFileName [get, set]
 
string DdMonsterFileName [get, set]
 
string DdHintFileName [get, set]
 
string MhWorkDir [get, set]
 
string MhFilesetFileName [get, set]
 
string MhCharacterFileName [get, set]
 
string MhCharArtFileName [get, set]
 
string MhEffectFileName [get, set]
 
string RtFilesetFileName [get, set]
 
string RtCharacterFileName [get, set]
 
string RtModuleFileName [get, set]
 
string RtRoomFileName [get, set]
 
string RtArtifactFileName [get, set]
 
string RtCharArtFileName [get, set]
 
string RtEffectFileName [get, set]
 
string RtMonsterFileName [get, set]
 
string RtHintFileName [get, set]
 
string RtGameStateFileName [get, set]
 
bool DdEditingFilesets [get, set]
 
bool DdEditingCharacters [get, set]
 
bool DdEditingModules [get, set]
 
bool DdEditingRooms [get, set]
 
bool DdEditingArtifacts [get, set]
 
bool DdEditingCharArts [get, set]
 
bool DdEditingEffects [get, set]
 
bool DdEditingMonsters [get, set]
 
bool DdEditingHints [get, set]
 
- Properties inherited from Eamon.Framework.IGameBase
long Uid [get, set]
 Gets or sets a unique Id that distinguishes this Record from others of its type. More...
 
string Name [get, set]
 Gets or sets the name of this Record as shown in various lists or the Record's full description. More...
 
string Desc [get, set]
 Gets or sets the detailed description of this Record shown when the Record is first Seen or later examined. More...
 
string[] Synonyms [get, set]
 Gets or sets a string array containing Name synonyms for this Record (may be null). More...
 
bool Seen [get, set]
 Gets or sets a value indicating whether this Record has been seen by the player character. More...
 
bool Moved [get, set]
 Gets or sets a value indicating whether this Record has been moved from its original Location. More...
 
ArticleType ArticleType [get, set]
 Gets or sets a value indicating how this Record's Name is prefixed to produce its listed Name. More...
 
string ParserMatchName [get, set]
 Gets or sets the name or synonym of this Record matched in the FilterRecordList method. More...
 

Detailed Description

Member Function Documentation

◆ DeleteGameState()

RetCode Eamon.Framework.IConfig.DeleteGameState ( string  configFileName,
bool  startOver 
)

Parameters
configFileName
startOver
Returns

Implemented in Eamon.Game.Config, and ARuncibleCargo.Game.Config.

◆ LoadGameDatabase()

RetCode Eamon.Framework.IConfig.LoadGameDatabase ( bool  validate = true,
bool  printOutput = true 
)

Parameters
validate
printOutput
Returns

Implemented in Eamon.Game.Config.

◆ SaveGameDatabase()

RetCode Eamon.Framework.IConfig.SaveGameDatabase ( bool  printOutput = true)

Parameters
printOutput
Returns

Implemented in Eamon.Game.Config.

Property Documentation

◆ DdArtifactFileName

string Eamon.Framework.IConfig.DdArtifactFileName
getset

◆ DdCharacterFileName

string Eamon.Framework.IConfig.DdCharacterFileName
getset

◆ DdCharArtFileName

string Eamon.Framework.IConfig.DdCharArtFileName
getset

◆ DdEditingArtifacts

bool Eamon.Framework.IConfig.DdEditingArtifacts
getset

◆ DdEditingCharacters

bool Eamon.Framework.IConfig.DdEditingCharacters
getset

◆ DdEditingCharArts

bool Eamon.Framework.IConfig.DdEditingCharArts
getset

◆ DdEditingEffects

bool Eamon.Framework.IConfig.DdEditingEffects
getset

◆ DdEditingFilesets

bool Eamon.Framework.IConfig.DdEditingFilesets
getset

◆ DdEditingHints

bool Eamon.Framework.IConfig.DdEditingHints
getset

◆ DdEditingModules

bool Eamon.Framework.IConfig.DdEditingModules
getset

◆ DdEditingMonsters

bool Eamon.Framework.IConfig.DdEditingMonsters
getset

◆ DdEditingRooms

bool Eamon.Framework.IConfig.DdEditingRooms
getset

◆ DdEffectFileName

string Eamon.Framework.IConfig.DdEffectFileName
getset

◆ DdFilesetFileName

string Eamon.Framework.IConfig.DdFilesetFileName
getset

◆ DdHintFileName

string Eamon.Framework.IConfig.DdHintFileName
getset

◆ DdModuleFileName

string Eamon.Framework.IConfig.DdModuleFileName
getset

◆ DdMonsterFileName

string Eamon.Framework.IConfig.DdMonsterFileName
getset

◆ DdRoomFileName

string Eamon.Framework.IConfig.DdRoomFileName
getset

◆ DeleteCharArts

bool Eamon.Framework.IConfig.DeleteCharArts
getset

◆ FieldDesc

FieldDesc Eamon.Framework.IConfig.FieldDesc
getset

◆ GenerateUids

bool Eamon.Framework.IConfig.GenerateUids
getset

◆ MhCharacterFileName

string Eamon.Framework.IConfig.MhCharacterFileName
getset

◆ MhCharArtFileName

string Eamon.Framework.IConfig.MhCharArtFileName
getset

◆ MhEffectFileName

string Eamon.Framework.IConfig.MhEffectFileName
getset

◆ MhFilesetFileName

string Eamon.Framework.IConfig.MhFilesetFileName
getset

◆ MhWorkDir

string Eamon.Framework.IConfig.MhWorkDir
getset

◆ ResolveEffects

bool Eamon.Framework.IConfig.ResolveEffects
getset

◆ RtArtifactFileName

string Eamon.Framework.IConfig.RtArtifactFileName
getset

◆ RtCharacterFileName

string Eamon.Framework.IConfig.RtCharacterFileName
getset

◆ RtCharArtFileName

string Eamon.Framework.IConfig.RtCharArtFileName
getset

◆ RtEffectFileName

string Eamon.Framework.IConfig.RtEffectFileName
getset

◆ RtFilesetFileName

string Eamon.Framework.IConfig.RtFilesetFileName
getset

◆ RtGameStateFileName

string Eamon.Framework.IConfig.RtGameStateFileName
getset

◆ RtHintFileName

string Eamon.Framework.IConfig.RtHintFileName
getset

◆ RtModuleFileName

string Eamon.Framework.IConfig.RtModuleFileName
getset

◆ RtMonsterFileName

string Eamon.Framework.IConfig.RtMonsterFileName
getset

◆ RtRoomFileName

string Eamon.Framework.IConfig.RtRoomFileName
getset

◆ ShowDesc

bool Eamon.Framework.IConfig.ShowDesc
getset

◆ WordWrapMargin

long Eamon.Framework.IConfig.WordWrapMargin
getset


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