Adventure Creator  1.68.2
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2018
AC.SaveFile Class Reference

Public Member Functions

 SaveFile (int _saveID, int _profileID, string _label, string _fileName, bool _isAutoSave, Texture2D _screenShot, string _screenshotFilename, int _updatedTime=0)
 
void SetLabel (string _label)
 Sets the save file's label in a safe format. Pipe's and colons are converted so that they can be stored. More...
 
string GetSafeLabel ()
 Gets the save file's label. Pipes and colons are converted back so that they can be read as expected. More...
 
 SaveFile (SaveFile _saveFile)
 

Public Attributes

int saveID
 
int profileID
 
string label
 
Texture2D screenShot
 
string fileName
 
string screenshotFilename
 
bool isAutoSave
 
int updatedTime
 

Detailed Description

A data container for save game files found in the file system. Instances of this struct are listed in the foundSaveFiles List in SaveSystem.

Constructor & Destructor Documentation

◆ SaveFile() [1/2]

AC.SaveFile.SaveFile ( int  _saveID,
int  _profileID,
string  _label,
string  _fileName,
bool  _isAutoSave,
Texture2D  _screenShot,
string  _screenshotFilename,
int  _updatedTime = 0 
)

The default Constructor.

◆ SaveFile() [2/2]

AC.SaveFile.SaveFile ( SaveFile  _saveFile)

A Constructor that copies the values of another SaveFile.

Member Function Documentation

◆ GetSafeLabel()

string AC.SaveFile.GetSafeLabel ( )

Gets the save file's label. Pipes and colons are converted back so that they can be read as expected.

Returns
The file's label

◆ SetLabel()

void AC.SaveFile.SetLabel ( string  _label)

Sets the save file's label in a safe format. Pipe's and colons are converted so that they can be stored.

Parameters
_labelThe new label for the file.

Member Data Documentation

◆ fileName

string AC.SaveFile.fileName

The complete filename of the file, including the filepath

◆ isAutoSave

bool AC.SaveFile.isAutoSave

If True, then the file is considered to be an AutoSave

◆ label

string AC.SaveFile.label

The save's label, as displayed in a MenuSavesList element

◆ profileID

int AC.SaveFile.profileID

The associated profile for the save

◆ saveID

int AC.SaveFile.saveID

A unique identifier for the save file

◆ screenShot

Texture2D AC.SaveFile.screenShot

The save's screenshot, if save game screenshots are enabled

◆ screenshotFilename

string AC.SaveFile.screenshotFilename

The complete filename of the associated screenshot, including the filepath (if available)

◆ updatedTime

int AC.SaveFile.updatedTime

The timestamp of the file's last-updated time