Inheritance diagram for Eamon.Game.GameState:

Public Member Functions
override void	Dispose (bool disposing)

virtual int	CompareTo (IGameState gameState)

virtual long	GetNBTL (long index, long roomUid=0)
	Gets the total Hardiness of Monsters with a specified Friendliness in a particular Room. More...

virtual long	GetNBTL (Friendliness friendliness, long roomUid=0)
	Gets the total Hardiness of Monsters with a specified Friendliness in a particular Room. More...

virtual long	GetDTTL (long index, long roomUid=0)
	Gets the total DmgTaken of Monsters with a specified Friendliness in a particular Room. More...

virtual long	GetDTTL (Friendliness friendliness, long roomUid=0)
	Gets the total DmgTaken of Monsters with a specified Friendliness in a particular Room. More...

virtual long	GetSa (long index)
	Gets the player's current ability for a given Spell. More...

virtual long	GetSa (Spell spell)
	Gets the player's current ability for a given Spell. More...

virtual long	GetImportedArtUid (long index)
	Gets the imported Artifact Uid at a given index. More...

virtual long	GetHeldWpnUid (long index)
	Gets the held weapon Artifact Uid at a given index. More...

virtual void	SetSa (long index, long value)
	Sets the player's current ability for a given Spell. More...

virtual void	SetSa (Spell spell, long value)
	Sets the player's current ability for a given Spell. More...

virtual void	SetImportedArtUid (long value)
	Adds the imported Artifact Uid to the list. More...

virtual void	SetHeldWpnUid (long value)
	Adds the held weapon Artifact Uid to the list. More...

virtual void	ModSa (long index, long value)
	Modifies the player's current ability for a given Spell. More...

virtual void	ModSa (Spell spell, long value)
	Modifies the player's current ability for a given Spell. More...

	GameState ()

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)

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

	GameBase ()

Properties
virtual long	Ar `[get, set]`

virtual long	Cm `[get, set]`

virtual long	Ls `[get, set]`

virtual long	Ro `[get, set]`

virtual long	R2 `[get, set]`

virtual long	R3 `[get, set]`

virtual long	Sh `[get, set]`

virtual long	Die `[get, set]`

virtual long	Speed `[get, set]`

virtual bool	Vr `[get, set]`

virtual bool	Vm `[get, set]`

virtual bool	Va `[get, set]`

virtual bool	Vn `[get, set]`

virtual bool	MatureContent `[get, set]`

virtual bool	InteractiveFiction `[get, set]`

virtual bool	EnhancedCombat `[get, set]`

virtual bool	EnhancedParser `[get, set]`

virtual bool	IobjPronounAffinity `[get, set]`

virtual bool	ShowPronounChanges `[get, set]`

virtual bool	ShowFulfillMessages `[get, set]`

virtual long	CurrTurn `[get, set]`

virtual long	PauseCombatMs `[get, set]`

virtual long	PauseCombatActions `[get, set]`

virtual long	UsedWpnIdx `[get, set]`

virtual long[]	Sa `[get, set]`

virtual IList< long >	ImportedArtUids `[get, set]`

virtual IList< long >	HeldWpnUids `[get, set]`

virtual IEventHeap	BeforePrintPlayerRoomEventHeap `[get, set]`

