SCR_NumberedDSSessionCallback Interface Reference

Inheritance diagram for SCR_NumberedDSSessionCallback:

Protected Member Functions
override string	GetFileName (string missionFileName, string customName)
	Extract custom name from save file name.
Protected Member Functions inherited from SCR_DSSessionCallback
void	OnLatestSave (string fileName)
void	InvokeOnSaved ()

Protected Attributes
int	m_iMaxSaves
Protected Attributes inherited from SCR_DSSessionCallback
ESaveType	m_eType
string	m_sExtension
string	m_sCustomNameDelimiter
bool	m_bAlwaysLocal
bool	m_bRegisterLatestSave
ref SCR_UIInfo	m_Info
SCR_MissionStruct	m_Struct
bool	m_bLoadPreview
string	m_sCurrentFileName

Additional Inherited Members
Public Member Functions inherited from SCR_DSSessionCallback
ESaveType	GetSaveType ()
SCR_UIInfo	GetInfo ()
bool	SaveSession (string missionFileName, string customName=string.Empty)
	Save current session to a file.
bool	LoadSession (string fileName)
	Load session from given save file.
bool	Delete (string missionFileName, string customName)
	Delete a save file.
bool	Delete (string fileName)
	Delete a save file.
bool	FileExists (string fileName, string customName=string.Empty)
	Check if file of given type exists.
SCR_MetaStruct	GetMeta (string fileName)
	Open file name and read its meta header.
void	SetStruct (SCR_MissionStruct struct)
	Set JSON struct that defines what will be saved.
SCR_MissionStruct	GetStruct ()
void	Log ()
	Print out JSON struct that is currently kept in the memory.
bool	IsConfigured ()
bool	IsCompatible (string fileName)
	Check if a save file name is compatible with this callback, and can be load using its settings.
string	GetMissionFileName (string fileName)
	Extract mission file name from save file name.
string	GetCustomName (string fileName)
	Compose save file name.
string	GetCurrentCustomName ()
string	GetFileName (string missionFileName, string customName)
	Extract custom name from save file name.
void	OnGameStart (string missionFileName)
void	OnGameEnd (string missionFileName)
override void	OnSaving (string fileName)
override void	OnSaveSuccess (string fileName)
override void	OnSaveFailed (string fileName)
override void	OnLoaded (string fileName)
override void	OnLoadFailed (string fileName)
override void	OnDeleteSuccess (string fileName)
override void	OnDeleteFailed (string fileName)
void	SCR_DSSessionCallback ()

Member Function Documentation

GetFileName()

override string SCR_NumberedDSSessionCallback.GetFileName ( string  missionFileName, string  customName  )

protected

Extract custom name from save file name.

Parameters

fileName

Save file name

Returns

Custom name

Implements SCR_DSSessionCallback.

Member Data Documentation

m_iMaxSaves

int SCR_NumberedDSSessionCallback.m_iMaxSaves

protected

---

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

• Game/GameMode/SaveLoad/SCR_DSSessionCallback.c