Eamon CS  3.1.0
Eamon.Game.Config Class Reference
Inheritance diagram for Eamon.Game.Config:
Eamon.Game.GameBase Eamon.Framework.IConfig Eamon.Framework.IGameBase Eamon.Framework.IGameBase ARuncibleCargo.Game.Config

Public Member Functions

override void Dispose (bool disposing)
 
virtual int CompareTo (IConfig config)
 
virtual RetCode LoadGameDatabase (bool validate=true, bool printOutput=true)
 
virtual RetCode SaveGameDatabase (bool printOutput=true)
 
virtual RetCode DeleteGameState (string configFileName, bool startOver)
 
 Config ()
 
- Public Member Functions inherited from Eamon.Game.GameBase
void Dispose ()
 
virtual void SetParentReferences ()
 
virtual string GetPluralName (string fieldName)
 
virtual string GetPluralName01 ()
 
virtual string GetDecoratedName (string fieldName, ArticleType articleType, bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual string GetNoneName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual string GetArticleName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual string GetTheName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual RetCode BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)
 
 GameBase ()
 

Properties

virtual bool ShowDesc [get, set]
 
virtual bool ResolveEffects [get, set]
 
virtual bool GenerateUids [get, set]
 
virtual bool DeleteCharArts [get, set]
 
virtual FieldDesc FieldDesc [get, set]
 
virtual long WordWrapMargin [get, set]
 
virtual string DdFilesetFileName [get, set]
 
virtual string DdCharacterFileName [get, set]
 
virtual string DdModuleFileName [get, set]
 
virtual string DdRoomFileName [get, set]
 
virtual string DdArtifactFileName [get, set]
 
virtual string DdCharArtFileName [get, set]
 
virtual string DdEffectFileName [get, set]
 
virtual string DdMonsterFileName [get, set]
 
virtual string DdHintFileName [get, set]
 
virtual string MhWorkDir [get, set]
 
virtual string MhFilesetFileName [get, set]
 
virtual string MhCharacterFileName [get, set]
 
virtual string MhCharArtFileName [get, set]
 
virtual string MhEffectFileName [get, set]
 
virtual string RtFilesetFileName [get, set]
 
virtual string RtCharacterFileName [get, set]
 
virtual string RtModuleFileName [get, set]
 
virtual string RtRoomFileName [get, set]
 
virtual string RtArtifactFileName [get, set]
 
virtual string RtCharArtFileName [get, set]
 
virtual string RtEffectFileName [get, set]
 
virtual string RtMonsterFileName [get, set]
 
virtual string RtHintFileName [get, set]
 
virtual string RtGameStateFileName [get, set]
 
virtual bool DdEditingFilesets [get, set]
 
virtual bool DdEditingCharacters [get, set]
 
virtual bool DdEditingModules [get, set]
 
virtual bool DdEditingRooms [get, set]
 
virtual bool DdEditingArtifacts [get, set]
 
virtual bool DdEditingCharArts [get, set]
 
virtual bool DdEditingEffects [get, set]
 
virtual bool DdEditingMonsters [get, set]
 
virtual bool DdEditingHints [get, set]
 
- Properties inherited from Eamon.Game.GameBase
virtual long Uid [get, set]
 
virtual string Name [get, set]
 
virtual string Desc [get, set]
 
virtual string[] Synonyms [get, set]
 
virtual bool Seen [get, set]
 
virtual bool Moved [get, set]
 
virtual ArticleType ArticleType [get, set]
 
virtual string ParserMatchName [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...
 
- Properties inherited from Eamon.Framework.IConfig
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]
 

Constructor & Destructor Documentation

◆ Config()

Eamon.Game.Config.Config ( )

Member Function Documentation

◆ CompareTo()

virtual int Eamon.Game.Config.CompareTo ( IConfig  config)
virtual

◆ DeleteGameState()

virtual RetCode Eamon.Game.Config.DeleteGameState ( string  configFileName,
bool  startOver 
)
virtual

Parameters
configFileName
startOver
Returns

Implements Eamon.Framework.IConfig.

Reimplemented in ARuncibleCargo.Game.Config.

◆ Dispose()

override void Eamon.Game.Config.Dispose ( bool  disposing)
virtual

Implements Eamon.Game.GameBase.

◆ LoadGameDatabase()

