Eamon CS  3.1.0
Public Member Functions | Properties | List of all members
Eamon.Game.Room Class Reference
Inheritance diagram for Eamon.Game.Room:
Eamon.Game.GameBase Eamon.Framework.IRoom Eamon.Framework.IGameBase Eamon.Framework.IGameBase ARuncibleCargo.Game.Room Dharmaquest.Game.Room OrbOfMyLife.Game.Room TheDeepCanyon.Game.Room ThePyramidOfAnharos.Game.Room TheSubAquanLaboratory.Game.Room TheTempleOfNgurct.Game.Room TheVileGrimoireOfJaldial.Game.Room TheWayfarersInn.Game.Room WrenholdsSecretVigil.Game.Room

Public Member Functions

override void Dispose (bool disposing)
 
override RetCode BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)
 
virtual int CompareTo (IRoom room)
 
virtual long GetDir (long index)
 
virtual long GetDir (Direction dir)
 
virtual void SetDir (long index, long value)
 
virtual void SetDir (Direction dir, long value)
 
virtual bool IsLit ()
 Indicates whether this Room is lit. More...
 
virtual bool IsViewable ()
 
virtual bool IsDirectionInvalid (long index)
 
virtual bool IsDirectionInvalid (Direction dir)
 
virtual bool IsDirectionRoom (long index)
 
virtual bool IsDirectionRoom (Direction dir)
 
virtual bool IsDirectionRoom01 (long index)
 
virtual bool IsDirectionRoom01 (Direction dir)
 
virtual bool IsDirectionExit (long index)
 
virtual bool IsDirectionExit (Direction dir)
 
virtual bool IsDirectionDoor (long index)
 
virtual bool IsDirectionDoor (Direction dir)
 
virtual bool IsDirectionSpecial (long index, bool includeExit=true)
 
virtual bool IsDirectionSpecial (Direction dir, bool includeExit=true)
 
virtual bool IsDirectionInObviousExitsList (long index)
 
virtual bool IsDirectionInObviousExitsList (Direction dir)
 
virtual long GetDirectionDoorUid (long index)
 
virtual long GetDirectionDoorUid (Direction dir)
 
virtual IArtifact GetDirectionDoor (long index)
 
virtual IArtifact GetDirectionDoor (Direction dir)
 
virtual void SetDirectionExit (long index)
 
virtual void SetDirectionExit (Direction dir)
 
virtual void SetDirectionDoorUid (long index, long artifactUid)
 
virtual void SetDirectionDoorUid (Direction dir, long artifactUid)
 
virtual void SetDirectionDoor (long index, IArtifact artifact)
 
virtual void SetDirectionDoor (Direction dir, IArtifact artifact)
 
virtual string GetYouAlsoSee (bool showDesc, IList< IMonster > monsterList, IList< IArtifact > artifactList, IList< IGameBase > recordList)
 
virtual string GetObviousExits ()
 Gets this Room's obvious exits prefix string, based on its Type. More...
 
virtual bool IsMonsterListedInRoom (IMonster monster)
 
virtual bool IsArtifactListedInRoom (IArtifact artifact)
 
virtual T EvalLightLevel< T > (T darkValue, T lightValue)
 Evaluates this Room's LightLvl, returning a value of type T. More...
 
virtual T EvalViewability< T > (T nonviewableValue, T viewableValue)
 
virtual T EvalRoomType< T > (T indoorsValue, T outdoorsValue)
 Evaluates this Room's Type, returning a value of type T. More...
 
virtual IList< IArtifact > GetTakeableList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
virtual IList< IArtifact > GetEmbeddedList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
virtual IList< IGameBase > GetContainedList (Func< IGameBase, bool > roomFindFunc=null, Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)
 
virtual RetCode GetExitList (StringBuilder buf, Func< string, string > modFunc=null, bool useNames=true)
 
virtual 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)
 
virtual RetCode BuildPrintedTooDarkToSeeDesc (StringBuilder buf)
 
 Room ()
 
- 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)
 
 GameBase ()
 

Properties

virtual LightLevel LightLvl [get, set]
 
virtual RoomType Type [get, set]
 
virtual long Zone [get, set]
 
virtual long[] Dirs [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.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...
 

Constructor & Destructor Documentation

◆ Room()

Eamon.Game.Room.Room ( )

Member Function Documentation

◆ BuildPrintedFullDesc() [1/2]

override RetCode Eamon.Game.Room.BuildPrintedFullDesc ( StringBuilder  buf,
bool  showName,
bool  showVerboseName 
)
virtual

Parameters
buf
showName
showVerboseName
Returns

Reimplemented from Eamon.Game.GameBase.

◆ BuildPrintedFullDesc() [2/2]

virtual RetCode Eamon.Game.Room.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 
)
virtual

Parameters
buf
monsterFindFunc
artifactFindFunc
verboseRoomDesc
verboseMonsterDesc
verboseArtifactDesc
verboseNames
recordNameListArgs
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in OrbOfMyLife.Game.Room.

