Eamon CS  3.1.0
TheVileGrimoireOfJaldial.Game.GameState Class Reference
Inheritance diagram for TheVileGrimoireOfJaldial.Game.GameState:
Eamon.Game.GameState TheVileGrimoireOfJaldial.Framework.IGameState Eamon.Game.GameBase Eamon.Framework.IGameState Eamon.Framework.IGameState Eamon.Framework.IGameBase Eamon.Framework.IGameBase Eamon.Framework.IGameBase

Public Member Functions

override long GetDTTL (long index, long roomUid=0)
 Gets the total DmgTaken of Monsters with a specified Friendliness in a particular Room. More...
 
virtual bool IsNightTime ()
 
virtual bool IsDayTime ()
 
virtual bool IsRaining ()
 
virtual bool IsFoggy ()
 
virtual bool IsFoggyHours ()
 
virtual bool GetSecretDoor (long index)
 
virtual void SetSecretDoor (long index, bool value)
 
virtual void SetFoggyRoomWeatherIntensity (Framework.IRoom room)
 
 GameState ()
 
- Public Member Functions inherited from Eamon.Game.GameState
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 (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 ArtifactUid at a given index. More...
 
virtual long GetHeldWpnUid (long index)
 Gets the held weapon ArtifactUid 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 ArtifactUid to the list. More...
 
virtual void SetHeldWpnUid (long value)
 Adds the held weapon ArtifactUid 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 ()
 
- Public Member Functions inherited from TheVileGrimoireOfJaldial.Framework.IGameState
void SetFoggyRoomWeatherIntensity (IRoom room)
 

Properties

virtual long FoggyRoomWeatherIntensity [get, set]
 
virtual long PlayerResurrections [get, set]
 
virtual long PlayerHardinessPointsDrained [get, set]
 
virtual long BloodnettleVictimUid [get, set]
 
virtual long EfreetiSummons [get, set]
 
virtual long LightningBolts [get, set]
 
virtual long IceBolts [get, set]
 
virtual long MentalBlasts [get, set]
 
virtual long MysticMissiles [get, set]
 
virtual long FireBalls [get, set]
 
virtual long ClumsySpells [get, set]
 
virtual long TorchRounds [get, set]
 
virtual long Minute [get, set]
 
virtual long Hour [get, set]
 
virtual long Day [get, set]
 
virtual long WeatherIntensity [get, set]
 
virtual long WeatherDuration [get, set]
 
virtual WeatherType WeatherType [get, set]
 
virtual long WeatherFreqPct [get, set]
 
virtual long EncounterFreqPct [get, set]
 
virtual long FlavorFreqPct [get, set]
 
virtual bool GriffinAngered [get, set]
 
virtual bool GiantCrayfishKilled [get, set]
 
virtual bool WaterWeirdKilled [get, set]
 
virtual bool EfreetiKilled [get, set]
 
virtual bool AmoebaAppeared [get, set]
 
virtual bool ShowCombatDamage [get, set]
 
virtual bool ExitDirNames [get, set]
 
virtual bool[] SecretDoors [get, set]
 
virtual IDictionary< long, long > ParalyzedTargets [get, set]
 
virtual IDictionary< long, IList< long > > ClumsyTargets [get, set]
 
- Properties inherited from Eamon.Game.GameState
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 ArtifactUid for the armor being worn by the player character (may be 0 if none exists). More...
 
long Cm [get, set]
 Gets or sets the MonsterUid being used to represent the player character. More...
 
long Ls [get, set]
 Gets or sets the ArtifactUid for the currently active LightSource (may be 0 if none exists). More...
 
long Ro [get, set]
 Gets or sets the RoomUid for the player character's current location (may be 0 if in limbo). More...
 
long R2 [get, set]
 Gets or sets the RoomUid for the location the player character is entering (during a movement operation). More...
 
long R3 [get, set]
 Gets or sets the RoomUid for the location the player character is exiting (during a movement operation). More...
 
long Sh [get, set]
 Gets or sets the ArtifactUid 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 ArtifactUids 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 ArtifactUids 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...
 
- Properties inherited from TheVileGrimoireOfJaldial.Framework.IGameState
long FoggyRoomWeatherIntensity [get, set]
 
long PlayerResurrections [get, set]
 
long PlayerHardinessPointsDrained [get, set]
 
long BloodnettleVictimUid [get, set]
 
long EfreetiSummons [get, set]
 
long LightningBolts [get, set]
 
long IceBolts [get, set]
 
long MentalBlasts [get, set]
 
long MysticMissiles [get, set]
 
long FireBalls [get, set]
 
long ClumsySpells [get, set]
 
long TorchRounds [get, set]
 
long Minute [get, set]
 
long Hour [get, set]
 
long Day [get, set]
 
long WeatherIntensity [get, set]
 
long WeatherDuration [get, set]
 
WeatherType WeatherType [get, set]
 
long WeatherFreqPct [get, set]
 
long EncounterFreqPct [get, set]
 
long FlavorFreqPct [get, set]
 
bool GriffinAngered [get, set]
 
bool GiantCrayfishKilled [get, set]
 
bool WaterWeirdKilled [get, set]
 
bool EfreetiKilled [get, set]
 
bool AmoebaAppeared [get, set]
 
bool ShowCombatDamage [get, set]
 
bool ExitDirNames [get, set]
 
bool[] SecretDoors [get, set]
 
IDictionary< long, long > ParalyzedTargets [get, set]
 
IDictionary< long, IList< long > > ClumsyTargets [get, set]
 

Constructor & Destructor Documentation

◆ GameState()

TheVileGrimoireOfJaldial.Game.GameState.GameState ( )

Member Function Documentation

◆ GetDTTL()

override long TheVileGrimoireOfJaldial.Game.GameState.GetDTTL ( long  index,
long  roomUid = 0 
)
virtual

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

Parameters
indexThe Friendliness value expressed as a long datatype.
roomUidThe 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)