virtual RetCode Eamon.Game.Config.LoadGameDatabase ( bool  validate = true,
bool  printOutput = true 
)
virtual

Parameters
validate
printOutput
Returns

Implements Eamon.Framework.IConfig.

◆ SaveGameDatabase()

virtual RetCode Eamon.Game.Config.SaveGameDatabase ( bool  printOutput = true)
virtual

Parameters
printOutput
Returns

Implements Eamon.Framework.IConfig.

Property Documentation

◆ DdArtifactFileName

virtual string Eamon.Game.Config.DdArtifactFileName
getset

◆ DdCharacterFileName

virtual string Eamon.Game.Config.DdCharacterFileName
getset

◆ DdCharArtFileName

virtual string Eamon.Game.Config.DdCharArtFileName
getset

◆ DdEditingArtifacts

virtual bool Eamon.Game.Config.DdEditingArtifacts
getset

◆ DdEditingCharacters

virtual bool Eamon.Game.Config.DdEditingCharacters
getset

◆ DdEditingCharArts

virtual bool Eamon.Game.Config.DdEditingCharArts
getset

◆ DdEditingEffects

virtual bool Eamon.Game.Config.DdEditingEffects
getset

◆ DdEditingFilesets

virtual bool Eamon.Game.Config.DdEditingFilesets
getset

◆ DdEditingHints

virtual bool Eamon.Game.Config.DdEditingHints
getset

◆ DdEditingModules

virtual bool Eamon.Game.Config.DdEditingModules
getset

◆ DdEditingMonsters

virtual bool Eamon.Game.Config.DdEditingMonsters
getset

◆ DdEditingRooms

virtual bool Eamon.Game.Config.DdEditingRooms
getset

◆ DdEffectFileName

virtual string Eamon.Game.Config.DdEffectFileName
getset

◆ DdFilesetFileName

virtual string Eamon.Game.Config.DdFilesetFileName
getset

◆ DdHintFileName

virtual string Eamon.Game.Config.DdHintFileName
getset

◆ DdModuleFileName

virtual string Eamon.Game.Config.DdModuleFileName
getset

◆ DdMonsterFileName

virtual string Eamon.Game.Config.DdMonsterFileName
getset

◆ DdRoomFileName

virtual string Eamon.Game.Config.DdRoomFileName
getset

◆ DeleteCharArts

virtual bool Eamon.Game.Config.DeleteCharArts
getset

◆ FieldDesc

virtual FieldDesc Eamon.Game.Config.FieldDesc
getset

◆ GenerateUids

virtual bool Eamon.Game.Config.GenerateUids
getset

◆ MhCharacterFileName

virtual string Eamon.Game.Config.MhCharacterFileName
getset

◆ MhCharArtFileName

virtual string Eamon.Game.Config.MhCharArtFileName
getset

◆ MhEffectFileName

virtual string Eamon.Game.Config.MhEffectFileName
getset

◆ MhFilesetFileName

virtual string Eamon.Game.Config.MhFilesetFileName
getset

◆ MhWorkDir

virtual string Eamon.Game.Config.MhWorkDir
getset

◆ ResolveEffects

virtual bool Eamon.Game.Config.ResolveEffects
getset

◆ RtArtifactFileName

virtual string Eamon.Game.Config.RtArtifactFileName
getset

◆ RtCharacterFileName

virtual string Eamon.Game.Config.RtCharacterFileName
getset

◆ RtCharArtFileName

virtual string Eamon.Game.Config.RtCharArtFileName
getset

◆ RtEffectFileName

virtual string Eamon.Game.Config.RtEffectFileName
getset

◆ RtFilesetFileName

virtual string Eamon.Game.Config.RtFilesetFileName
getset

◆ RtGameStateFileName

virtual string Eamon.Game.Config.RtGameStateFileName
getset

◆ RtHintFileName

virtual string Eamon.Game.Config.RtHintFileName
getset

◆ RtModuleFileName

virtual string Eamon.Game.Config.RtModuleFileName
getset

◆ RtMonsterFileName

virtual string Eamon.Game.Config.RtMonsterFileName
getset

◆ RtRoomFileName

virtual string Eamon.Game.Config.RtRoomFileName
getset

◆ ShowDesc

virtual bool Eamon.Game.Config.ShowDesc
getset

◆ WordWrapMargin

virtual long Eamon.Game.Config.WordWrapMargin
getset

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