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

Public Member Functions

virtual long GetMonsterTotalDmgTaken (long monsterUid)
 
virtual long GetEventState (EventState eventState)
 
virtual void SetMonsterTotalDmgTaken (long monsterUid, long value)
 
virtual void SetEventState (EventState eventState, long value)
 
 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 (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 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 ()
 

Properties

virtual long WoodenBridgeUseCounter [get, set]
 
virtual long TotalCentipedeCounter [get, set]
 
virtual long AttackingCentipedeCounter [get, set]
 
virtual long BedroomTurnCounter [get, set]
 
virtual long KitchenRiddleState [get, set]
 
virtual long NolanPuddingAttackOdds [get, set]
 
virtual long NolanRustMonsterAttackOdds [get, set]
 
virtual long MetalArmorArtifactUid [get, set]
 
virtual long[] MonsterTotalDmgTaken [get, set]
 
virtual long[] EventStates [get, set]
 
virtual bool HauntingSeen [get, set]
 
virtual bool UnseenApparitionMet [get, set]
 
virtual bool CharlottePeeks [get, set]
 
virtual bool CharlotteGreets [get, set]
 
virtual bool CharlotteDeathSeen [get, set]
 
virtual bool CharlotteMet [get, set]
 
virtual bool CharlotteBlackthornStory [get, set]
 
virtual bool CharlotteArtisansStory [get, set]
 
virtual bool CharlottePortraitGiven [get, set]
 
virtual bool CharlotteBonesGiven [get, set]
 
virtual bool CharlotteBonesPurified [get, set]
 
virtual bool CharlotteBonesBlessed [get, set]
 
virtual bool CharlotteRestInPeace [get, set]
 
virtual bool CharlotteReunited [get, set]
 
virtual bool MirrorPassphraseSpoken [get, set]
 
virtual bool HearthwatcherPassphraseSpoken [get, set]
 
virtual bool LsInGoldFound [get, set]
 
virtual bool LsUnderGoldFound [get, set]
 
virtual bool DiaryRead [get, set]
 
virtual bool ForgecraftCodexRead [get, set]
 
virtual bool WallMapRead [get, set]
 
virtual bool LadderUsed [get, set]
 
virtual bool BourbonAppeared [get, set]
 
virtual bool BourbonNoticed [get, set]
 
virtual bool DoorCreaksOpen [get, set]
 
virtual bool DartboardCreepsOut [get, set]
 
virtual bool FineClothingEnchanted [get, set]
 
virtual IDictionary< long, GuestRoomDataGuestRoomDictionary [get, set]
 
virtual IList< long > OpenWindowRoomUids [get, set]
 
virtual IList< long > ForgedArtifactUids [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 TheWayfarersInn.Framework.IGameState
long WoodenBridgeUseCounter [get, set]
 
long TotalCentipedeCounter [get, set]
 
long AttackingCentipedeCounter [get, set]
 
long BedroomTurnCounter [get, set]
 
long KitchenRiddleState [get, set]
 
long NolanPuddingAttackOdds [get, set]
 
long NolanRustMonsterAttackOdds [get, set]
 
long MetalArmorArtifactUid [get, set]
 
long[] MonsterTotalDmgTaken [get, set]
 
long[] EventStates [get, set]
 
bool HauntingSeen [get, set]
 
bool UnseenApparitionMet [get, set]
 
bool CharlottePeeks [get, set]
 
bool CharlotteGreets [get, set]
 
bool CharlotteDeathSeen [get, set]
 
bool CharlotteMet [get, set]
 
bool CharlotteBlackthornStory [get, set]
 
bool CharlotteArtisansStory [get, set]
 
bool CharlottePortraitGiven [get, set]
 
bool CharlotteBonesGiven [get, set]
 
bool CharlotteBonesPurified [get, set]
 
bool CharlotteBonesBlessed [get, set]
 
bool CharlotteRestInPeace [get, set]
 
bool CharlotteReunited [get, set]
 
bool MirrorPassphraseSpoken [get, set]
 
bool HearthwatcherPassphraseSpoken [get, set]
 
bool LsInGoldFound [get, set]
 
bool LsUnderGoldFound [get, set]
 
bool DiaryRead [get, set]
 
bool ForgecraftCodexRead [get, set]
 
bool WallMapRead [get, set]
 
bool LadderUsed [get, set]
 
bool BourbonAppeared [get, set]
 
bool BourbonNoticed [get, set]
 
bool DoorCreaksOpen [get, set]
 
bool DartboardCreepsOut [get, set]
 
bool FineClothingEnchanted [get, set]
 
IDictionary< long, GuestRoomDataGuestRoomDictionary [get, set]
 
IList< long > OpenWindowRoomUids [get, set]
 
IList< long > ForgedArtifactUids [get, set]
 

Constructor & Destructor Documentation

◆ GameState()

TheWayfarersInn.Game.GameState.GameState ( )

Member Function Documentation

◆ GetEventState()

virtual long TheWayfarersInn.Game.GameState.GetEventState ( EventState  eventState)
virtual

Parameters
eventState
Returns

Implements TheWayfarersInn.Framework.IGameState.

◆ GetMonsterTotalDmgTaken()

virtual long TheWayfarersInn.Game.GameState.GetMonsterTotalDmgTaken ( long  monsterUid)
virtual

Parameters
monsterUid
Returns

Implements TheWayfarersInn.Framework.IGameState.

◆ SetEventState()

virtual void TheWayfarersInn.Game.GameState.SetEventState ( EventState  eventState,
long  value 
)
virtual

Parameters
eventState
value

Implements TheWayfarersInn.Framework.IGameState.

◆ SetMonsterTotalDmgTaken()

virtual void TheWayfarersInn.Game.GameState.SetMonsterTotalDmgTaken ( long  monsterUid,
long  value 
)
virtual

Parameters
monsterUid
value

Implements TheWayfarersInn.Framework.IGameState.

Property Documentation

◆ AttackingCentipedeCounter

virtual long TheWayfarersInn.Game.GameState.AttackingCentipedeCounter
getset

◆ BedroomTurnCounter

virtual long TheWayfarersInn.Game.GameState.BedroomTurnCounter
getset

◆ BourbonAppeared

virtual bool TheWayfarersInn.Game.GameState.BourbonAppeared
getset

◆ BourbonNoticed

virtual bool TheWayfarersInn.Game.GameState.BourbonNoticed
getset

◆ CharlotteArtisansStory

virtual bool TheWayfarersInn.Game.GameState.CharlotteArtisansStory
getset

◆ CharlotteBlackthornStory

virtual bool TheWayfarersInn.Game.GameState.CharlotteBlackthornStory
getset

◆ CharlotteBonesBlessed

virtual bool TheWayfarersInn.Game.GameState.CharlotteBonesBlessed
getset

◆ CharlotteBonesGiven

virtual bool TheWayfarersInn.Game.GameState.CharlotteBonesGiven
getset

◆ CharlotteBonesPurified

virtual bool TheWayfarersInn.Game.GameState.CharlotteBonesPurified
getset

◆ CharlotteDeathSeen

virtual bool TheWayfarersInn.Game.GameState.CharlotteDeathSeen
getset

◆ CharlotteGreets

virtual bool TheWayfarersInn.Game.GameState.CharlotteGreets
getset

◆ CharlotteMet

virtual bool TheWayfarersInn.Game.GameState.CharlotteMet
getset

◆ CharlottePeeks

virtual bool TheWayfarersInn.Game.GameState.CharlottePeeks
getset

◆ CharlottePortraitGiven

virtual bool TheWayfarersInn.Game.GameState.CharlottePortraitGiven
getset

◆ CharlotteRestInPeace

virtual bool TheWayfarersInn.Game.GameState.CharlotteRestInPeace
getset

◆ CharlotteReunited

virtual bool TheWayfarersInn.Game.GameState.CharlotteReunited
getset

◆ DartboardCreepsOut

virtual bool TheWayfarersInn.Game.GameState.DartboardCreepsOut
getset

◆ DiaryRead

virtual bool TheWayfarersInn.Game.GameState.DiaryRead
getset

◆ DoorCreaksOpen

virtual bool TheWayfarersInn.Game.GameState.DoorCreaksOpen
getset

◆ EventStates

virtual long [] TheWayfarersInn.Game.GameState.EventStates
getset

◆ FineClothingEnchanted

virtual bool TheWayfarersInn.Game.GameState.FineClothingEnchanted
getset

◆ ForgecraftCodexRead

virtual bool TheWayfarersInn.Game.GameState.ForgecraftCodexRead
getset

◆ ForgedArtifactUids

virtual IList<long> TheWayfarersInn.Game.GameState.ForgedArtifactUids
getset

◆ GuestRoomDictionary

virtual IDictionary<long, GuestRoomData> TheWayfarersInn.Game.GameState.GuestRoomDictionary
getset

◆ HauntingSeen

virtual bool TheWayfarersInn.Game.GameState.HauntingSeen
getset

◆ HearthwatcherPassphraseSpoken

virtual bool TheWayfarersInn.Game.GameState.HearthwatcherPassphraseSpoken
getset

◆ KitchenRiddleState

virtual long TheWayfarersInn.Game.GameState.KitchenRiddleState
getset

◆ LadderUsed

virtual bool TheWayfarersInn.Game.GameState.LadderUsed
getset

◆ LsInGoldFound

virtual bool TheWayfarersInn.Game.GameState.LsInGoldFound
getset

◆ LsUnderGoldFound

virtual bool TheWayfarersInn.Game.GameState.LsUnderGoldFound
getset

◆ MetalArmorArtifactUid

virtual long TheWayfarersInn.Game.GameState.MetalArmorArtifactUid
getset

◆ MirrorPassphraseSpoken

virtual bool TheWayfarersInn.Game.GameState.MirrorPassphraseSpoken
getset

◆ MonsterTotalDmgTaken

virtual long [] TheWayfarersInn.Game.GameState.MonsterTotalDmgTaken
getset

◆ NolanPuddingAttackOdds

virtual long TheWayfarersInn.Game.GameState.NolanPuddingAttackOdds
getset

◆ NolanRustMonsterAttackOdds

virtual long TheWayfarersInn.Game.GameState.NolanRustMonsterAttackOdds
getset

◆ OpenWindowRoomUids

virtual IList<long> TheWayfarersInn.Game.GameState.OpenWindowRoomUids
getset

◆ TotalCentipedeCounter

virtual long TheWayfarersInn.Game.GameState.TotalCentipedeCounter
getset

◆ UnseenApparitionMet

virtual bool TheWayfarersInn.Game.GameState.UnseenApparitionMet
getset

◆ WallMapRead

virtual bool TheWayfarersInn.Game.GameState.WallMapRead
getset

◆ WoodenBridgeUseCounter

virtual long TheWayfarersInn.Game.GameState.WoodenBridgeUseCounter
getset

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