Class SaveGames
Enumerates and extracts data from Daggerfall save games.
Namespace: DaggerfallConnect.Save
Assembly: Assembly-CSharp.dll
Syntax
public class SaveGames
  Constructors
| Improve this Doc View SourceSaveGames()
Declaration
public SaveGames()
  SaveGames(String, Boolean)
Declaration
public SaveGames(string path, bool readOnly = true)
  Parameters
| Type | Name | Description | 
|---|---|---|
| String | path | |
| Boolean | readOnly | 
Fields
| Improve this Doc View SourceSaveNameTxt
Declaration
public const string SaveNameTxt = "SAVENAME.TXT"
  Field Value
| Type | Description | 
|---|---|
| String | 
Properties
| Improve this Doc View SourceBioFile
Gets the bio file from the current save's directory.
Declaration
public BioFile BioFile { get; }
  Property Value
| Type | Description | 
|---|---|
| BioFile | 
IsPathOpen
Returns true if current path is open.
Declaration
public bool IsPathOpen { get; }
  Property Value
| Type | Description | 
|---|---|
| Boolean | 
IsReadOnly
Returns true if read only mode enabled.
Declaration
public bool IsReadOnly { get; }
  Property Value
| Type | Description | 
|---|---|
| Boolean | 
SaveImage
Gets SaveImage of currently open save.
Declaration
public SaveImage SaveImage { get; }
  Property Value
| Type | Description | 
|---|---|
| SaveImage | 
SaveName
Gets name of currently open save.
Declaration
public string SaveName { get; }
  Property Value
| Type | Description | 
|---|---|
| String | 
SavesPath
Gets currently open parent path containing ARENA2 and SAVE0-SAVE5.
Declaration
public string SavesPath { get; }
  Property Value
| Type | Description | 
|---|---|
| String | 
SaveTree
Gets SaveTree of currently open save.
Declaration
public SaveTree SaveTree { get; }
  Property Value
| Type | Description | 
|---|---|
| SaveTree | 
SaveVars
Gets SaveVars of currently open save.
Declaration
public SaveVars SaveVars { get; }
  Property Value
| Type | Description | 
|---|---|
| SaveVars | 
Methods
| Improve this Doc View SourceHasSave(Int32)
Determines if the specified save index exists.
Declaration
public bool HasSave(int save)
  Parameters
| Type | Name | Description | 
|---|---|---|
| Int32 | save | Save index.  | 
      
Returns
| Type | Description | 
|---|---|
| Boolean | True if save index present.  | 
      
LazyOpenSave(Int32)
Opens just SaveImage and SaveName for display. Before reading other data, must call OpenSave() or TryOpenSave().
Declaration
public bool LazyOpenSave(int save)
  Parameters
| Type | Name | Description | 
|---|---|---|
| Int32 | save | Save index.  | 
      
Returns
| Type | Description | 
|---|---|
| Boolean | True if successful.  | 
      
OpenSave(Int32, Boolean)
Opens the save game index specified.
Declaration
public bool OpenSave(int save, bool loadingInGame = true)
  Parameters
| Type | Name | Description | 
|---|---|---|
| Int32 | save | Save index  | 
      
| Boolean | loadingInGame | True if the save game is being loaded for regular play, false if loading for Save Explorer.  | 
      
Returns
| Type | Description | 
|---|---|
| Boolean | True if successful.  | 
      
OpenSavesPath(String, Boolean)
Enumerates all save games in parent path provided.
Declaration
public bool OpenSavesPath(string path, bool readOnly = true)
  Parameters
| Type | Name | Description | 
|---|---|---|
| String | path | Path to parent Daggerfall folder containing ARENA2 and SAVE0-SAVE5 folders.  | 
      
| Boolean | readOnly | Open save as read only.  | 
      
Returns
| Type | Description | 
|---|---|
| Boolean | True if save opened successfully.  | 
      
TryOpenSave(Int32)
Opens the save game index specified. Will not throw any exceptions on failure.
Declaration
public bool TryOpenSave(int save)
  Parameters
| Type | Name | Description | 
|---|---|---|
| Int32 | save | Save index  | 
      
Returns
| Type | Description | 
|---|---|
| Boolean | True if successful.  |