JSI_SavedGame Namespace Reference

Functions
JS::Value	GetSavedGames (const 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...
void	SaveGame (const ScriptRequest &rq, const std::wstring &filename, const std::wstring &description, JS::HandleValue GUIMetadata)
void	SaveGamePrefix (const ScriptRequest &rq, const std::wstring &prefix, const std::wstring &description, JS::HandleValue GUIMetadata)
void	QuickSave (JS::HandleValue GUIMetadata)
void	QuickLoad ()
JS::Value	StartSavedGame (const ScriptInterface &scriptInterface, const std::wstring &name)
void	ActivateRejoinTest ()
void	RegisterScriptFunctions (const ScriptRequest &rq)
	Registers the functions of the JavaScript interface for internationalization and localization into the specified JavaScript context. More...

Function Documentation

ActivateRejoinTest()

void JSI_SavedGame::ActivateRejoinTest

(

)

DeleteSavedGame()

bool JSI_SavedGame::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

GetSavedGames()

JS::Value JSI_SavedGame::GetSavedGames

(

const ScriptInterface &

scriptInterface

)

Get list of saved games for GUI script usage.

Parameters

scriptInterface

the ScriptInterface in which to create the return data.

Returns

array of objects containing saved game data

QuickLoad()

void JSI_SavedGame::QuickLoad

(

)

QuickSave()

void JSI_SavedGame::QuickSave

(

JS::HandleValue

GUIMetadata

)

RegisterScriptFunctions()

void JSI_SavedGame::RegisterScriptFunctions

(

const ScriptRequest &

rq

)

Registers the functions of the JavaScript interface for internationalization and localization into the specified JavaScript context.

Parameters

ScriptRequest

Script Request where RegisterScriptFunctions() registers the functions.

See also

GuiScriptingInit()

SaveGame()

void JSI_SavedGame::SaveGame	(	const ScriptRequest &	rq,
		const std::wstring &	filename,
		const std::wstring &	description,
		JS::HandleValue	GUIMetadata
	)

SaveGamePrefix()

void JSI_SavedGame::SaveGamePrefix	(	const ScriptRequest &	rq,
		const std::wstring &	prefix,
		const std::wstring &	description,
		JS::HandleValue	GUIMetadata
	)

StartSavedGame()

JS::Value JSI_SavedGame::StartSavedGame	(	const ScriptInterface &	scriptInterface,
		const std::wstring &	name
	)