PixelCrushers.DialogueSystem.DialogueSystemSaver Class Reference

This is a saver that saves the Dialogue System's save data to the Pixel Crushers Common Library Save System. More...

Inheritance diagram for PixelCrushers.DialogueSystem.DialogueSystemSaver:

Collaboration diagram for PixelCrushers.DialogueSystem.DialogueSystemSaver:

Classes
class	RawData

Public Member Functions
override void	Reset ()
override void	Start ()
override void	OnDestroy ()
override string	RecordData ()
override void	ApplyDataImmediate ()
	If the Saver needs to pull data from the Save System immediately after loading a scene, instead of waiting for ApplyData to be called at it its normal time, it can implement this method.
override void	ApplyData (string data)
override void	OnBeforeSceneChange ()
	The Save System will call this method before scene changes.
override void	OnRestartGame ()
	The Save System will call this method when restarting the game.
Public Member Functions inherited from PixelCrushers.Saver
virtual void	Awake ()
virtual void	OnEnable ()
virtual void	OnDisable ()
string	RecordData ()
	This method should return a string that represents the data you want to save.
void	ApplyData (string s)
	This method should process the string representation of saved data and apply it to the current state of the game.

Public Attributes
bool	skipApplyDataAfterFramesIfApplyImmediate = true
bool	saveRawData = false

Additional Inherited Members
Protected Attributes inherited from PixelCrushers.Saver
string	m_runtimeKey = null
Properties inherited from PixelCrushers.Saver
bool	appendSaverTypeToKey [get, set]
	Append the name of this saver type to the key.
virtual string	key [get, set]
	Save data under this key.
string	_internalKeyValue [get, set]
	Accesses the internal key value.
virtual bool	saveAcrossSceneChanges [get, set]
	Save when changing scenes to be able to restore saved state when returning to scene.
virtual bool	restoreStateOnStart [get, set]

Detailed Description

This is a saver that saves the Dialogue System's save data to the Pixel Crushers Common Library Save System.

Member Function Documentation

ApplyData()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.ApplyData ( string  data )

inline

ApplyDataImmediate()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.ApplyDataImmediate ( )

inlinevirtual

If the Saver needs to pull data from the Save System immediately after loading a scene, instead of waiting for ApplyData to be called at it its normal time, it can implement this method.

For efficiency, the Save System will not look up the Saver's data; your method must look it up manually by calling SaveSystem.savedGameData.GetData(key).

Reimplemented from PixelCrushers.Saver.

OnBeforeSceneChange()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.OnBeforeSceneChange ( )

inlinevirtual

The Save System will call this method before scene changes.

If your saver listens for OnDisable or OnDestroy messages (see DestructibleSaver for example), it can use this method to ignore the next OnDisable or OnDestroy message since they will be called because the entire scene is being unloaded.

Reimplemented from PixelCrushers.Saver.

OnDestroy()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.OnDestroy ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

OnRestartGame()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.OnRestartGame ( )

inlinevirtual

The Save System will call this method when restarting the game.

Your saver can reset data to a fresh state if necessary.

Reimplemented from PixelCrushers.Saver.

RecordData()

override string PixelCrushers.DialogueSystem.DialogueSystemSaver.RecordData ( )

inline

Reset()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.Reset ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

Start()

override void PixelCrushers.DialogueSystem.DialogueSystemSaver.Start ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

Member Data Documentation

saveRawData

bool PixelCrushers.DialogueSystem.DialogueSystemSaver.saveRawData = false

skipApplyDataAfterFramesIfApplyImmediate

bool PixelCrushers.DialogueSystem.DialogueSystemSaver.skipApplyDataAfterFramesIfApplyImmediate = true

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/Save System/DialogueSystemSaver.cs