PixelCrushers.DialogueSystem.InkSupport.InkSaver Class Reference

Saver script for the Dialogue System's Ink integration. More...

Inheritance diagram for PixelCrushers.DialogueSystem.InkSupport.InkSaver:

Collaboration diagram for PixelCrushers.DialogueSystem.InkSupport.InkSaver:

Public Member Functions
override void	OnEnable ()
override void	OnDisable ()
override void	OnBeforeSceneChange ()
	The Save System will call this method before scene changes.
override string	RecordData ()
override void	ApplyData (string s)
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	Start ()
virtual void	Reset ()
virtual void	OnDestroy ()
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.
virtual 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.

Protected Member Functions
void	OnLoadStarted ()

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

Saver script for the Dialogue System's Ink integration.

Replaces the DialogueSystemInkIntegration.includeInSaveData checkbox.

Note: If conversation(s) are active, currently saves only the most recently-started active conversation, to preserve the format of old saved games.

Member Function Documentation

ApplyData()

override void PixelCrushers.DialogueSystem.InkSupport.InkSaver.ApplyData ( string  s )

inline

OnBeforeSceneChange()

override void PixelCrushers.DialogueSystem.InkSupport.InkSaver.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.

OnDisable()

override void PixelCrushers.DialogueSystem.InkSupport.InkSaver.OnDisable ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

OnEnable()

override void PixelCrushers.DialogueSystem.InkSupport.InkSaver.OnEnable ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

OnLoadStarted()

void PixelCrushers.DialogueSystem.InkSupport.InkSaver.OnLoadStarted ( )

inlineprotected

OnRestartGame()

override void PixelCrushers.DialogueSystem.InkSupport.InkSaver.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.InkSupport.InkSaver.RecordData ( )

inline

---

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

• C:/Dev/Dialogue System/Dev/Integration2/Ink Integration/Assets/Plugins/Pixel Crushers/Dialogue System/Third Party Support/Ink Support/Scripts/InkSaver.cs