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