Eamon CS  3.1.0
Eamon.Framework.IModule Interface Reference

More...

Inheritance diagram for Eamon.Framework.IModule:
Eamon.Framework.IGameBase Eamon.Game.Module

Public Member Functions

void PrintInfo ()
 
- 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

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

◆ PrintInfo()

void Eamon.Framework.IModule.PrintInfo ( )

Implemented in Eamon.Game.Module.

Property Documentation

◆ Author

string Eamon.Framework.IModule.Author
getset

Gets or sets the name(s) of the author(s) for this adventure.

◆ IntroStory

long Eamon.Framework.IModule.IntroStory
getset

Gets or sets an Effect Uid that corresponds to the introduction story for this adventure.

The Effect referenced by this value will frequently be the initial prose in a set of Events chained together using the typical Eamon CS mechanism. You can look at any existing game for an example of this. The value may also be zero (0), in which case the adventure has no introduction story.

◆ LastMod

DateTime Eamon.Framework.IModule.LastMod
getset

Gets or sets the last date this adventure was modified; this is updated by the EamonDD game editor.

◆ NumArtifacts

long Eamon.Framework.IModule.NumArtifacts
getset

Gets or sets the number of Artifacts in this adventure. This value is kept in sync with the corresponding ARTIFACTS.DAT file.

◆ NumDirs

long Eamon.Framework.IModule.NumDirs
getset

Gets or sets the number of directional links for Rooms in this adventure. Valid values are 6 or 12, corresponding to compass Directions.

◆ NumEffects

long Eamon.Framework.IModule.NumEffects
getset

Gets or sets the number of Effects in this adventure. This value is kept in sync with the corresponding EFFECTS.DAT file.

◆ NumHints

long Eamon.Framework.IModule.NumHints
getset

Gets or sets the number of Hints in this adventure. This value is kept in sync with the corresponding HINTS.DAT file.

◆ NumMonsters

long Eamon.Framework.IModule.NumMonsters
getset

Gets or sets the number of Monsters in this adventure. This value is kept in sync with the corresponding MONSTERS.DAT file.

◆ NumRooms

long Eamon.Framework.IModule.NumRooms
getset

Gets or sets the number of Rooms in this adventure. This value is kept in sync with the corresponding ROOMS.DAT file.

◆ SerialNum

string Eamon.Framework.IModule.SerialNum
getset

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.

◆ VolLabel

string Eamon.Framework.IModule.VolLabel
getset

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.


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