SCR_SaveLoadComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_SaveLoadComponentClass

Functions
SCR_SaveLoadComponentClass SCR_BaseGameModeComponentClass	Attribute (desc:"Struct object which manages saved data. Must be defined, without it saving won't work.")] protected ref SCR_MissionStruct m_Struct
	Game mode-specific settings for session saving. More...
bool	CanSaveOnExit ()
ResourceName	GetDebugHeaderResourceName ()
bool	ContainsStruct (typename structType)
protected void	Autosave ()
override void	OnGameModeEnd (SCR_GameModeEndData data)
override void	OnPostInit (IEntity owner)
	Editable Mine. More...

Variables
protected bool	m_SaveOnExit
protected int	m_iAutosavePeriod
protected ResourceName	m_DebugHeaderResourceName

Function Documentation

Attribute()

SCR_SaveLoadComponentClass SCR_BaseGameModeComponentClass Attribute	(	desc:"Struct object which manages saved data. Must be	defined,
		without it saving won 't work."
	)

Game mode-specific settings for session saving.

Autosave()

protected void Autosave

(

)

Definition at line 66 of file SCR_SaveLoadComponent.c.

CanSaveOnExit()

bool CanSaveOnExit

(

)

Returns

true if the world should be saved on exit.

Definition at line 40 of file SCR_SaveLoadComponent.c.

ContainsStruct()

bool ContainsStruct

(

typename structType

)

Check if the mission struct contains a sub-struct of specific type.

Parameters

[in]

structType

Type of queried struct

Returns

true if the sub-struct is present

Definition at line 56 of file SCR_SaveLoadComponent.c.

GetDebugHeaderResourceName()

ResourceName GetDebugHeaderResourceName

(

)

Returns

Mission header used for debugging in World Editor (where mission headers are otherwise unavailable)

Definition at line 47 of file SCR_SaveLoadComponent.c.

OnGameModeEnd()

override void OnGameModeEnd

(

SCR_GameModeEndData

data

)

Called when game mode ends.

Parameters

[in]

data

End game data with game logic.

Definition at line 76 of file SCR_SaveLoadComponent.c.

Variable Documentation

m_DebugHeaderResourceName

protected ResourceName m_DebugHeaderResourceName

Definition at line 19 of file SCR_SaveLoadComponent.c.

m_iAutosavePeriod

protected int m_iAutosavePeriod

Definition at line 16 of file SCR_SaveLoadComponent.c.

m_SaveOnExit

protected bool m_SaveOnExit

Definition at line 13 of file SCR_SaveLoadComponent.c.