virtual IEventHeap	AfterPrintPlayerRoomEventHeap `[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.IGameState
long	Ar `[get, set]`
	Gets or sets the Artifact Uid for the armor being worn by the player character (may be 0 if none exists). More...

long	Cm `[get, set]`
	Gets or sets the Monster Uid being used to represent the player character. More...

long	Ls `[get, set]`
	Gets or sets the Artifact Uid for the currently active LightSource (may be 0 if none exists). More...

long	Ro `[get, set]`
	Gets or sets the Room Uid for the player character's current location (may be 0 if in limbo). More...

long	R2 `[get, set]`
	Gets or sets the Room Uid for the location the player character is entering (during a movement operation). More...

long	R3 `[get, set]`
	Gets or sets the Room Uid for the location the player character is exiting (during a movement operation). More...

long	Sh `[get, set]`
	Gets or sets the Artifact Uid for the shield being worn by the player character (may be 0 if none exists). More...

long	Die `[get, set]`
	Gets or sets a value indicating the player character death status (-1=Quitting Game; 0=Alive; 1=Dead). More...

long	Speed `[get, set]`
	Gets or sets the number of rounds remaining before the player character's Speed spell expires. More...

bool	Vr `[get, set]`
	Gets or sets a value indicating whether Rooms should always be printed verbosely. More...

bool	Vm `[get, set]`
	Gets or sets a value indicating whether Monsters should always be printed verbosely. More...

bool	Va `[get, set]`
	Gets or sets a value indicating whether Artifacts should always be printed verbosely. More...

bool	Vn `[get, set]`
	Gets or sets a value indicating whether names for Monsters and Artifacts should always be printed verbosely. More...

bool	MatureContent `[get, set]`
	Gets or sets a value indicating whether mature content should be allowed during gameplay. More...

bool	InteractiveFiction `[get, set]`
	Gets or sets a value indicating whether the game is being played as traditional Interactive Fiction or an Eamon adventure. More...

bool	EnhancedCombat `[get, set]`
	Gets or sets a value indicating whether the game is using enhanced combat or traditional Eamon combat. More...

bool	EnhancedParser `[get, set]`
	Gets or sets a value indicating whether the game is using an enhanced parser or traditional Eamon parser. More...

bool	IobjPronounAffinity `[get, set]`
	Gets or sets a value indicating whether pronouns attach to the most recently used indirect or direct object (enhanced parser only). More...

bool	ShowPronounChanges `[get, set]`
	Gets or sets a value indicating whether the parser emits a message when it changes the object referred to by a pronoun. (enhanced parser only). More...

bool	ShowFulfillMessages `[get, set]`
	Gets or sets a value indicating whether the parser emits a message when it executes each command in a series (enhanced parser only). More...

long	CurrTurn `[get, set]`
	Gets or sets the current turn in the game; this is incremented after player command parsing but before execution. More...

long	PauseCombatMs `[get, set]`
	Gets or sets the number of milliseconds to pause between actions during a combat round. More...

long	PauseCombatActions `[get, set]`
	Gets or sets the number of actions to pause between during a combat round. More...

long	UsedWpnIdx `[get, set]`
	Gets or sets a value that indexes HeldWpnUids and indicates which weapon in that array is being used by the player in the game (Beginner's adventures only). More...

long[]	Sa `[get, set]`
	Gets or sets an array of player character Spell abilities that is updated during gameplay. More...

IList< long >	ImportedArtUids `[get, set]`
	Gets or sets a list of Artifact Uids corresponding to the Artifacts brought into the game by the player (armor, shield and weapons). More...

IList< long >	HeldWpnUids `[get, set]`
	Gets or sets a list of Artifact Uids corresponding to the weapons brought into the game by the player (Beginner's adventures only). More...

IEventHeap	BeforePrintPlayerRoomEventHeap `[get, set]`
	Gets or sets the data structure that holds events to be fired before the player character's current Room is printed. More...

IEventHeap	AfterPrintPlayerRoomEventHeap `[get, set]`
	Gets or sets the data structure that holds events to be fired after the player character's current Room is printed, but before the command prompt is displayed. More...

Constructor & Destructor Documentation

◆ GameState()

Eamon.Game.GameState.GameState ( )

Member Function Documentation

◆ CompareTo()

virtual int Eamon.Game.GameState.CompareTo ( IGameState gameState )

virtual

◆ Dispose()

override void Eamon.Game.GameState.Dispose ( bool disposing )

virtual

Implements Eamon.Game.GameBase.

◆ GetDTTL() [1/2]

virtual long Eamon.Game.GameState.GetDTTL	(	Friendliness	friendliness,
		long	roomUid = `0`
	)

virtual

Gets the total DmgTaken of Monsters with a specified Friendliness in a particular Room.

Parameters

friendliness	The Friendliness value.
roomUid	The Room Uid, or 0 for the player's current Room. (Optional)

This convenience wrapper should typically never be overridden in games. The other base method remarks are also applicable here.

Returns: A single summed DmgTaken value for all affected Monsters.

See also: GetDTTL(long, long)

Implements Eamon.Framework.IGameState.

◆ GetDTTL() [2/2]

virtual long Eamon.Game.GameState.GetDTTL	(	long	index,
		long	roomUid = `0`
	)

virtual

Gets the total DmgTaken of Monsters with a specified Friendliness in a particular Room.

Parameters

index	The Friendliness value expressed as a long datatype.
roomUid	The Room Uid, or 0 for the player's current Room. (Optional)

This method returns the summed damage taken for games using Ruleset Version 5 or 62; for others it returns 0. For group Monsters, the value added to the sum is the damage taken by the "current" group member. When the roomUid is omitted the player's current Room is used. This method can be overridden in games when necessary.

Returns: A single summed DmgTaken value for all affected Monsters.

See also: GetDTTL(Friendliness, long)

Implements Eamon.Framework.IGameState.

Reimplemented in TheVileGrimoireOfJaldial.Game.GameState.

◆ GetHeldWpnUid()

virtual long Eamon.Game.GameState.GetHeldWpnUid ( long index )

virtual

Gets the held weapon Artifact Uid at a given index.

Parameters

index The list index.

The HeldWpnUids list stores all weapon Artifacts brought into a Beginner's adventure. This method can be overridden in games when necessary.

Returns: The held weapon Artifact Uid.

Implements Eamon.Framework.IGameState.

◆ GetImportedArtUid()

virtual long Eamon.Game.GameState.GetImportedArtUid ( long index )

virtual

Gets the imported Artifact Uid at a given index.

Parameters

index The list index.

The ImportedArtUids list stores Artifacts imported by the player into the game. This method can be overridden in games when necessary.

Returns: The imported Artifact Uid.

Implements Eamon.Framework.IGameState.

◆ GetNBTL() [1/2]

virtual long Eamon.Game.GameState.GetNBTL	(	Friendliness	friendliness,
		long	roomUid = `0`
	)

virtual

Gets the total Hardiness of Monsters with a specified Friendliness in a particular Room.

Parameters

friendliness	The Friendliness value.
roomUid	The Room Uid, or 0 for the player's current Room. (Optional)

This convenience wrapper should typically never be overridden in games. The other base method remarks are also applicable here.

Returns: A single summed Hardiness value for all affected Monsters.

See also: GetNBTL(long, long)

Implements Eamon.Framework.IGameState.

◆ GetNBTL() [2/2]

virtual long Eamon.Game.GameState.GetNBTL	(	long	index,
		long	roomUid = `0`
	)

virtual

Gets the total Hardiness of Monsters with a specified Friendliness in a particular Room.

Parameters

index	The Friendliness value expressed as a long datatype.
roomUid	The Room Uid, or 0 for the player's current Room. (Optional)

For group Monsters, the value added to the sum is equal to (Hardiness * CurrGroupCount). When the roomUid is omitted the player's current Room is used. This method can be overridden in games when necessary.

Returns: A single summed Hardiness value for all affected Monsters.

See also: GetNBTL(Friendliness, long)

Implements Eamon.Framework.IGameState.

◆ GetSa() [1/2]

virtual long Eamon.Game.GameState.GetSa ( long index )

virtual

Gets the player's current ability for a given Spell.

Parameters

index The Spell value expressed as a long datatype.

The value changes during gameplay based on Spell usage and regeneration each round. This method can be overridden in games when necessary.

Returns: The current ability value for the Spell.

See also: GetSa(Spell)

Implements Eamon.Framework.IGameState.

◆ GetSa() [2/2]

virtual long Eamon.Game.GameState.GetSa ( Spell spell )

virtual

Gets the player's current ability for a given Spell.

Parameters

spell The Spell value.

This convenience wrapper should typically never be overridden in games. The other base method remarks are also applicable here.

Returns: The current ability value for the Spell.

See also: GetSa(long)

Implements Eamon.Framework.IGameState.

◆ ModSa() [1/2]

virtual void Eamon.Game.GameState.ModSa	(	long	index,
		long	value
	)

virtual

Modifies the player's current ability for a given Spell.

Parameters

index	The Spell value expressed as a long datatype.
value	The modifier to the current ability value.

The current ability value can be incremented or decremented during gameplay for any reason, based on the value being positive or negative. This method can be overridden in games when necessary.

See also: ModSa(Spell, long)

Implements Eamon.Framework.IGameState.

◆ ModSa() [2/2]

virtual void Eamon.Game.GameState.ModSa	(	Spell	spell,
		long	value
	)

virtual

Modifies the player's current ability for a given Spell.

Parameters

spell	The Spell value.
value	The modifier to the current ability value.

This convenience wrapper should typically never be overridden in games. The other base method remarks are also applicable here.

See also: ModSa(long, long)

Implements Eamon.Framework.IGameState.

◆ SetHeldWpnUid()

virtual void Eamon.Game.GameState.SetHeldWpnUid ( long value )

virtual

Adds the held weapon Artifact Uid to the list.

Parameters

value The new held weapon Artifact Uid.

The held weapon Artifact Uid is appended to the HeldWpnUids list. This method can be overridden in games when necessary.

Implements Eamon.Framework.IGameState.

◆ SetImportedArtUid()

virtual void Eamon.Game.GameState.SetImportedArtUid ( long value )

virtual

Adds the imported Artifact Uid to the list.

Parameters

value The new imported Artifact Uid.

The imported Artifact Uid is appended to the ImportedArtUids list. This method can be overridden in games when necessary.

Implements Eamon.Framework.IGameState.

◆ SetSa() [1/2]

virtual void Eamon.Game.GameState.SetSa	(	long	index,
		long	value
	)

virtual

Sets the player's current ability for a given Spell.

Parameters

index	The Spell value expressed as a long datatype.
value	The new current ability value.

The current ability value can be changed during gameplay for any reason. This method can be overridden in games when necessary.

See also: SetSa(Spell, long)

Implements Eamon.Framework.IGameState.

◆ SetSa() [2/2]

virtual void Eamon.Game.GameState.SetSa	(	Spell	spell,
		long	value
	)

virtual

Sets the player's current ability for a given Spell.

Parameters

spell	The Spell value.
value	The new current ability value.

This convenience wrapper should typically never be overridden in games. The other base method remarks are also applicable here.

See also: SetSa(long, long)

Implements Eamon.Framework.IGameState.

Property Documentation

◆ AfterPrintPlayerRoomEventHeap

virtual IEventHeap Eamon.Game.GameState.AfterPrintPlayerRoomEventHeap

getset

◆ Ar

virtual long Eamon.Game.GameState.Ar

getset

◆ BeforePrintPlayerRoomEventHeap

virtual IEventHeap Eamon.Game.GameState.BeforePrintPlayerRoomEventHeap

getset

◆ Cm

virtual long Eamon.Game.GameState.Cm

getset

◆ CurrTurn

virtual long Eamon.Game.GameState.CurrTurn

getset

◆ Die

virtual long Eamon.Game.GameState.Die

getset

◆ EnhancedCombat

virtual bool Eamon.Game.GameState.EnhancedCombat

getset

◆ EnhancedParser

virtual bool Eamon.Game.GameState.EnhancedParser

getset

◆ HeldWpnUids

virtual IList<long> Eamon.Game.GameState.HeldWpnUids

getset

◆ ImportedArtUids

virtual IList<long> Eamon.Game.GameState.ImportedArtUids

getset

◆ InteractiveFiction

virtual bool Eamon.Game.GameState.InteractiveFiction

getset

◆ IobjPronounAffinity

virtual bool Eamon.Game.GameState.IobjPronounAffinity

getset

◆ Ls

virtual long Eamon.Game.GameState.Ls

getset

◆ MatureContent

virtual bool Eamon.Game.GameState.MatureContent

getset

◆ PauseCombatActions

virtual long Eamon.Game.GameState.PauseCombatActions

getset

◆ PauseCombatMs

virtual long Eamon.Game.GameState.PauseCombatMs

getset

◆ R2

virtual long Eamon.Game.GameState.R2

getset

◆ R3

virtual long Eamon.Game.GameState.R3

getset

◆ Ro

virtual long Eamon.Game.GameState.Ro

getset

◆ Sa

virtual long [] Eamon.Game.GameState.Sa

getset

◆ Sh

virtual long Eamon.Game.GameState.Sh

getset

◆ ShowFulfillMessages

virtual bool Eamon.Game.GameState.ShowFulfillMessages

getset

◆ ShowPronounChanges

virtual bool Eamon.Game.GameState.ShowPronounChanges

getset

◆ Speed

virtual long Eamon.Game.GameState.Speed

getset

◆ UsedWpnIdx

virtual long Eamon.Game.GameState.UsedWpnIdx

getset

◆ Va

virtual bool Eamon.Game.GameState.Va

getset

◆ Vm

virtual bool Eamon.Game.GameState.Vm

getset

◆ Vn

virtual bool Eamon.Game.GameState.Vn

getset

◆ Vr

virtual bool Eamon.Game.GameState.Vr

getset

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

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

Public Member Functions

Properties

Constructor & Destructor Documentation

◆ GameState()

Member Function Documentation

◆ CompareTo()

◆ Dispose()

◆ GetDTTL() [1/2]

◆ GetDTTL() [2/2]

◆ GetHeldWpnUid()

◆ GetImportedArtUid()

◆ GetNBTL() [1/2]

◆ GetNBTL() [2/2]

◆ GetSa() [1/2]

◆ GetSa() [2/2]

◆ ModSa() [1/2]

◆ ModSa() [2/2]

◆ SetHeldWpnUid()

◆ SetImportedArtUid()

◆ SetSa() [1/2]

◆ SetSa() [2/2]

Property Documentation

◆ AfterPrintPlayerRoomEventHeap

◆ Ar

◆ BeforePrintPlayerRoomEventHeap

◆ Cm

◆ CurrTurn

◆ Die

◆ EnhancedCombat

◆ EnhancedParser

◆ HeldWpnUids

◆ ImportedArtUids

◆ InteractiveFiction

◆ IobjPronounAffinity

◆ Ls

◆ MatureContent

◆ PauseCombatActions

◆ PauseCombatMs

◆ R2

◆ R3

◆ Ro

◆ Sa

◆ Sh

◆ ShowFulfillMessages

◆ ShowPronounChanges

◆ Speed

◆ UsedWpnIdx

◆ Va

◆ Vm

◆ Vn

◆ Vr