SavedGames Namespace Reference

Functions
Status	Save (const std::wstring &name, const std::wstring &description, CSimulation2 &simulation, CGUIManager *gui, int playerID)
	Create new saved game archive with given name and simulation data. More...
Status	SavePrefix (const std::wstring &prefix, const std::wstring &description, CSimulation2 &simulation, CGUIManager *gui, int playerID)
	Create new saved game archive with given prefix and simulation data. More...
Status	Load (const std::wstring &name, ScriptInterface &scriptInterface, CScriptValRooted &metadata, std::string &savedState)
	Load saved game archive with the given name. More...
std::vector< CScriptValRooted >	GetSavedGames (ScriptInterface &scriptInterface)
	Get list of saved games for GUI script usage. More...
bool	DeleteSavedGame (const std::wstring &name)
	Permanently deletes the saved game archive with the given name. More...

Function Documentation

bool SavedGames::DeleteSavedGame

(

const std::wstring &

name

)

Permanently deletes the saved game archive with the given name.

Parameters

name	filename of saved game (without path or extension)

Returns

true if deletion was successful, or false on error

Definition at line 224 of file SavedGame.cpp.

std::vector< CScriptValRooted > SavedGames::GetSavedGames

(

ScriptInterface &

scriptInterface

)

Get list of saved games for GUI script usage.

Parameters

scriptInterface

the ScriptInterface in which to create the return data.

Returns

list of objects containing saved game data

Definition at line 175 of file SavedGame.cpp.

Status SavedGames::Load	(	const std::wstring &	name,
		ScriptInterface &	scriptInterface,
		CScriptValRooted &	metadata,
		std::string &	savedState
	)

Load saved game archive with the given name.

Parameters

	name	filename of saved game (without path or extension)
	scriptInterface
[out]	metadata	object containing metadata associated with saved game, parsed from metadata.json inside the archive.
[out]	savedState	serialized simulation state stored as string of bytes, loaded from simulation.dat inside the archive.

Returns

INFO::OK if successfully loaded, else an error Status

Definition at line 152 of file SavedGame.cpp.

Status SavedGames::Save	(	const std::wstring &	name,
		const std::wstring &	description,
		CSimulation2 &	simulation,
		CGUIManager *	gui,
		int	playerID
	)

Create new saved game archive with given name and simulation data.

Parameters

name	Name to save the game with
description	A user-given description of the save
simulation
gui	if not NULL, store some UI-related data with the saved game
playerID	ID of the player who saved this file

Returns

INFO::OK if successfully saved, else an error Status

Definition at line 50 of file SavedGame.cpp.

Status SavedGames::SavePrefix	(	const std::wstring &	prefix,
		const std::wstring &	description,
		CSimulation2 &	simulation,
		CGUIManager *	gui,
		int	playerID
	)

Create new saved game archive with given prefix and simulation data.

Parameters

prefix	Create new numbered file starting with this prefix
description	A user-given description of the save
simulation
gui	if not NULL, store some UI-related data with the saved game
playerID	ID of the player who saved this file

Returns

INFO::OK if successfully saved, else an error Status

Definition at line 35 of file SavedGame.cpp.