ISaveGame

C++
struct ISaveGame {
};
File

ISaveGame.h

ISaveGame::~ISaveGame Destructor
C++
virtual ~ISaveGame();
ISaveGame::AddMetadata Method (char *, char *)
C++
virtual void AddMetadata(const char * tag, const char * value) = 0;
Description

set some basic meta-data

ISaveGame::AddMetadata Method (char *, int)
C++
virtual void AddMetadata(const char * tag, int value) = 0;
ISaveGame::AddSection Method
C++
virtual TSerialize AddSection(const char * section) = 0;
Description

create a serializer for some data section

ISaveGame::Complete Method
C++
virtual bool Complete(bool successfulSoFar) = 0;
Description

finish - indicate success (negative success *must* remove file) also calls delete this;

ISaveGame::GetFileName Method
C++
virtual const char* GetFileName() const = 0;
Description

returns the filename of this savegame

ISaveGame::GetMemoryUsage Method
C++
virtual void GetMemoryUsage(ICrySizer * pSizer) const = 0;
ISaveGame::GetSaveGameReason Method
C++
virtual ESaveGameReason GetSaveGameReason() const = 0;
ISaveGame::Init Method
C++
virtual bool Init(const char * name) = 0;
Description

initialize - set output path

ISaveGame::SetSaveGameReason Method
C++
virtual void SetSaveGameReason(ESaveGameReason reason) = 0;
Description

save game reason

ISaveGame::SetThumbnail Method
C++
virtual uint8* SetThumbnail(const uint8* imageData, int width, int height, int depth) = 0;
Description

set a thumbnail. if imageData == 0: only reserves memory and returns ptr to local data if imageData != 0: copies data from imageData into local buffer imageData is in BGR or BGRA returns ptr to internal data storage (size=width*height*depth) if Thumbnail supported, 0 otherwise

ISaveGame::SetThumbnailFromBMP Method
C++
virtual bool SetThumbnailFromBMP(const char* filename) = 0;
Description

set a thumbnail from an already present bmp file file will be read on function call returns true if successful, false otherwise