PixelCrushers.SavedGameData Class Reference

Holds the data for a saved game. More...

Inheritance diagram for PixelCrushers.SavedGameData:
Collaboration diagram for PixelCrushers.SavedGameData:

Classes

class  SaveRecord
 Holds the data returned by a Saver along with the Saver's key and the index of the scene that the Saver was in. More...
 

Public Member Functions

void OnBeforeSerialize ()
 
void OnAfterDeserialize ()
 
string GetData (string key)
 Retrieves the previously-saved data for a Saver. More...
 
void SetData (string key, int sceneIndex, string data)
 Stores a Saver's data. More...
 
void DeleteObsoleteSaveData (int currentSceneIndex)
 Removes all save records except those in the current scene and those that are configured to remember across scene changes. More...
 

Properties

string sceneName [get, set]
 The scene in which the game was saved. More...
 

Detailed Description

Holds the data for a saved game.

Member Function Documentation

void PixelCrushers.SavedGameData.DeleteObsoleteSaveData ( int  currentSceneIndex)

Removes all save records except those in the current scene and those that are configured to remember across scene changes.

Parameters
currentSceneIndex
string PixelCrushers.SavedGameData.GetData ( string  key)

Retrieves the previously-saved data for a Saver.

Parameters
key
Returns
void PixelCrushers.SavedGameData.OnAfterDeserialize ( )
void PixelCrushers.SavedGameData.OnBeforeSerialize ( )
void PixelCrushers.SavedGameData.SetData ( string  key,
int  sceneIndex,
string  data 
)

Stores a Saver's data.

Parameters
key
sceneIndex
data

Property Documentation

string PixelCrushers.SavedGameData.sceneName
getset

The scene in which the game was saved.


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