Inheritance diagram for AC.SaveFileHandler_PlayerPrefs:

Public Member Functions
virtual string	GetDefaultSaveLabel (int saveID)
	Returns the default label of a save file. This is not the same as the filename - it is what's displayed in SavesList menus.
virtual void	DeleteAll (int profileID)
	Deletes all save files associated with a given profile.
virtual void	Delete (SaveFile saveFile, System.Action< bool > callback=null)
	Deletes a single save file.
virtual void	Save (SaveFile saveFile, string dataToSave, System.Action< bool > callback)
	Requests that game data be saved to disk. When saving is complete, it needs to confirm the output to SaveSystem.OnCompleteSave for the save to be recorded.
virtual void	Load (SaveFile saveFile, bool doLog, System.Action< SaveFile, string > callback)
	Requests that save game data be loaded from disk. The resulting data needs to be sent back to SaveSystem.ReceiveLoadedData for it to actually be processed.
virtual bool	SupportsSaveThreading ()
virtual void	GatherSaveFiles (int profileID, System.Action< List< SaveFile > > callback)
	Reads the disk for all save files associated with a given profile.
virtual SaveFile	GetSaveFile (int saveID, int profileID)
	Reads the disk for a save file with a specific ID.
virtual void	GatherImportFiles (int profileID, int boolID, string separateProductName, string separateFilePrefix, System.Action< List< SaveFile > > callback)
	Reads the disk for all save files associated with a given profile from another game, to allow for the importing of data between games.
virtual void	SaveScreenshot (SaveFile saveFile)
	Saves a screenshot associated with a save file.

Protected Member Functions
virtual void	GatherSaveFiles (int profileID, bool isImport, int boolID, string separateFilePrefix, System.Action< List< SaveFile > > callback)
virtual SaveFile	GetSaveFile (int saveID, int profileID, bool isImport, int boolID, string separateFilePrefix)
virtual string	GetSaveFilename (int saveID, int profileID=-1)
virtual string	GetImportFilename (int saveID, string filePrefix, int profileID=-1)
virtual string	GetTimeString (DateTime dateTime)

Static Protected Attributes
const string	screenshotKey = "_screenshot"

Properties
virtual int	MaxSaves `[get]`

Detailed Description

A save-file handler that stores save-games as separate keys in the PlayerPrefs

Member Function Documentation

◆ Delete()

virtual void AC.SaveFileHandler_PlayerPrefs.Delete	(	SaveFile	saveFile,
		System.Action< bool >	callback = null )

virtual

Deletes a single save file.

Parameters

saveFile	The SaveFile container which stores information about the save to delete
callback	An optional callback that contains a bool that's True if the delete was succesful

Implements AC.iSaveFileHandler.

◆ DeleteAll()

virtual void AC.SaveFileHandler_PlayerPrefs.DeleteAll ( int profileID )

virtual

Deletes all save files associated with a given profile.

Parameters

profileID The ID number of the profile to delete saves for, or 0 if profiles are not enabled.

Implements AC.iSaveFileHandler.

◆ GatherImportFiles()

virtual void AC.SaveFileHandler_PlayerPrefs.GatherImportFiles	(	int	profileID,
		int	boolID,
		string	separateProductName,
		string	separateFilePrefix,
		System.Action< List< SaveFile > >	callback )

virtual

Reads the disk for all save files associated with a given profile from another game, to allow for the importing of data between games.

Parameters

profileID	The ID number of the profile to search save files for, or 0 if profiles are not enabled
boolID	The ID number of the Global Boolean variable that must be true in the file's data in order for it to be included, or -1 if this feature is not used
separateProductName	The 'Product name' of the Unity product to import files from
separateFilePrefix	The 'Save filename' field of the AC project to import files from, as set in the Settings Manager

Returns: A List of SaveFile instances, with each instance storing information about each found save file

Implements AC.iSaveFileHandler.

◆ GatherSaveFiles()

virtual void AC.SaveFileHandler_PlayerPrefs.GatherSaveFiles	(	int	profileID,
		System.Action< List< SaveFile > >	callback )

virtual

Reads the disk for all save files associated with a given profile.

Parameters

profileID The ID number of the profile to search save files for, or 0 if profiles are not enabled

Returns: A List of SaveFile instances, with each instance storing information about each found save file

Implements AC.iSaveFileHandler.

◆ GetDefaultSaveLabel()

virtual string AC.SaveFileHandler_PlayerPrefs.GetDefaultSaveLabel ( int saveID )

virtual

Returns the default label of a save file. This is not the same as the filename - it is what's displayed in SavesList menus.

Parameters

saveID The ID number of the save game

Returns: The save file's default label

Implements AC.iSaveFileHandler.

◆ GetSaveFile()

virtual SaveFile AC.SaveFileHandler_PlayerPrefs.GetSaveFile	(	int	saveID,
		int	profileID )

virtual

Reads the disk for a save file with a specific ID.

Parameters

saveID	The ID number of the save to search for
profileID	The ID number of the save file's associated profile, or 0 if profiles are not enabled

Returns: A SaveFile instances, if the save was found

Implements AC.iSaveFileHandler.

◆ Load()

virtual void AC.SaveFileHandler_PlayerPrefs.Load	(	SaveFile	saveFile,
		bool	doLog,
		System.Action< SaveFile, string >	callback )

virtual

Requests that save game data be loaded from disk. The resulting data needs to be sent back to SaveSystem.ReceiveLoadedData for it to actually be processed.

Parameters

saveFile	The SaveFile container which stores information about the save to load
doLog	If True, a log should be shown in the Console once the data has been read
callback	A callback containing the SaveFile, and the save-data string

Implements AC.iSaveFileHandler.

◆ Save()

virtual void AC.SaveFileHandler_PlayerPrefs.Save	(	SaveFile	saveFile,
		string	dataToSave,
		System.Action< bool >	callback )

virtual

Requests that game data be saved to disk. When saving is complete, it needs to confirm the output to SaveSystem.OnCompleteSave for the save to be recorded.

Parameters

saveFile	The SaveFile container which stores information about the file. Note that only the saveID, profileID and label have been correctly assigned by this point
dataToSave	The data to save, as a serialized string
callback	A callback containing a bool that's True if the save was successful

Implements AC.iSaveFileHandler.

◆ SaveScreenshot()

virtual void AC.SaveFileHandler_PlayerPrefs.SaveScreenshot ( SaveFile saveFile )

virtual

Saves a screenshot associated with a save file.

Parameters

saveFile A data container for both the texture, and the associate save/profile IDs

Implements AC.iSaveFileHandler.

◆ SupportsSaveThreading()

virtual bool AC.SaveFileHandler_PlayerPrefs.SupportsSaveThreading ( )

virtual

Returns true if threading is supported when saving to disk

Implements AC.iSaveFileHandler.

Public Member Functions

Protected Member Functions

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Delete()

◆ DeleteAll()

◆ GatherImportFiles()

◆ GatherSaveFiles()

◆ GetDefaultSaveLabel()

◆ GetSaveFile()

◆ Load()

◆ Save()

◆ SaveScreenshot()

◆ SupportsSaveThreading()