Inheritance diagram for Eamon.Framework.IGameBase:

Public Member Functions
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
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.IGameBase.BuildPrintedFullDesc	(	StringBuilder	buf,
		bool	showName,
		bool	showVerboseName
	)

Parameters

buf
showName
showVerboseName

Returns

Implemented in Eamon.Game.Artifact, Eamon.Game.Monster, Eamon.Game.Character, Eamon.Game.GameBase, TheVileGrimoireOfJaldial.Game.Artifact, Eamon.Game.Room, StrongholdOfKahrDur.Game.Monster, LandOfTheMountainKing.Game.Artifact, ARuncibleCargo.Game.Monster, and Firestorm.Game.Artifact.

◆ GetArticleName()

string Eamon.Framework.IGameBase.GetArticleName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implemented in Eamon.Game.GameBase.

◆ GetDecoratedName()

string Eamon.Framework.IGameBase.GetDecoratedName	(	string	fieldName,
		ArticleType	articleType,
		bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

Parameters

fieldName
articleType
upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implemented in Eamon.Game.Artifact, Eamon.Game.Monster, Eamon.Game.Character, and Eamon.Game.GameBase.

◆ GetNoneName()

string Eamon.Framework.IGameBase.GetNoneName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implemented in Eamon.Game.GameBase.

◆ GetPluralName()

string Eamon.Framework.IGameBase.GetPluralName ( string fieldName )

Parameters

fieldName

Returns

Implemented in Eamon.Game.Artifact, Eamon.Game.Monster, Eamon.Game.Character, and Eamon.Game.GameBase.

◆ GetPluralName01()

string Eamon.Framework.IGameBase.GetPluralName01 ( )

Returns

Implemented in Eamon.Game.GameBase.

◆ GetTheName()

string Eamon.Framework.IGameBase.GetTheName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implemented in Eamon.Game.GameBase.

◆ SetParentReferences()

void Eamon.Framework.IGameBase.SetParentReferences ( )

Implemented in Eamon.Game.Artifact, Eamon.Game.Monster, and Eamon.Game.GameBase.

Property Documentation

◆ ArticleType

ArticleType Eamon.Framework.IGameBase.ArticleType

getset

Gets or sets a value indicating how this Record's Name is prefixed to produce its listed Name.

◆ Desc

string Eamon.Framework.IGameBase.Desc

getset

Gets or sets the detailed description of this Record shown when the Record is first Seen or later examined.

◆ Moved

bool Eamon.Framework.IGameBase.Moved

getset

Gets or sets a value indicating whether this Record has been moved from its original Location.

◆ Name

string Eamon.Framework.IGameBase.Name

getset

Gets or sets the name of this Record as shown in various lists or the Record's full description.

◆ ParserMatchName

string Eamon.Framework.IGameBase.ParserMatchName

getset

Gets or sets the name or synonym of this Record matched in the FilterRecordList method.

◆ Seen

bool Eamon.Framework.IGameBase.Seen

getset

Gets or sets a value indicating whether this Record has been seen by the player character.

◆ Synonyms

string [] Eamon.Framework.IGameBase.Synonyms

getset

Gets or sets a string array containing Name synonyms for this Record (may be null).

In the case of Artifacts and Monsters, the game uses synonyms during parsing.

◆ Uid

long Eamon.Framework.IGameBase.Uid

getset

Gets or sets a unique Id that distinguishes this Record from others of its type.

Every foundational Record Type in Eamon CS (e.g., Room, Artifact, etc.) inherits this unique Id. This allows the game designer to find and manipulate specific Records, either using tools like EamonDD or during gameplay. The unique Id is a discrete sequence number starting at 1 for each inheriting Record Type, which means you can get (for example) both a Room and Artifact with the same unique Id.

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ BuildPrintedFullDesc()

◆ GetArticleName()

◆ GetDecoratedName()

◆ GetNoneName()

◆ GetPluralName()

◆ GetPluralName01()

◆ GetTheName()

◆ SetParentReferences()

Property Documentation

◆ ArticleType

◆ Desc

◆ Moved

◆ Name

◆ ParserMatchName

◆ Seen

◆ Synonyms

◆ Uid