Eamon CS  3.1.0
TheWayfarersInn.Framework.IRoom Interface Reference

More...

Inheritance diagram for TheWayfarersInn.Framework.IRoom:
Eamon.Framework.IRoom Eamon.Framework.IGameBase TheWayfarersInn.Game.Room

Public Member Functions

bool IsForestRoom ()
 
bool IsRiverRoom ()
 
bool IsWayfarersInnClearingRoom ()
 
bool IsWayfarersInnRoom ()
 
- Public Member Functions inherited from Eamon.Framework.IRoom
long GetDir (long index)
 
long GetDir (Direction dir)
 
void SetDir (long index, long value)
 
void SetDir (Direction dir, long value)
 
bool IsLit ()
 Indicates whether this Room is lit. More...
 
bool IsViewable ()
 
bool IsDirectionInvalid (long index)
 
bool IsDirectionInvalid (Direction dir)
 
bool IsDirectionRoom (long index)
 
bool IsDirectionRoom (Direction dir)
 
bool IsDirectionRoom01 (long index)
 
bool IsDirectionRoom01 (Direction dir)
 
bool IsDirectionExit (long index)
 
bool IsDirectionExit (Direction dir)
 
bool IsDirectionDoor (long index)
 
bool IsDirectionDoor (Direction dir)
 
bool IsDirectionSpecial (long index, bool includeExit=true)
 
bool IsDirectionSpecial (Direction dir, bool includeExit=true)
 
bool IsDirectionInObviousExitsList (long index)
 
bool IsDirectionInObviousExitsList (Direction dir)
 
long GetDirectionDoorUid (long index)
 
long GetDirectionDoorUid (Direction dir)
 
IArtifact GetDirectionDoor (long index)
 
IArtifact GetDirectionDoor (Direction dir)
 
void SetDirectionExit (long index)
 
void SetDirectionExit (Direction dir)
 
void SetDirectionDoorUid (long index, long artifactUid)
 
void SetDirectionDoorUid (Direction dir, long artifactUid)
 
void SetDirectionDoor (long index, IArtifact artifact)
 
void SetDirectionDoor (Direction dir, IArtifact artifact)
 
string GetYouAlsoSee (bool showDesc, IList< IMonster > monsterList, IList< IArtifact > artifactList, IList< IGameBase > recordList)
 
string GetObviousExits ()
 Gets this Room's obvious exits prefix string, based on its Type. More...
 
bool IsMonsterListedInRoom (IMonster monster)
 
bool IsArtifactListedInRoom (IArtifact artifact)
 
EvalLightLevel< T > (T darkValue, T lightValue)
 Evaluates this Room's LightLvl, returning a value of type T. More...
 
EvalViewability< T > (T nonviewableValue, T viewableValue)
 
EvalRoomType< T > (T indoorsValue, T outdoorsValue)
 Evaluates this Room's Type, returning a value of type T. More...
 
IList< IArtifactGetTakeableList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
IList< IArtifactGetEmbeddedList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
IList< IGameBaseGetContainedList (Func< IGameBase, bool > roomFindFunc=null, Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
RetCode GetExitList (StringBuilder buf, Func< string, string > modFunc=null, bool useNames=true)
 
RetCode BuildPrintedFullDesc (StringBuilder buf, Func< IMonster, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool verboseRoomDesc=false, bool verboseMonsterDesc=false, bool verboseArtifactDesc=false, bool verboseNames=false, IRecordNameListArgs recordNameListArgs=null)
 
RetCode BuildPrintedTooDarkToSeeDesc (StringBuilder buf)
 
- 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)
 

Additional Inherited Members

- Properties inherited from Eamon.Framework.IRoom
LightLevel LightLvl [get, set]
 Gets or sets a value indicating the amount of light in this Room. More...
 
RoomType Type [get, set]
 Gets or sets a value indicating this Room's general type. More...
 
long Zone [get, set]
 Gets or sets a value that is unused by Eamon CS, but indicates the zone of this Room. More...
 
long[] Dirs [get, set]
 Gets or sets an array of Room exit links, each element corresponding to one Direction. 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

◆ IsForestRoom()

bool TheWayfarersInn.Framework.IRoom.IsForestRoom ( )

Implemented in TheWayfarersInn.Game.Room.

◆ IsRiverRoom()

bool TheWayfarersInn.Framework.IRoom.IsRiverRoom ( )

Implemented in TheWayfarersInn.Game.Room.

◆ IsWayfarersInnClearingRoom()

bool TheWayfarersInn.Framework.IRoom.IsWayfarersInnClearingRoom ( )

Implemented in TheWayfarersInn.Game.Room.

◆ IsWayfarersInnRoom()

bool TheWayfarersInn.Framework.IRoom.IsWayfarersInnRoom ( )

Implemented in TheWayfarersInn.Game.Room.


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