Eamon CS  3.1.0
Eamon.Game.Effect Class Reference
Inheritance diagram for Eamon.Game.Effect:
Eamon.Game.GameBase Eamon.Framework.IEffect Eamon.Framework.IGameBase Eamon.Framework.IGameBase

Public Member Functions

override void Dispose (bool disposing)
 
virtual int CompareTo (IEffect effect)
 
virtual RetCode BuildPrintedFullDesc (StringBuilder buf)
 
 Effect ()
 
- 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 ()
 

Additional Inherited Members

- 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...
 

Constructor & Destructor Documentation

◆ Effect()

Eamon.Game.Effect.Effect ( )

Member Function Documentation

◆ BuildPrintedFullDesc()

virtual RetCode Eamon.Game.Effect.BuildPrintedFullDesc ( StringBuilder  buf)
virtual

Parameters
buf
Returns

Implements Eamon.Framework.IEffect.

◆ CompareTo()

virtual int Eamon.Game.Effect.CompareTo ( IEffect  effect)
virtual

◆ Dispose()

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

Implements Eamon.Game.GameBase.


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