PixelCrushers.SaveSystemMethods Class Reference

Provides inspector-selectable methods to control SaveSystem. More...

Inheritance diagram for PixelCrushers.SaveSystemMethods:

Collaboration diagram for PixelCrushers.SaveSystemMethods:

Public Member Functions
virtual void	SaveSlot (int slotNumber)
	Saves the current game in the specified slot.
virtual void	LoadFromSlot (int slotNumber)
	Loads the game previously-saved in the specified slot.
virtual void	LoadScene (string sceneNameAndSpawnpoint)
	Changes scenes.
virtual void	ResetGameState ()
	Resets all saved game data.
virtual void	RestartGame (string startingSceneName)
	Resets all saved game data and restarts the game at the specified scene.
virtual void	LoadOrRestart (int slotNumber)
	Load the specified slot, or restart the game from the default starting scene if no save exists yet.
virtual void	DeleteSavedGameInSlot (int slotNumber)
	Deletes the saved game in the specified slot.
virtual void	RecordSavedGameData ()
	Records the current game state into the Save System.
virtual void	ApplySavedGameData ()
	Applies the most recently recorded game state.
virtual void	LoadAdditiveScene (string sceneName)
	Additively loads another scene.
virtual void	UnloadAdditiveScene (string sceneName)
	Unloads a previously additively-loaded scene.

Public Attributes
string	defaultStartingSceneName

Detailed Description

Provides inspector-selectable methods to control SaveSystem.

Member Function Documentation

ApplySavedGameData()

virtual void PixelCrushers.SaveSystemMethods.ApplySavedGameData ( )

inlinevirtual

Applies the most recently recorded game state.

DeleteSavedGameInSlot()

virtual void PixelCrushers.SaveSystemMethods.DeleteSavedGameInSlot ( int  slotNumber )

inlinevirtual

Deletes the saved game in the specified slot.

LoadAdditiveScene()

virtual void PixelCrushers.SaveSystemMethods.LoadAdditiveScene ( string  sceneName )

inlinevirtual

Additively loads another scene.

Parameters

sceneName

Scene to additively load.

LoadFromSlot()

virtual void PixelCrushers.SaveSystemMethods.LoadFromSlot ( int  slotNumber )

inlinevirtual

Loads the game previously-saved in the specified slot.

Parameters

slotNumber

Slot to load.

LoadOrRestart()

virtual void PixelCrushers.SaveSystemMethods.LoadOrRestart ( int  slotNumber )

inlinevirtual

Load the specified slot, or restart the game from the default starting scene if no save exists yet.

Parameters

slotNumber

Slot number to load.

LoadScene()

virtual void PixelCrushers.SaveSystemMethods.LoadScene ( string  sceneNameAndSpawnpoint )

inlinevirtual

Changes scenes.

You can optionally specify a player spawnpoint by adding '@' and the spawnpoint GameObject name.

Parameters

sceneNameAndSpawnpoint

Scene name followed by an optional at-sign and spawnpoint name.

RecordSavedGameData()

virtual void PixelCrushers.SaveSystemMethods.RecordSavedGameData ( )

inlinevirtual

Records the current game state into the Save System.

ResetGameState()

virtual void PixelCrushers.SaveSystemMethods.ResetGameState ( )

inlinevirtual

Resets all saved game data.

RestartGame()

virtual void PixelCrushers.SaveSystemMethods.RestartGame ( string  startingSceneName )

inlinevirtual

Resets all saved game data and restarts the game at the specified scene.

Parameters

startingSceneName

Scene to restart at.

SaveSlot()

virtual void PixelCrushers.SaveSystemMethods.SaveSlot ( int  slotNumber )

inlinevirtual

Saves the current game in the specified slot.

Parameters

slotNumber

slot to save.

UnloadAdditiveScene()

virtual void PixelCrushers.SaveSystemMethods.UnloadAdditiveScene ( string  sceneName )

inlinevirtual

Unloads a previously additively-loaded scene.

Parameters

sceneName

Scene to unload

Member Data Documentation

defaultStartingSceneName

string PixelCrushers.SaveSystemMethods.defaultStartingSceneName

---

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

• C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Common/Scripts/Save System/Misc/SaveSystemMethods.cs