◆ BuildPrintedTooDarkToSeeDesc()

virtual RetCode Eamon.Game.Room.BuildPrintedTooDarkToSeeDesc ( StringBuilder  buf)
virtual

Parameters
buf
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in ThePyramidOfAnharos.Game.Room, and TheDeepCanyon.Game.Room.

◆ CompareTo()

virtual int Eamon.Game.Room.CompareTo ( IRoom  room)
virtual

◆ Dispose()

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

Implements Eamon.Game.GameBase.

◆ EvalLightLevel< T >()

virtual T Eamon.Game.Room.EvalLightLevel< T > ( T  darkValue,
T  lightValue 
)
virtual

Evaluates this Room's LightLvl, returning a value of type T.

Parameters
darkValue
lightValue
Returns

Implements Eamon.Framework.IRoom.

◆ EvalRoomType< T >()

virtual T Eamon.Game.Room.EvalRoomType< T > ( T  indoorsValue,
T  outdoorsValue 
)
virtual

Evaluates this Room's Type, returning a value of type T.

Parameters
indoorsValue
outdoorsValue
Returns

Implements Eamon.Framework.IRoom.

◆ EvalViewability< T >()

virtual T Eamon.Game.Room.EvalViewability< T > ( T  nonviewableValue,
T  viewableValue 
)
virtual

Parameters
nonviewableValue
viewableValue
Returns

Implements Eamon.Framework.IRoom.

◆ GetContainedList()

virtual IList<IGameBase> Eamon.Game.Room.GetContainedList ( Func< IGameBase, bool >  roomFindFunc = null,
Func< IArtifact, bool >  monsterFindFunc = null,
Func< IArtifact, bool >  artifactFindFunc = null,
bool  recurse = false 
)
virtual

Parameters
roomFindFunc
monsterFindFunc
artifactFindFunc
recurse
Returns

Implements Eamon.Framework.IRoom.

◆ GetDir() [1/2]

virtual long Eamon.Game.Room.GetDir ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ GetDir() [2/2]

virtual long Eamon.Game.Room.GetDir ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in TheVileGrimoireOfJaldial.Game.Room, ThePyramidOfAnharos.Game.Room, TheWayfarersInn.Game.Room, TheDeepCanyon.Game.Room, TheSubAquanLaboratory.Game.Room, and TheTempleOfNgurct.Game.Room.

◆ GetDirectionDoor() [1/2]

virtual IArtifact Eamon.Game.Room.GetDirectionDoor ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ GetDirectionDoor() [2/2]

virtual IArtifact Eamon.Game.Room.GetDirectionDoor ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ GetDirectionDoorUid() [1/2]

virtual long Eamon.Game.Room.GetDirectionDoorUid ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ GetDirectionDoorUid() [2/2]

virtual long Eamon.Game.Room.GetDirectionDoorUid ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ GetEmbeddedList()

virtual IList<IArtifact> Eamon.Game.Room.GetEmbeddedList ( Func< IArtifact, bool >  roomFindFunc = null,
Func< IArtifact, bool >  artifactFindFunc = null,
bool  recurse = false 
)
virtual

Parameters
roomFindFunc
artifactFindFunc
recurse
Returns

Implements Eamon.Framework.IRoom.

◆ GetExitList()

virtual RetCode Eamon.Game.Room.GetExitList ( StringBuilder  buf,
Func< string, string >  modFunc = null,
bool  useNames = true 
)
virtual

Parameters
buf
modFunc
useNames
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in TheVileGrimoireOfJaldial.Game.Room, ThePyramidOfAnharos.Game.Room, and OrbOfMyLife.Game.Room.

◆ GetObviousExits()

virtual string Eamon.Game.Room.GetObviousExits ( )
virtual

Gets this Room's obvious exits prefix string, based on its Type.

Returns

Implements Eamon.Framework.IRoom.

Reimplemented in ThePyramidOfAnharos.Game.Room, OrbOfMyLife.Game.Room, and ARuncibleCargo.Game.Room.

◆ GetTakeableList()

virtual IList<IArtifact> Eamon.Game.Room.GetTakeableList ( Func< IArtifact, bool >  roomFindFunc = null,
Func< IArtifact, bool >  artifactFindFunc = null,
bool  recurse = false 
)
virtual

Parameters
roomFindFunc
artifactFindFunc
recurse
Returns

Implements Eamon.Framework.IRoom.

◆ GetYouAlsoSee()

virtual string Eamon.Game.Room.GetYouAlsoSee ( bool  showDesc,
IList< IMonster >  monsterList,
IList< IArtifact >  artifactList,
IList< IGameBase >  recordList 
)
virtual

Parameters
showDesc
monsterList
artifactList
recordList
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in TheVileGrimoireOfJaldial.Game.Room.

◆ IsArtifactListedInRoom()

virtual bool Eamon.Game.Room.IsArtifactListedInRoom ( IArtifact  artifact)
virtual

Parameters
artifact
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in TheWayfarersInn.Game.Room.

