Inheritance diagram for Eamon.Framework.IRoom:

Public Member Functions
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)

T	EvalLightLevel< T > (T darkValue, T lightValue)
	Evaluates this Room's LightLvl, returning a value of type T. More...

T	EvalViewability< T > (T nonviewableValue, T viewableValue)

T	EvalRoomType< T > (T indoorsValue, T outdoorsValue)
	Evaluates this Room's Type, returning a value of type T. More...

IList< IArtifact >	GetTakeableList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

IList< IArtifact >	GetEmbeddedList (Func< IArtifact, bool > roomFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

IList< IGameBase >	GetContainedList (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)

Properties
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

◆ BuildPrintedFullDesc()

RetCode Eamon.Framework.IRoom.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`
	)

Parameters

buf
monsterFindFunc
artifactFindFunc
verboseRoomDesc
verboseMonsterDesc
verboseArtifactDesc
verboseNames
recordNameListArgs

Returns

Implemented in Eamon.Game.Room, and OrbOfMyLife.Game.Room.

◆ BuildPrintedTooDarkToSeeDesc()

RetCode Eamon.Framework.IRoom.BuildPrintedTooDarkToSeeDesc ( StringBuilder buf )

Parameters

buf

Returns

Implemented in Eamon.Game.Room, ThePyramidOfAnharos.Game.Room, and TheDeepCanyon.Game.Room.

◆ EvalLightLevel< T >()

T Eamon.Framework.IRoom.EvalLightLevel< T >	(	T	darkValue,
		T	lightValue
	)

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

Parameters

darkValue
lightValue

Returns

Implemented in Eamon.Game.Room.

◆ EvalRoomType< T >()

T Eamon.Framework.IRoom.EvalRoomType< T >	(	T	indoorsValue,
		T	outdoorsValue
	)

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

Parameters

indoorsValue
outdoorsValue

Returns

Implemented in Eamon.Game.Room.

◆ EvalViewability< T >()

T Eamon.Framework.IRoom.EvalViewability< T >	(	T	nonviewableValue,
		T	viewableValue
	)

Parameters

nonviewableValue
viewableValue

Returns

Implemented in Eamon.Game.Room.

◆ GetContainedList()

IList<IGameBase> Eamon.Framework.IRoom.GetContainedList	(	Func< IGameBase, bool >	roomFindFunc = `null`,
		Func< IArtifact, bool >	monsterFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

Parameters

roomFindFunc
monsterFindFunc
artifactFindFunc
recurse

Returns

Implemented in Eamon.Game.Room.

◆ GetDir() [1/2]

long Eamon.Framework.IRoom.GetDir ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ GetDir() [2/2]

long Eamon.Framework.IRoom.GetDir ( long index )

Parameters

index

Returns

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

◆ GetDirectionDoor() [1/2]

IArtifact Eamon.Framework.IRoom.GetDirectionDoor ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ GetDirectionDoor() [2/2]

IArtifact Eamon.Framework.IRoom.GetDirectionDoor ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ GetDirectionDoorUid() [1/2]

long Eamon.Framework.IRoom.GetDirectionDoorUid ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ GetDirectionDoorUid() [2/2]

long Eamon.Framework.IRoom.GetDirectionDoorUid ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ GetEmbeddedList()

IList<IArtifact> Eamon.Framework.IRoom.GetEmbeddedList	(	Func< IArtifact, bool >	roomFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

Parameters

roomFindFunc
artifactFindFunc
recurse

Returns

Implemented in Eamon.Game.Room.

◆ GetExitList()

RetCode Eamon.Framework.IRoom.GetExitList	(	StringBuilder	buf,
		Func< string, string >	modFunc = `null`,
		bool	useNames = `true`
	)

Parameters

buf
modFunc
useNames

Returns

Implemented in Eamon.Game.Room, TheVileGrimoireOfJaldial.Game.Room, ThePyramidOfAnharos.Game.Room, and OrbOfMyLife.Game.Room.

◆ GetObviousExits()

string Eamon.Framework.IRoom.GetObviousExits ( )

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

Returns

Implemented in Eamon.Game.Room, ThePyramidOfAnharos.Game.Room, OrbOfMyLife.Game.Room, and ARuncibleCargo.Game.Room.

◆ GetTakeableList()

IList<IArtifact> Eamon.Framework.IRoom.GetTakeableList	(	Func< IArtifact, bool >	roomFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

Parameters

roomFindFunc
artifactFindFunc
recurse

Returns

Implemented in Eamon.Game.Room.

◆ GetYouAlsoSee()

string Eamon.Framework.IRoom.GetYouAlsoSee	(	bool	showDesc,
		IList< IMonster >	monsterList,
		IList< IArtifact >	artifactList,
		IList< IGameBase >	recordList
	)

Parameters

showDesc
monsterList
artifactList
recordList

Returns

Implemented in Eamon.Game.Room, and TheVileGrimoireOfJaldial.Game.Room.

◆ IsArtifactListedInRoom()

bool Eamon.Framework.IRoom.IsArtifactListedInRoom ( IArtifact artifact )

Parameters

artifact

Returns

Implemented in Eamon.Game.Room, and TheWayfarersInn.Game.Room.

◆ IsDirectionDoor() [1/2]

bool Eamon.Framework.IRoom.IsDirectionDoor ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionDoor() [2/2]

bool Eamon.Framework.IRoom.IsDirectionDoor ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionExit() [1/2]

bool Eamon.Framework.IRoom.IsDirectionExit ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionExit() [2/2]

bool Eamon.Framework.IRoom.IsDirectionExit ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionInObviousExitsList() [1/2]

bool Eamon.Framework.IRoom.IsDirectionInObviousExitsList ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionInObviousExitsList() [2/2]

bool Eamon.Framework.IRoom.IsDirectionInObviousExitsList ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room, 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]

bool Eamon.Framework.IRoom.IsDirectionInvalid ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionInvalid() [2/2]

bool Eamon.Framework.IRoom.IsDirectionInvalid ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionRoom() [1/2]

bool Eamon.Framework.IRoom.IsDirectionRoom ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionRoom() [2/2]

bool Eamon.Framework.IRoom.IsDirectionRoom ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionRoom01() [1/2]

bool Eamon.Framework.IRoom.IsDirectionRoom01 ( Direction dir )

Parameters

dir

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionRoom01() [2/2]

bool Eamon.Framework.IRoom.IsDirectionRoom01 ( long index )

Parameters

index

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionSpecial() [1/2]

bool Eamon.Framework.IRoom.IsDirectionSpecial	(	Direction	dir,
		bool	includeExit = `true`
	)

Parameters

dir
includeExit

Returns

Implemented in Eamon.Game.Room.

◆ IsDirectionSpecial() [2/2]

bool Eamon.Framework.IRoom.IsDirectionSpecial	(	long	index,
		bool	includeExit = `true`
	)

Parameters

index
includeExit

Returns

Implemented in Eamon.Game.Room.

◆ IsLit()

bool Eamon.Framework.IRoom.IsLit ( )

Indicates whether this Room is lit.

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

Implemented in Eamon.Game.Room.

◆ IsMonsterListedInRoom()

bool Eamon.Framework.IRoom.IsMonsterListedInRoom ( IMonster monster )

Parameters

monster

Returns

Implemented in Eamon.Game.Room.

◆ IsViewable()

bool Eamon.Framework.IRoom.IsViewable ( )

Returns

Implemented in Eamon.Game.Room, and OrbOfMyLife.Game.Room.

◆ SetDir() [1/2]

void Eamon.Framework.IRoom.SetDir	(	Direction	dir,
		long	value
	)

Parameters

dir
value

Implemented in Eamon.Game.Room.

◆ SetDir() [2/2]

void Eamon.Framework.IRoom.SetDir	(	long	index,
		long	value
	)

Parameters

index
value

Implemented in Eamon.Game.Room.

◆ SetDirectionDoor() [1/2]

void Eamon.Framework.IRoom.SetDirectionDoor	(	Direction	dir,
		IArtifact	artifact
	)

Parameters

dir
artifact

Implemented in Eamon.Game.Room.

◆ SetDirectionDoor() [2/2]

void Eamon.Framework.IRoom.SetDirectionDoor	(	long	index,
		IArtifact	artifact
	)

Parameters

index
artifact

Implemented in Eamon.Game.Room.

◆ SetDirectionDoorUid() [1/2]

void Eamon.Framework.IRoom.SetDirectionDoorUid	(	Direction	dir,
		long	artifactUid
	)

Parameters

dir
artifactUid

Implemented in Eamon.Game.Room.

◆ SetDirectionDoorUid() [2/2]

void Eamon.Framework.IRoom.SetDirectionDoorUid	(	long	index,
		long	artifactUid
	)

Parameters

index
artifactUid

Implemented in Eamon.Game.Room.

◆ SetDirectionExit() [1/2]

void Eamon.Framework.IRoom.SetDirectionExit ( Direction dir )

Parameters

dir

Implemented in Eamon.Game.Room.

◆ SetDirectionExit() [2/2]

void Eamon.Framework.IRoom.SetDirectionExit ( long index )

Parameters

index

Implemented in Eamon.Game.Room.

Property Documentation

◆ Dirs

long [] Eamon.Framework.IRoom.Dirs

getset

Gets or sets an array of Room exit links, each element corresponding to one Direction.

The array always contains the same number of elements, and the 0'th element is unused. Exit links can be Room Uids or special codes representing things like game exits, doors, blocked pathways or other more exotic game-specific portals. Avoid accessing array elements directly in favor of using Getter/Setter methods to ensure games can override when necessary.

See also: GetDir(long), GetDir(Direction), SetDir(long,long), SetDir(Direction,long)

◆ LightLvl

LightLevel Eamon.Framework.IRoom.LightLvl

getset

Gets or sets a value indicating the amount of light in this Room.

◆ Type

RoomType Eamon.Framework.IRoom.Type

getset

Gets or sets a value indicating this Room's general type.

◆ Zone

long Eamon.Framework.IRoom.Zone

getset

Gets or sets a value that is unused by Eamon CS, but indicates the zone of this Room.

This value is provided to the game developer to allow sets of Rooms to be arbitrarily grouped. Then the groups of Rooms can be processed further by the game code if necessary.

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

C:/Eamon-CS/System/Eamon/Framework/IRoom.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ BuildPrintedFullDesc()

◆ BuildPrintedTooDarkToSeeDesc()

◆ EvalLightLevel< T >()

◆ EvalRoomType< T >()

◆ EvalViewability< T >()

◆ GetContainedList()

◆ GetDir() [1/2]

◆ GetDir() [2/2]

◆ GetDirectionDoor() [1/2]

◆ GetDirectionDoor() [2/2]

◆ GetDirectionDoorUid() [1/2]

◆ GetDirectionDoorUid() [2/2]

◆ GetEmbeddedList()

◆ GetExitList()

◆ GetObviousExits()

◆ GetTakeableList()

◆ GetYouAlsoSee()

◆ IsArtifactListedInRoom()

◆ IsDirectionDoor() [1/2]

◆ IsDirectionDoor() [2/2]

◆ IsDirectionExit() [1/2]

◆ IsDirectionExit() [2/2]

◆ IsDirectionInObviousExitsList() [1/2]

◆ IsDirectionInObviousExitsList() [2/2]

◆ IsDirectionInvalid() [1/2]

◆ IsDirectionInvalid() [2/2]

◆ IsDirectionRoom() [1/2]

◆ IsDirectionRoom() [2/2]

◆ IsDirectionRoom01() [1/2]

◆ IsDirectionRoom01() [2/2]

◆ IsDirectionSpecial() [1/2]

◆ IsDirectionSpecial() [2/2]

◆ IsLit()

◆ IsMonsterListedInRoom()

◆ IsViewable()

◆ SetDir() [1/2]

◆ SetDir() [2/2]

◆ SetDirectionDoor() [1/2]

◆ SetDirectionDoor() [2/2]

◆ SetDirectionDoorUid() [1/2]

◆ SetDirectionDoorUid() [2/2]

◆ SetDirectionExit() [1/2]

◆ SetDirectionExit() [2/2]

Property Documentation

◆ Dirs

◆ LightLvl

◆ Type

◆ Zone