SaveGame Members

The SaveGame type exposes the following members.

Constructors


  Name Description
Public method SaveGame
Creates a new game.

Methods


  Name Description
Public method AcidDam
Public method Acquirement
Public method ActivateChestTrap
Public method ActivateDreadCurse
Public method ActivateHiSummon
Public method AddItemToGrid
Public method AddItemToMonster
Public method AggravateMonsters
Public method Alchemy
Public method AllocHorde
Public method AllocMonster
Public method AlterReality
Public method AnyKey
Prints a 'press any key' message and waits for a key press
Public method ApplyDisenchant
Public method ApplyNexus
Public method ArtifactScroll
Public method AskforAux
Public method BanishEvil
Public method BanishMonsters
Public method BashClosedDoor
Public method BlessWeapon
Public method BrandBolts
Give a fire brand to a set of bolts we're carrying
Public method BrandWeapon
Give a brand type to our melee weapon
Public method CallChaos
Public method CallTheVoid
Blast energy in all directions
Public method Carnage
Public method CaveSetBackground
Public method CaveSetFeat
Public method CaveValidBold
Public method ChangeRace
Public method CharacterGeneration
Public method CharmAnimal
Public method CharmAnimals
Public method CharmMonster
Public method CharmMonsters
Public method CheckExperience
Public method CheckIfRacialPowerWorks
Check to see if a racial power works
Public method ChestCheck
Checks the stack of items at a grid coordinate for a chest and returns the first chest item found. Returns null, if no chest is found.
Public method CleanShot
Use the same algorithm that we use for missiles to see if we have a clean shot between two locations, but without actually shooting anything
Public method CloneMonster
Public method CloseDoor
Close a door
Public method ColdDam
Public method CompactMonsters
Public method ConfuseMonster
Public method ConfuseMonsters
Public method ControlOneUndead
Public method CoordsToDir
Public method CountChests
Count the number of chests adjacent to the player, filling in a map coordinate with the location of the last one found
Public method CountClosedDoors
Count the number of closed doors around the player, filling in a map coordinate with the location of the last one found
Public method CountKnownTraps
Get the number of known traps around the player, storing the map coordinate of the last one found
Public method CountOpenDoors
Count the number of open doors around the players location, puting the location of the last one found into a map coordinate
Public method Static member CreateNew
Creates a new game that can be played.
Public method CreatePhlogiston
Create phlogiston to refill a lantern or torch with
Public method CurseArmour
Heavily curse the players armour
Public method CurseEquipment
Public method CurseWeapon
Heavily curse the player's weapon
Public method DamageMonster
Public method DeathRay
Public method DecreaseAbilityScore
Public method DeleteMonster
Public method DeleteMonsterByIndex
Public method DeleteObject(Int32, Int32)
Removes all items from a grid tile.
Public method DeleteObject(Item)
Public method DescribeWieldLocation
Public method DestroyArea
Public method DestroyDoor
Public method DestroyDoorsTouch
Public method DetectAll
Public method DetectDoors
Public method DetectMonstersEvil
Public method DetectMonstersInvis
Public method DetectMonstersNonliving
Public method DetectMonstersNormal
Public method DetectObjectsGold
Public method DetectObjectsMagic
Public method DetectObjectsNormal
Public method DetectStairs
Public method DetectTraps
Public method DetectTreasure
Public method DisarmChest
Disarm a chest at a given location
Public method DisarmTrap(Int32)
Public method DisarmTrap(Int32, Int32)
Disarm a trap on the floor
Public method DispelDemons
Public method DispelEvil
Public method DispelGood
Public method DispelLiving
Public method DispelMonsters
Public method DispelUndead
Public method DisplayAPlusB
Public method DisplayMap
Public method DisplayPlayerEquippy
Display the 'Equippy' characters (the visual representation of a characters' equipment)
Public method DisplayRealmInfo
Public method DisplayStatBonus
Public method DisplayWildMap
Public method Distance
Public method Disturb
Interrupts a repeat command. This is known as disturbing the player.
Public method DoCmdChannel
Channel mana to power an item instead
Public method DoCmdEquip
Public method DoCmdFeeling
Public method DoCmdLocate
Public method DoCmdLook
Public method DoCmdPopup
Public method DoCmdRedraw
Public method DoCmdRun
Public method DoCmdSaveGame
Public method DoCmdSearch
Public method DoCmdStay
Public method DoCmdSummonHorde
Public method DoCmdThrow
Public method DoCmdWalk
Public method DoCmdWizardBolt
Public method DoCmdWizBamf
Public method DoCmdWizChange
Public method DoCmdWizNamed
Public method DoCmdWizNamedFriendly
Public method DoCmdWizSummon
Public method DoCmdWizZap
Public method DoDropCmd
Public method DoorCreation
Public method DoToggleSearch
Public method DrainLife
Returns true, if the drain life actally hits and affects a monster.
Public method DropNear
Public method Earthquake
Public method ElderSign
Public method ElderSignCreation
Public method ElecDam
Public method Elevation
Public method Enchant
Public method EnchantItem
Public method ExciseObject
Public method FearMonster
Public method FindHomeStore
Public method FireBall
Public method FireBeam
Public method FireBolt
Public method FireBoltOrBeam
Public method FireDam
Public method GainExperience
Public method GainLevelReward
Public method GenerateNewLevel
Public method GetAbilitiesAsItemFlags
Public method GetAhw
Public method GetCheck
Public method GetCom
Public method GetDirectionNoAim
Public method GetDirectionNoAutoAim
Public method GetDirectionWithAim
Public method GetExtra
Public method GetHistory
Create a background for a character by stringing together randomised text fragments based on their race
Public method GetInventoryItem
Returns an item from the players inventory. If there is no item at the desired slot, null is returned.
Public method GetItemOkay
Public method GetKeymapDir
Public method GetMessageText
Public method GetMoney
Public method GetMonNum
Returns the index of a monster.
Public method GetMonsterIndex
Returns the index of this monster in the monster list. This method is provided for backwards compatability and should NOT be used. Will be deleted when no longer needed.
Public method GetMonsterIndexFromName
Public method GetPageOfGameMessages
Public method GetPets
Public method GetQuantity
Public method GetQuestMonster
Public method GetQuestNumber
Returns the quest number for the current dungeon and the current
Public method GetRandomBizarreMonsterSelector
Public method GetScore
Public method GetSpell
Returns an spell selected by the player. If the player doesn't have any spells capable of being selected, false is returned; otherwise the spell selected by the user is returned on the output parameter. If the user cancels the selection, a true value is returned and the output spell parameter is set to null.
Public method GetSpike
Find a spike in the player's inventory
Public method GetStats
Public method GetString
Public method GetWhichStore
Returns the specific store that the player is currently in. Returns null, if the player is not detected as being in a store.
Public method GridOpenNoItem
Public method GridOpenNoItemOrCreature
Public method GridPassable
Public method GridPassableNoCreature
Public method HandleStuff
Public method HasteMonsters
Public method HealMonster
Public method HealthTrack
Public method IdentifyFully
Public method IdentifyItem
Public method IdentifyPack
Public method InBounds
Public method InBounds2
Public method Inkey
Returns the next keypress. The behavior of this function is modified by other class properties
Public method InputPlayerName
Public method InvenCarry
Public method InvenCarryOkay
Public method InvenDamage
Public method InvenDrop(Item, Int32)
Public method InvenDrop(Int32, Int32)
Public method InvenItemDescribe
Public method InvenItemIncrease
Public method InvenItemOptimize
Public method InvenTakeoff(Item, Int32)
Public method InvenTakeoff(Int32, Int32)
Public method IsQuest
Public method ItemFilterActivatable
Return whether or not an item can be activated
Public method ItemFilterHighLevelBook
Return whether or not an item is a high level book
Public method ItemMatchesFilter
Public method LabelToEquip
Public method LabelToInven
Public method LightArea
Public method LightLine
Public method Static member LoadGame
Retrieves a save game from persistent storage. If no persistent storage is specified, a new game is created. This static method is used as a factory to generate the SaveGame object that can be played using the Play method. This is the only static method.
Public method LoreDoProbe
Public method LoreTreasure
Public method Los
Public method LoseAllInfo
Public method LoseExperience
Public method MakeGold
Public method MakeIslandContours
Public method MakeObject
Public method MapArea
Public method MapInfo
Public method MartialArtistEmptyHands
Public method MartialArtistHeavyArmour
Public method MassCarnage
Public method MenuDisplay
Public method MessageBoxShow
Public method MessageFlush
Indicates the beginning of a new command being issues by the player. All messages that have been rendered to the player are batched together and stores into a fixed length queue. This MessageFlush is called in the RequestCommand method during the dungeon game play and when in a store.
Public method MessageNum
Public method MessagePain
Public method MindblastMonsters
Public method MonsterDeath
Public method MoveCursorRelative
Locate the cursor in the viewport at a specific level grid x, y coordinate.
Public method MoveHouse
Public method MoveOneStepTowards
Public method MsgPrint
Public method MultiplyMonster
Public method NavigateNextStep
Check if we can and should move forward on our current path, adjusting our path if necessary to go around corners and stopping if the way forward becomes ambiguous or we see a monster.
Public method NoLight
Public method NoteSpot
Public method NoticeStuff
Public method OkaySpells
Public method OpenChest
Public method OpenDoor
Open a door at a given location
Public method PanelBounds
Public method PanelBoundsCenter
Public method PanelContains
Public method Pause
Pauses for a duration
Public method PickTrap
Public method PickUpItems
Step onto a grid with an item, possibly picking it up and possibly stomping on it
Public method PlaceGold
Public method PlaceMonster
Public method PlaceMonsterAux
Public method PlaceMonsterByIndex
Public method PlaceObject
Public method PlaceTrap
Public method Play
Plays the current game.
Public method PlayerAttackMonster
Have the player attack a monster
Public method PlayerBirthQuests
Public method PlayerCanSeeBold
Public method PlayerCheckRangedHitOnMonster
Check whether a ranged attack by the player hits a monster
Public method PlayerCriticalRanged
Work out whether the player's missile attack was a critical hit
Public method PlayerHasLosBold
Public method PlayMusic
Public method PlaySound
Plays a sound
Public method PolyMonster
Public method PolymorphMonster
Public method PolymorphWounds
Public method PrintCharacterAtMapLocation
Public method PrintQuestMessage
Public method PrintSpells(array<Int32>[]()[][], Int32, Int32, Nullable<(Of <<'(Realm>)>>))
Public method PrintSpells(array<Spell>[]()[][], Int32, Int32)
Public method Probing
Public method ProcessAllMonsters
Process all the monsters on the level
Public method ProcessCommand
Process the player's latest command
Public method Project
Returns true, if the projectile actally hits and affects a monster.
Public method Projectable
Public method PutQuestMonster
Public method QuestDiscovery
Public method Quit
Public method RandomItemType
Public method RandomizeInventory
Public method RealmNames
Public method RecenterScreenAroundPlayer
Public method Recharge
Public method RedrawSingleLocation
Public method RegenerateHealth
Public method RegenerateMana
Public method RemoveAllCurse
Public method RemoveCurse
Public method ReplacePet
Public method ReplacePets
Public method ReplaceSecretDoor
Public method ReportChargeUsage
Public method ReportMagics
Public method RequestCommand
Public method RerollHitPoints
Public method ResetGuardians
Public method ResetUniqueOnlyGuardianStatus
Public method RestoreAbilityScore
Public method RestoreHealth
Public method RestoreLevel
Public method RevertTileToBackground
Public method RunOneStep
Run a single step
Public method RunScript<(Of <<'(T>)>>)
Public method Rustproof
Make a piece of armour immune to acid damage, removing any penalty at the same time
Public method SavePlayer
Serializes an object and uses the persistent storage services to write the object to the desired facilities.
Public method Scatter
Public method SeeWall
Check whether we can see a wall in a certain direction from a point
Public method SelectItem
Returns an item selected by the player. If the player doesn't have any items capable of being selected, false is returned; otherwise the item selected by the user is returned on the output parameter. If the user cancels the selection, a true value is returned and the output item parameter is set to null.
Public method SelfKnowledge
Public method SenseInventory
Public method SetAcidDestroy
Protected method SetBackground
Public method SetColdDestroy
Public method SetElecDestroy
Public method SetFireDestroy
Public method SetFood
Public method SetInventoryItem
Public method ShowEquip
Public method ShowInven
Shows the players inventory on the screen. Returns false, if the player has nothing in their inventory.
Public method ShowManual
Public method ShuffleAbilityScores
Public method SleepMonster
Public method SleepMonsters
Public method SleepMonstersTouch
Public method SlowMonster
Public method SlowMonsters
Public method SpeedMonster
Public method SpellOkay(Spell, Boolean)
Public method SpellOkay(Int32, Boolean, Boolean)
Public method StairCreation
Public method StartRun
Initialise the navigator with a direction
Public method StasisMonster
Public method StasisMonsters
Public method Studies<(Of <<'(T>)>>)
Badly formed XML comment.
Public method StunMonster
Public method StunMonsters
Public method SummonItem
Summon an item to the player via telekinesis
Public method SummonPossible
Check whether there's room to summon something next to a location
Public method SummonReaver
Public method SummonSpecific
Public method SummonSpecificFriendly
Public method TakeHit
Public method TargetOkay
Public method TargetSet
Public method TeleportMonster
Public method TeleportPlayer
Public method TeleportPlayerLevel
Public method TeleportPlayerTo
Public method TeleportSwap
Public method TgtPt
Public method ToggleRecall
Public method TrapCreation
Public method TryDecreasingAbilityScore
Public method TryIncreasingAbilityScore
Public method TryRestoringAbilityScore
Public method TunnelThroughTile
Tunnel through a grid tile
Public method TurnEvil
Public method TurnMonsters
Public method UnlightArea
Public method UnlightRoom
Public method UpdateMonsterVisibility
Public method UpdateScreen
Update the screen using a double buffer, drawing all queued print and erase requests.
Public method UpdateSmartLearn
Public method UpdateStuff
Public method WallBreaker
Public method WallStone
Public method WallToMud
Public method Winner
Public method WipeMList
Public method WizardLock
Public method WizCreateNamedArt
Public method WizDark
Public method WizLight
Public method YellowSign

Fields


  Name Description
Public field _invenCnt
Public field _prevCharacterClass
Represents the previous character class.
Public field _prevGeneration
Public field _prevName
Public field _prevPrimaryRealm
Public field _prevRace
Returns the race of the previous character. Used as a default during the birthing process. Set to HumanRace if there is no previous character. Returns null, before the birthing process is started.
Public field _prevSecondaryRealm
Public field _prevSex
Public field AbilityScores
Public field Age
Public field AllocKindSize
Public field AllocKindTable
Public field AllocRaceSize
Public field AllocRaceTable
Public field AmmunitionItemCategory
Public field ArmourClassBonus
Public field AttackBonus
Public field BaseArmourClass
Public field BaseCharacterClass
Represents the character class of the player. Will be null prior to the character class birth selection.
Public field CameFrom
Public field Static member CentMax
Public field CharacterXtra
Public field CommandArgument
Public field CommandDirection
Public field CommandRepeat
Public field Configuration
Public field ConsoleViewPort
Returns the object that the calling application provided to be used to connect the game input and output to the calling application.
Public field CreateDownStair
Public field CreateUpStair
Public field CurDungeon
Public field CurHgt
Appears to be the height of the level.
Public field CurrentCommand
Public field CurrentDepth
Public field CurrentlyActingMonster
Public field CurrentRunDirection
The direction the player is currently running in
Public field CurTown
Public field CurWid
Appears to be the width of the level.
Public field DamageBonus
Public field DangerFeeling
Public field DangerRating
Public field DiedFrom
Public field DisplayedArmourClassBonus
Public field DisplayedAttackBonus
Public field DisplayedBaseArmourClass
Public field DisplayedDamageBonus
Public field Dna
Public field Static member DoorMax
Public field DunBias
Public field Static member DungeonCount
Public field DungeonDifficulty
Public field Energy
Public field EnergyUse
Public field ExperienceMultiplier
Public field ExperiencePoints
Public field ExPlayer
Public field Food
Public field FractionalExperiencePoints
Public field FractionalHealth
Public field FractionalMana
Public field FullScreenOverlay
Set to indicate that there is a full screen overlay covering the normally updated locations
Public field GameTime
Public field Gender
Public field Generation
Public field GetFirstLevelMutation
Public field GooPatron
Public field Grid
Public field HackMind
Public field HasAcidImmunity
Public field HasAcidResistance
Public field HasAggravation
Public field HasAntiMagic
Public field HasAntiTeleport
Public field HasAntiTheft
Public field HasBlessedBlade
Public field HasBlindnessResistance
Public field HasChaosResistance
Public field HasColdImmunity
Public field HasColdResistance
Public field HasConfusingTouch
Public field HasConfusionResistance
Public field HasDarkResistance
Public field HasDisenchantResistance
Public field HasElementalVulnerability
Public field HasExperienceDrain
Public field HasExtraMight
Public field HasFearResistance
Public field HasFeatherFall
Public field HasFireImmunity
Public field HasFireResistance
Public field HasFireShield
Public field HasFreeAction
Public field HasGlow
Public field HasHeavyBow
Public field HasHeavyWeapon
Public field HasHoldLife
Public field HasLightningImmunity
Public field HasLightningResistance
Public field HasLightningShield
Public field HasLightResistance
Public field HasNetherResistance
Public field HasNexusResistance
Public field HasPoisonResistance
Public field HasQuakeWeapon
Public field HasRandomTeleport
Public field HasReflection
Public field HasRegeneration
Public field HasRestrictingArmour
Public field HasRestrictingGloves
Public field HasSeeInvisibility
Public field HasShardResistance
Public field HasSlowDigestion
Public field HasSoundResistance
Public field HasSustainCharisma
Public field HasSustainConstitution
Public field HasSustainDexterity
Public field HasSustainIntelligence
Public field HasSustainStrength
Public field HasSustainWisdom
Public field HasTelepathy
Public field HasTimeResistance
Public field HasUnpriestlyWeapon
Public field Health
Public field Height
Public field HideCursorOnFullScreenInkey
Set to indicate that the cursor should be hidden while waiting for a keypress with a full screen overlay
Public field History
Public field HitDie
Public field Static member HurtChance
Public field InfravisionRange
Public field InPopupMenu
Public field Inventory
The players inventory.
Public field IsDead
Public field IsSearching
Public field IsWinner
Public field IsWizard
Public field KeyHead
Public field KeypadDirectionXOffset
Public field KeypadDirectionYOffset
Public field KeyQueue
Public field KeySize
Public field KeyTail
Public field LastInputReceived
Returns the date and time when the last player input was received or the game was initially started. Null, until the game is started.
Public field Light
Public field LightLevel
Public field Mana
Public field MapX
The current player X position.
Public field MapY
The current player Y position.
Public field MaxDlv
Public field MaxExperienceGained
Public field MaxHealth
Public field Static member MaxHgt
Returns the maximum height of any level.
Public field MaxLevelGained
Public field MaxMana
Public field MaxPanelCols
Public field MaxPanelRows
Public field Static member MaxRoomsCol
Public field Static member MaxRoomsRow
Public field Static member MaxWid
Returns the maximum width of any level.
Public field MCnt
Public field MeleeAttacksPerRound
Public field MessageFirstQueueIndex
Returns the unique index of the first message in the MessageLog. When messages drop out of the list due to the size of the MessageLog, this index is incremented by one. We do not actually store indexes with each message because they are one-to-one with the list.
Public field MissileAttacksPerRound
Public field MMax
Public field MonsterLevel
Public field Monsters
Public field NewLevelFlag
Public field NumRepro
Public field ObjectLevel
Public field OldSpareSpellSlots
Public field Static member OneInChanceUpStairsReturnsToTownLevel
Public field OrderedDirection
Public field OrderedDirectionXOffset
Public field OrderedDirectionYOffset
Public field PanelCol
Returns the map sector.
Public field PanelColMax
Returns the last level column of the playable area that is visible in the viewport.
Public field PanelColMin
Returns the first level column of the playable area that is visible in the viewport.
Public field PanelColPrt
Returns the first level column that is visible in the viewport.
Public field PanelRow
Returns the map sector.
Public field PanelRowMax
Returns the last level row of the playable area that is visible in the viewport.
Public field PanelRowMin
Returns the first level row of the playable area that is visible in the viewport.
Public field PanelRowPrt
Returns the first level row that is visible in the viewport.
Public field PlayerHp
Public field Playing
Public field PrimaryRealm
Returns the primary realm that the player studies.
Public field Quests
Public field QueuedCommand
Public field Race
Returns the current race of the character. Will be null before the player is birthed.
Public field RaceAtBirth
Returns the race the character was first assigned at birth.
Public field RecallDungeon
Public field Religion
Public field RepairMonsters
Public field Resting
Public field Rng
Public field Running
Public field Static member SafeMaxAttempts
Public field Screen
The current contents of the game screen.
Public field ScrollFlavours
Public field SecondaryRealm
Returns the secondary realm that the player studies.
Public field ShimmerMonsters
Public field Shutdown
Returns true, if the parent is requesting the game to shut down immediately. Returns false, by default.
Public field SingletonRepository
Public field SkillDigging
Public field SkillDisarmTraps
Public field SkillMelee
Public field SkillRanged
Public field SkillSavingThrow
Public field SkillSearchFrequency
Public field SkillSearching
Public field SkillStealth
Public field SkillThrowing
Public field SkillUseDevice
Public field SocialClass
Public field SpareSpellSlots
Public field SpecialDanger
Public field SpecialTreasure
Public field Speed
Public field SpellFirst
Public field SpellOrder
Represents the order in which spells that have been learned. When a spell is learned, it is added to this list. It is not removed, if the spell is forgotten, so that when the player regains the necessary experience, the same spell is relearned.
Public field Spells
Represents the spells that belong to both books that the player has access to.
Public field Talents
Public field TargetCol
Public field TargetRow
Public field TargetWho
Public field TempN
Public field TempX
Public field TempY
Public field TimedAcidResistance
Public field TimedBleeding
Public field TimedBlessing
Public field TimedBlindness
Public field TimedColdResistance
Public field TimedConfusion
Public field TimedEtherealness
Public field TimedFear
Public field TimedFireResistance
Badly formed XML comment.
Public field TimedHallucinations
Public field TimedHaste
Public field TimedHeroism
Public field TimedInfravision
Public field TimedInvulnerability
Public field TimedLightningResistance
Public field TimedParalysis
Public field TimedPoison
Public field TimedPoisonResistance
Public field TimedProtectionFromEvil
Public field TimedSeeInvisibility
Public field TimedSlow
Public field TimedStoneskin
Public field TimedStun
Public field TimedSuperheroism
Public field TimedTelepathy
Public field TotalFriendLevels
Public field TotalFriends
Public field TownWithHouse
Public field TrackedMonsterIndex
Public field TreasureFeeling
Public field TreasureRating
Public field Static member TunnMax
Public field View
Public field ViewingEquipment
Returns true, when the GetItem/SelectItem is rendering the equipment list, instead of the inventory list (when the ViewingItemList is true).
Public field ViewingItemList
Returns true, when the player is selecting an item and the inventory/equipment list is being rendered.
Public field Static member WallMax
Public field Weight
Public field WeightCarried
Public field Wilderness
Public field WildernessX
Public field WildernessY
Public field WordOfRecallDelay

Properties


  Name Description
Public property ActiveQuests
Public property CanCastSpells
Returns true, if the player can cast spells and/or read books. True, for character classes that can choose either a primary and/or secondary realm.
Public property Difficulty
Public property ExperienceLevel
Public property Gold
Public property Name
Public property OneInProbabilityGoldItemIsGreat
Returns the one-in-probability that found gold is great.