◆ IsDirectionDoor() [1/2]

virtual bool Eamon.Game.Room.IsDirectionDoor ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionDoor() [2/2]

virtual bool Eamon.Game.Room.IsDirectionDoor ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionExit() [1/2]

virtual bool Eamon.Game.Room.IsDirectionExit ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionExit() [2/2]

virtual bool Eamon.Game.Room.IsDirectionExit ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionInObviousExitsList() [1/2]

virtual bool Eamon.Game.Room.IsDirectionInObviousExitsList ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionInObviousExitsList() [2/2]

virtual bool Eamon.Game.Room.IsDirectionInObviousExitsList ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

Reimplemented in TheVileGrimoireOfJaldial.Game.Room, ThePyramidOfAnharos.Game.Room, TheDeepCanyon.Game.Room, TheWayfarersInn.Game.Room, OrbOfMyLife.Game.Room, WrenholdsSecretVigil.Game.Room, and Dharmaquest.Game.Room.

◆ IsDirectionInvalid() [1/2]

virtual bool Eamon.Game.Room.IsDirectionInvalid ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionInvalid() [2/2]

virtual bool Eamon.Game.Room.IsDirectionInvalid ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionRoom() [1/2]

virtual bool Eamon.Game.Room.IsDirectionRoom ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionRoom() [2/2]

virtual bool Eamon.Game.Room.IsDirectionRoom ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionRoom01() [1/2]

virtual bool Eamon.Game.Room.IsDirectionRoom01 ( Direction  dir)
virtual

Parameters
dir
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionRoom01() [2/2]

virtual bool Eamon.Game.Room.IsDirectionRoom01 ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionSpecial() [1/2]

virtual bool Eamon.Game.Room.IsDirectionSpecial ( Direction  dir,
bool  includeExit = true 
)
virtual

Parameters
dir
includeExit
Returns

Implements Eamon.Framework.IRoom.

◆ IsDirectionSpecial() [2/2]

virtual bool Eamon.Game.Room.IsDirectionSpecial ( long  index,
bool  includeExit = true 
)
virtual

Parameters
index
includeExit
Returns

Implements Eamon.Framework.IRoom.

◆ IsLit()

virtual bool Eamon.Game.Room.IsLit ( )
virtual

Indicates whether this Room is lit.

Returns
If LightLvl == LightLevel.Light then true, otherwise false.

Implements Eamon.Framework.IRoom.

◆ IsMonsterListedInRoom()

virtual bool Eamon.Game.Room.IsMonsterListedInRoom ( IMonster  monster)
virtual

Parameters
monster
Returns

Implements Eamon.Framework.IRoom.

◆ IsViewable()

virtual bool Eamon.Game.Room.IsViewable ( )
virtual

Returns

Implements Eamon.Framework.IRoom.

Reimplemented in OrbOfMyLife.Game.Room.

◆ SetDir() [1/2]

virtual void Eamon.Game.Room.SetDir ( Direction  dir,
long  value 
)
virtual

Parameters
dir
value

Implements Eamon.Framework.IRoom.

◆ SetDir() [2/2]

virtual void Eamon.Game.Room.SetDir ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.IRoom.

◆ SetDirectionDoor() [1/2]

virtual void Eamon.Game.Room.SetDirectionDoor ( Direction  dir,
IArtifact  artifact 
)
virtual

Parameters
dir
artifact

Implements Eamon.Framework.IRoom.

◆ SetDirectionDoor() [2/2]

virtual void Eamon.Game.Room.SetDirectionDoor ( long  index,
IArtifact  artifact 
)
virtual

Parameters
index
artifact

Implements Eamon.Framework.IRoom.

◆ SetDirectionDoorUid() [1/2]

virtual void Eamon.Game.Room.SetDirectionDoorUid ( Direction  dir,
long  artifactUid 
)
virtual

Parameters
dir
artifactUid

Implements Eamon.Framework.IRoom.

◆ SetDirectionDoorUid() [2/2]

virtual void Eamon.Game.Room.SetDirectionDoorUid ( long  index,
long  artifactUid 
)
virtual

Parameters
index
artifactUid

Implements Eamon.Framework.IRoom.

◆ SetDirectionExit() [1/2]

virtual void Eamon.Game.Room.SetDirectionExit ( Direction  dir)
virtual

Parameters
dir

Implements Eamon.Framework.IRoom.

◆ SetDirectionExit() [2/2]

virtual void Eamon.Game.Room.SetDirectionExit ( long  index)
virtual

Parameters
index

Implements Eamon.Framework.IRoom.

Property Documentation

◆ Dirs

virtual long [] Eamon.Game.Room.Dirs
getset

◆ LightLvl

virtual LightLevel Eamon.Game.Room.LightLvl
getset

◆ Type

virtual RoomType Eamon.Game.Room.Type
getset

◆ Zone

virtual long Eamon.Game.Room.Zone
getset
The documentation for this class was generated from the following file: