Inheritance diagram for TheVileGrimoireOfJaldial.Game.Room:

Public Member Functions
override long	GetDir (long index)

override bool	IsDirectionInObviousExitsList (long index)

override string	GetYouAlsoSee (bool showDesc, IList< IMonster > monsterList, IList< IArtifact > artifactList, IList< IGameBase > recordList)

override RetCode	GetExitList (StringBuilder buf, Func< string, string > modFunc=null, bool useNames=true)

virtual bool	IsGroundsRoom ()

virtual bool	IsCryptRoom ()

virtual bool	IsFenceRoom ()

virtual bool	IsSwampRoom ()

virtual bool	IsBodyChamberRoom ()

virtual bool	IsRainyRoom ()

virtual bool	IsFoggyRoom ()

virtual bool	IsDimLightRoom ()

virtual bool	IsDimLightRoomWithoutGlowingMonsters ()

virtual long	GetWeatherIntensity ()

Public Member Functions inherited from Eamon.Game.Room
override void	Dispose (bool disposing)

override RetCode	BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)

virtual int	CompareTo (IRoom room)

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 (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	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	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
override string?	Name `[get, set]`

override string?	Desc `[get, set]`

override bool	Seen `[get, set]`

override LightLevel	LightLvl `[get, set]`

virtual bool	DimLightSeen `[get, set]`

virtual bool	Seen02 `[get]`

Properties inherited from Eamon.Game.Room
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...

Properties inherited from TheVileGrimoireOfJaldial.Framework.IRoom
bool	Seen02 `[get]`

Member Function Documentation

◆ GetDir()

override long TheVileGrimoireOfJaldial.Game.Room.GetDir ( long index )

virtual

Parameters

index

Returns

Reimplemented from Eamon.Game.Room.

◆ GetExitList()

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

virtual

Parameters

buf
modFunc
useNames

Returns

Reimplemented from Eamon.Game.Room.

◆ GetWeatherIntensity()

virtual long TheVileGrimoireOfJaldial.Game.Room.GetWeatherIntensity ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ GetYouAlsoSee()

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

virtual

Parameters

showDesc
monsterList
artifactList
recordList

Returns

Reimplemented from Eamon.Game.Room.

◆ IsBodyChamberRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsBodyChamberRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsCryptRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsCryptRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsDimLightRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsDimLightRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsDimLightRoomWithoutGlowingMonsters()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsDimLightRoomWithoutGlowingMonsters ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsDirectionInObviousExitsList()

override bool TheVileGrimoireOfJaldial.Game.Room.IsDirectionInObviousExitsList ( long index )

virtual

Parameters

index

Returns

Reimplemented from Eamon.Game.Room.

◆ IsFenceRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsFenceRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsFoggyRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsFoggyRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsGroundsRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsGroundsRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsRainyRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsRainyRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

◆ IsSwampRoom()

virtual bool TheVileGrimoireOfJaldial.Game.Room.IsSwampRoom ( )

virtual

Implements TheVileGrimoireOfJaldial.Framework.IRoom.

Property Documentation

◆ Desc

override string? TheVileGrimoireOfJaldial.Game.Room.Desc

getset

◆ DimLightSeen

virtual bool TheVileGrimoireOfJaldial.Game.Room.DimLightSeen

getset

◆ LightLvl

override LightLevel TheVileGrimoireOfJaldial.Game.Room.LightLvl

getset

◆ Name

override string? TheVileGrimoireOfJaldial.Game.Room.Name

getset

◆ Seen

override bool TheVileGrimoireOfJaldial.Game.Room.Seen

getset

◆ Seen02

virtual bool TheVileGrimoireOfJaldial.Game.Room.Seen02

get

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

C:/Eamon-CS/Adventures/TheVileGrimoireOfJaldial/Game/Room.cs

Public Member Functions

Properties

Member Function Documentation

◆ GetDir()

◆ GetExitList()

◆ GetWeatherIntensity()

◆ GetYouAlsoSee()

◆ IsBodyChamberRoom()

◆ IsCryptRoom()

◆ IsDimLightRoom()

◆ IsDimLightRoomWithoutGlowingMonsters()

◆ IsDirectionInObviousExitsList()

◆ IsFenceRoom()

◆ IsFoggyRoom()

◆ IsGroundsRoom()

◆ IsRainyRoom()

◆ IsSwampRoom()

Property Documentation

◆ Desc

◆ DimLightSeen

◆ LightLvl

◆ Name

◆ Seen

◆ Seen02