Saves a GameObject's position. More...

Inheritance diagram for PixelCrushers.PositionSaver:

[legend]

Collaboration diagram for PixelCrushers.PositionSaver:

[legend]

Classes
class	MultiscenePositionData

class	PositionData

class	ScenePositionData

Public Member Functions
override void	Awake ()

override string	RecordData ()

override void	ApplyData (string s)

Public Member Functions inherited from PixelCrushers.Saver
virtual void	Start ()

virtual void	Reset ()

virtual void	OnEnable ()

virtual void	OnDisable ()

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.

virtual void	OnBeforeSceneChange ()
	The Save System will call this method before scene changes.

virtual void	OnRestartGame ()
	The Save System will call this method when restarting the game.

Protected Member Functions
virtual void	SetPosition (Vector3 position, Quaternion rotation)

Protected Attributes
PositionData	m_data

MultiscenePositionData	m_multisceneData

Protected Attributes inherited from PixelCrushers.Saver
string	m_runtimeKey = null

Properties
Transform	target `[get, set]`

bool	usePlayerSpawnpoint `[get, set]`

bool	multiscene `[get]`

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

Saves a GameObject's position.

Member Function Documentation

◆ ApplyData()

override void PixelCrushers.PositionSaver.ApplyData ( string s )

inline

◆ Awake()

override void PixelCrushers.PositionSaver.Awake ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

◆ RecordData()

override string PixelCrushers.PositionSaver.RecordData ( )

inline

◆ SetPosition()

virtual void PixelCrushers.PositionSaver.SetPosition	(	Vector3	position,
		Quaternion	rotation
	)

inlineprotectedvirtual

Member Data Documentation

◆ m_data

PositionData PixelCrushers.PositionSaver.m_data

protected

◆ m_multisceneData

MultiscenePositionData PixelCrushers.PositionSaver.m_multisceneData

protected

Property Documentation

◆ multiscene

bool PixelCrushers.PositionSaver.multiscene

getprotected

◆ target

Transform PixelCrushers.PositionSaver.target

getset

◆ usePlayerSpawnpoint

bool PixelCrushers.PositionSaver.usePlayerSpawnpoint