Eamon.Game.Module Class Reference

Inheritance diagram for Eamon.Game.Module:

Public Member Functions
override void	Dispose (bool disposing)
virtual int	CompareTo (IModule module)
virtual void	PrintInfo ()
	Module ()
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 string	Author [get, set]
virtual string	VolLabel [get, set]
virtual string	SerialNum [get, set]
virtual DateTime	LastMod [get, set]
virtual long	IntroStory [get, set]
virtual long	NumDirs [get, set]
virtual long	NumRooms [get, set]
virtual long	NumArtifacts [get, set]
virtual long	NumEffects [get, set]
virtual long	NumMonsters [get, set]
virtual long	NumHints [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.IModule
string	Author [get, set]
	Gets or sets the name(s) of the author(s) for this adventure. More...
string	VolLabel [get, set]
	Gets or sets the volume label for this adventure; this is a code consisting of the author(s) initials and an author-specific sequence number, e.g. MP-001. More...
string	SerialNum [get, set]
	Gets or sets the serial number for this adventure; this is a sequence number that spans authors and indicates the number of games in Eamon CS, e.g. 013. More...
DateTime	LastMod [get, set]
	Gets or sets the last date this adventure was modified; this is updated by the EamonDD game editor. More...
long	IntroStory [get, set]
	Gets or sets an Effect Uid that corresponds to the introduction story for this adventure. More...
long	NumDirs [get, set]
	Gets or sets the number of directional links for Rooms in this adventure. Valid values are 6 or 12, corresponding to compass Directions. More...
long	NumRooms [get, set]
	Gets or sets the number of Rooms in this adventure. This value is kept in sync with the corresponding ROOMS.DAT file. More...
long	NumArtifacts [get, set]
	Gets or sets the number of Artifacts in this adventure. This value is kept in sync with the corresponding ARTIFACTS.DAT file. More...
long	NumEffects [get, set]
	Gets or sets the number of Effects in this adventure. This value is kept in sync with the corresponding EFFECTS.DAT file. More...
long	NumMonsters [get, set]
	Gets or sets the number of Monsters in this adventure. This value is kept in sync with the corresponding MONSTERS.DAT file. More...
long	NumHints [get, set]
	Gets or sets the number of Hints in this adventure. This value is kept in sync with the corresponding HINTS.DAT file. More...

Constructor & Destructor Documentation

Module()

Eamon.Game.Module.Module

(

)

Member Function Documentation

CompareTo()

virtual int Eamon.Game.Module.CompareTo ( IModule  module )

virtual

Dispose()

override void Eamon.Game.Module.Dispose ( bool  disposing )

virtual

Implements Eamon.Game.GameBase.

PrintInfo()

virtual void Eamon.Game.Module.PrintInfo ( )

virtual

Implements Eamon.Framework.IModule.

Property Documentation

Author

virtual string Eamon.Game.Module.Author

getset

IntroStory

virtual long Eamon.Game.Module.IntroStory

getset

LastMod

virtual DateTime Eamon.Game.Module.LastMod

getset

NumArtifacts

virtual long Eamon.Game.Module.NumArtifacts

getset

NumDirs

virtual long Eamon.Game.Module.NumDirs

getset

NumEffects

virtual long Eamon.Game.Module.NumEffects

getset

NumHints

virtual long Eamon.Game.Module.NumHints

getset

NumMonsters

virtual long Eamon.Game.Module.NumMonsters

getset

NumRooms

virtual long Eamon.Game.Module.NumRooms

getset

SerialNum

virtual string Eamon.Game.Module.SerialNum

getset

VolLabel

virtual string Eamon.Game.Module.VolLabel

getset

---

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

• C:/Eamon-CS/System/Eamon/Game/Module.cs