SCR_PersistenceSystem Class Reference

Inheritance diagram for SCR_PersistenceSystem:

Protected Member Functions
void	OnStateChanged (EPersistenceSystemState oldState, EPersistenceSystemState newState)
void	OnBeforeSave (ESaveGameType saveType)
void	OnAfterSave (ESaveGameType saveType, bool success)
void	OnAfterLoad (bool success)
void	HandleDelete (IEntity entity)
void	DeferredNotifcation (ENotification notification)
sealed ScriptInvokerBase< SCR_PersistenceSystem_OnStateChanged >	GetOnStateChanged ()
sealed ScriptInvokerBase< SCR_PersistenceSystem_OnBeforeSave >	GetOnBeforeSave ()
sealed ScriptInvokerBase< SCR_PersistenceSystem_OnAfterSave >	GetOnAfterSave ()

Static Protected Member Functions
static sealed bool	IsLoadInProgress (float msSinceLoad=1000.0)
static sealed SCR_PersistenceSystem	GetScriptedInstance ()
static sealed SCR_PersistenceSystem	GetByCurrentWorld ()
static sealed SCR_PersistenceSystem	GetByEntityWorld (IEntity entity)

Protected Attributes
ref ScriptInvokerBase< SCR_PersistenceSystem_OnStateChanged >	m_OnStateChanged = new ScriptInvokerBase<SCR_PersistenceSystem_OnStateChanged>()
ref ScriptInvokerBase< SCR_PersistenceSystem_OnBeforeSave >	m_OnBeforeSave = new ScriptInvokerBase<SCR_PersistenceSystem_OnBeforeSave>()
ref ScriptInvokerBase< SCR_PersistenceSystem_OnAfterSave >	m_OnAfterSave = new ScriptInvokerBase<SCR_PersistenceSystem_OnAfterSave>()

Detailed Description

Definition at line 10 of file SCR_PersistenceSystem.c.

Member Function Documentation

DeferredNotifcation()

void SCR_PersistenceSystem::DeferredNotifcation ( ENotification notification )

inlineprotected

Definition at line 63 of file SCR_PersistenceSystem.c.

GetByCurrentWorld()

sealed SCR_PersistenceSystem SCR_PersistenceSystem::GetByCurrentWorld ( )

inlinestaticprotected

Definition at line 115 of file SCR_PersistenceSystem.c.

GetByEntityWorld()

sealed SCR_PersistenceSystem SCR_PersistenceSystem::GetByEntityWorld ( IEntity entity )

inlinestaticprotected

Definition at line 125 of file SCR_PersistenceSystem.c.

GetOnAfterSave()

sealed ScriptInvokerBase< SCR_PersistenceSystem_OnAfterSave > SCR_PersistenceSystem::GetOnAfterSave ( )

inlineprotected

Definition at line 81 of file SCR_PersistenceSystem.c.

GetOnBeforeSave()

sealed ScriptInvokerBase< SCR_PersistenceSystem_OnBeforeSave > SCR_PersistenceSystem::GetOnBeforeSave ( )

inlineprotected

Definition at line 75 of file SCR_PersistenceSystem.c.

GetOnStateChanged()

sealed ScriptInvokerBase< SCR_PersistenceSystem_OnStateChanged > SCR_PersistenceSystem::GetOnStateChanged ( )

inlineprotected

Definition at line 69 of file SCR_PersistenceSystem.c.

GetScriptedInstance()

sealed SCR_PersistenceSystem SCR_PersistenceSystem::GetScriptedInstance ( )

inlinestaticprotected

Definition at line 109 of file SCR_PersistenceSystem.c.

HandleDelete()

void SCR_PersistenceSystem::HandleDelete ( IEntity entity )

inlineprotected

Definition at line 57 of file SCR_PersistenceSystem.c.

IsLoadInProgress()

sealed bool SCR_PersistenceSystem::IsLoadInProgress ( float msSinceLoad = 1000.0 )

inlinestaticprotected

Utility method to suppress unwanted UI or sound events during load of saves.

Parameters

msSinceLoad

Will report as loading for the specified time in milliseconds after the world load completed to catch events that fire on the first few frames.

Definition at line 91 of file SCR_PersistenceSystem.c.

OnAfterLoad()

void SCR_PersistenceSystem::OnAfterLoad ( bool success )

inlineprotected

Definition at line 40 of file SCR_PersistenceSystem.c.

OnAfterSave()

void SCR_PersistenceSystem::OnAfterSave ( ESaveGameType saveType, bool success )

inlineprotected

Definition at line 29 of file SCR_PersistenceSystem.c.

OnBeforeSave()

void SCR_PersistenceSystem::OnBeforeSave ( ESaveGameType saveType )

inlineprotected

Definition at line 23 of file SCR_PersistenceSystem.c.

OnStateChanged()

void SCR_PersistenceSystem::OnStateChanged ( EPersistenceSystemState oldState, EPersistenceSystemState newState )

inlineprotected

Definition at line 17 of file SCR_PersistenceSystem.c.

Member Data Documentation

m_OnAfterSave

ref ScriptInvokerBase<SCR_PersistenceSystem_OnAfterSave> SCR_PersistenceSystem::m_OnAfterSave = new ScriptInvokerBase<SCR_PersistenceSystem_OnAfterSave>()

protected

Definition at line 14 of file SCR_PersistenceSystem.c.

m_OnBeforeSave

ref ScriptInvokerBase<SCR_PersistenceSystem_OnBeforeSave> SCR_PersistenceSystem::m_OnBeforeSave = new ScriptInvokerBase<SCR_PersistenceSystem_OnBeforeSave>()

protected

Definition at line 13 of file SCR_PersistenceSystem.c.

m_OnStateChanged

ref ScriptInvokerBase<SCR_PersistenceSystem_OnStateChanged> SCR_PersistenceSystem::m_OnStateChanged = new ScriptInvokerBase<SCR_PersistenceSystem_OnStateChanged>()

protected

Definition at line 12 of file SCR_PersistenceSystem.c.

---

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

• scripts/Game/Plugins/Persistence/System/SCR_PersistenceSystem.c