Reimplemented from Eamon.Game.GameState.

◆ GetSecretDoor()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.GetSecretDoor ( long  index)
virtual

◆ IsDayTime()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.IsDayTime ( )
virtual

◆ IsFoggy()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.IsFoggy ( )
virtual

◆ IsFoggyHours()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.IsFoggyHours ( )
virtual

◆ IsNightTime()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.IsNightTime ( )
virtual

◆ IsRaining()

virtual bool TheVileGrimoireOfJaldial.Game.GameState.IsRaining ( )
virtual

◆ SetFoggyRoomWeatherIntensity()

virtual void TheVileGrimoireOfJaldial.Game.GameState.SetFoggyRoomWeatherIntensity ( Framework.IRoom  room)
virtual

◆ SetSecretDoor()

virtual void TheVileGrimoireOfJaldial.Game.GameState.SetSecretDoor ( long  index,
bool  value 
)
virtual

Property Documentation

◆ AmoebaAppeared

virtual bool TheVileGrimoireOfJaldial.Game.GameState.AmoebaAppeared
getset

◆ BloodnettleVictimUid

virtual long TheVileGrimoireOfJaldial.Game.GameState.BloodnettleVictimUid
getset

◆ ClumsySpells

virtual long TheVileGrimoireOfJaldial.Game.GameState.ClumsySpells
getset

◆ ClumsyTargets

virtual IDictionary<long, IList<long> > TheVileGrimoireOfJaldial.Game.GameState.ClumsyTargets
getset

◆ Day

virtual long TheVileGrimoireOfJaldial.Game.GameState.Day
getset

◆ EfreetiKilled

virtual bool TheVileGrimoireOfJaldial.Game.GameState.EfreetiKilled
getset

◆ EfreetiSummons

virtual long TheVileGrimoireOfJaldial.Game.GameState.EfreetiSummons
getset

◆ EncounterFreqPct

virtual long TheVileGrimoireOfJaldial.Game.GameState.EncounterFreqPct
getset

◆ ExitDirNames

virtual bool TheVileGrimoireOfJaldial.Game.GameState.ExitDirNames
getset

◆ FireBalls

virtual long TheVileGrimoireOfJaldial.Game.GameState.FireBalls
getset

◆ FlavorFreqPct

virtual long TheVileGrimoireOfJaldial.Game.GameState.FlavorFreqPct
getset

◆ FoggyRoomWeatherIntensity

virtual long TheVileGrimoireOfJaldial.Game.GameState.FoggyRoomWeatherIntensity
getset

◆ GiantCrayfishKilled

virtual bool TheVileGrimoireOfJaldial.Game.GameState.GiantCrayfishKilled
getset

◆ GriffinAngered

virtual bool TheVileGrimoireOfJaldial.Game.GameState.GriffinAngered
getset

◆ Hour

virtual long TheVileGrimoireOfJaldial.Game.GameState.Hour
getset

◆ IceBolts

virtual long TheVileGrimoireOfJaldial.Game.GameState.IceBolts
getset

◆ LightningBolts

virtual long TheVileGrimoireOfJaldial.Game.GameState.LightningBolts
getset

◆ MentalBlasts

virtual long TheVileGrimoireOfJaldial.Game.GameState.MentalBlasts
getset

◆ Minute

virtual long TheVileGrimoireOfJaldial.Game.GameState.Minute
getset

◆ MysticMissiles

virtual long TheVileGrimoireOfJaldial.Game.GameState.MysticMissiles
getset

◆ ParalyzedTargets

virtual IDictionary<long, long> TheVileGrimoireOfJaldial.Game.GameState.ParalyzedTargets
getset

◆ PlayerHardinessPointsDrained

virtual long TheVileGrimoireOfJaldial.Game.GameState.PlayerHardinessPointsDrained
getset

◆ PlayerResurrections

virtual long TheVileGrimoireOfJaldial.Game.GameState.PlayerResurrections
getset

◆ SecretDoors

virtual bool [] TheVileGrimoireOfJaldial.Game.GameState.SecretDoors
getset

◆ ShowCombatDamage

virtual bool TheVileGrimoireOfJaldial.Game.GameState.ShowCombatDamage
getset

◆ TorchRounds

virtual long TheVileGrimoireOfJaldial.Game.GameState.TorchRounds
getset

◆ WaterWeirdKilled

virtual bool TheVileGrimoireOfJaldial.Game.GameState.WaterWeirdKilled
getset

◆ WeatherDuration

virtual long TheVileGrimoireOfJaldial.Game.GameState.WeatherDuration
getset

◆ WeatherFreqPct

virtual long TheVileGrimoireOfJaldial.Game.GameState.WeatherFreqPct
getset

◆ WeatherIntensity

virtual long TheVileGrimoireOfJaldial.Game.GameState.WeatherIntensity
getset

◆ WeatherType

virtual WeatherType TheVileGrimoireOfJaldial.Game.GameState.WeatherType
getset

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