Inheritance diagram for Eamon.Game.GameBase:

Public Member Functions
abstract void	Dispose (bool disposing)

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)

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

	GameBase ()

Properties
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...

Constructor & Destructor Documentation

◆ GameBase()

Eamon.Game.GameBase.GameBase ( )

Member Function Documentation

◆ BuildPrintedFullDesc()

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

virtual

Parameters

buf
showName
showVerboseName

Returns

Implements Eamon.Framework.IGameBase.

Reimplemented in Eamon.Game.Artifact, Eamon.Game.Monster, Eamon.Game.Character, TheVileGrimoireOfJaldial.Game.Artifact, Eamon.Game.Room, StrongholdOfKahrDur.Game.Monster, LandOfTheMountainKing.Game.Artifact, and ARuncibleCargo.Game.Monster.

◆ Dispose() [1/2]

void Eamon.Game.GameBase.Dispose ( )

◆ Dispose() [2/2]

abstract void Eamon.Game.GameBase.Dispose ( bool disposing )

pure virtual

Implemented in Eamon.Game.Artifact, Eamon.Game.Monster, Eamon.Game.Config, Eamon.Game.GameState, Eamon.Game.Character, Eamon.Game.Fileset, Eamon.Game.Module, Eamon.Game.Room, Eamon.Game.Hint, and Eamon.Game.Effect.

◆ GetArticleName()

virtual string Eamon.Game.GameBase.GetArticleName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

virtual

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implements Eamon.Framework.IGameBase.

◆ GetDecoratedName()

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

virtual

Parameters

fieldName
articleType
upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implements Eamon.Framework.IGameBase.

Reimplemented in Eamon.Game.Artifact, Eamon.Game.Monster, and Eamon.Game.Character.

◆ GetNoneName()

virtual string Eamon.Game.GameBase.GetNoneName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

virtual

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implements Eamon.Framework.IGameBase.

◆ GetPluralName()

virtual string Eamon.Game.GameBase.GetPluralName ( string fieldName )

virtual

Parameters

fieldName

Returns

Implements Eamon.Framework.IGameBase.

Reimplemented in Eamon.Game.Artifact, Eamon.Game.Monster, and Eamon.Game.Character.

◆ GetPluralName01()

virtual string Eamon.Game.GameBase.GetPluralName01 ( )

virtual

Returns

Implements Eamon.Framework.IGameBase.

◆ GetTheName()

virtual string Eamon.Game.GameBase.GetTheName	(	bool	upshift = `false`,
		bool	showCharOwned = `true`,
		bool	showStateDesc = `false`,
		bool	showContents = `false`,
		bool	groupCountOne = `false`
	)

virtual

Parameters

upshift
showCharOwned
showStateDesc
showContents
groupCountOne

Returns

Implements Eamon.Framework.IGameBase.

◆ SetParentReferences()

virtual void Eamon.Game.GameBase.SetParentReferences ( )

virtual

Implements Eamon.Framework.IGameBase.

Reimplemented in Eamon.Game.Artifact, and Eamon.Game.Monster.

Property Documentation

◆ ArticleType

virtual ArticleType Eamon.Game.GameBase.ArticleType

getset

◆ Desc

virtual string Eamon.Game.GameBase.Desc

getset

◆ Moved

virtual bool Eamon.Game.GameBase.Moved

getset

◆ Name

virtual string Eamon.Game.GameBase.Name

getset

◆ ParserMatchName

virtual string Eamon.Game.GameBase.ParserMatchName

getset

◆ Seen

virtual bool Eamon.Game.GameBase.Seen

getset

◆ Synonyms

virtual string [] Eamon.Game.GameBase.Synonyms

getset

◆ Uid

virtual long Eamon.Game.GameBase.Uid

getset

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

C:/Eamon-CS/System/Eamon/Game/GameBase.cs

Public Member Functions

Properties

Constructor & Destructor Documentation

◆ GameBase()

Member Function Documentation

◆ BuildPrintedFullDesc()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ GetArticleName()

◆ GetDecoratedName()

◆ GetNoneName()

◆ GetPluralName()

◆ GetPluralName01()

◆ GetTheName()

◆ SetParentReferences()

Property Documentation

◆ ArticleType

◆ Desc

◆ Moved

◆ Name

◆ ParserMatchName

◆ Seen

◆ Synonyms

◆ Uid