ScummVM API documentation
Stark::SaveMetadata Class Reference

#include <savemetadata.h>

Public Member Functions

void setSaveTime (const TimeDate &timeDate)
 
Common::ErrorCode read (Common::SeekableReadStream *stream, const Common::String &filename)
 
void write (Common::WriteStream *stream)
 
Graphics::SurfacereadGameScreenThumbnail (Common::SeekableReadStream *stream)
 
void skipGameScreenThumbnail (Common::SeekableReadStream *stream)
 
void writeGameScreenThumbnail (Common::WriteStream *stream)
 

Public Attributes

Common::String description
 
uint levelIndex
 
uint locationIndex
 
uint version
 
uint32 totalPlayTime
 
uint8 saveDay
 
uint8 saveMonth
 
uint16 saveYear
 
uint8 saveHour
 
uint8 saveMinute
 
uint8 saveSecond
 
bool isAutoSave
 
const Graphics::SurfacegameWindowThumbnail
 

Detailed Description

Utility class for reading and writing the save file header

The save file header contains metadata related to the save as well as a thumbnail of the game screen.

Member Function Documentation

◆ setSaveTime()

void Stark::SaveMetadata::setSaveTime ( const TimeDate timeDate)

Set the time the save was created on

◆ read()

Common::ErrorCode Stark::SaveMetadata::read ( Common::SeekableReadStream stream,
const Common::String filename 
)

Read the metadata from a stream

Parameters
filenameSave filename, used for the error messages only

◆ write()

void Stark::SaveMetadata::write ( Common::WriteStream stream)

Write the metadata to a stream

◆ readGameScreenThumbnail()

Graphics::Surface* Stark::SaveMetadata::readGameScreenThumbnail ( Common::SeekableReadStream stream)

Read the game screen thumbnail from a stream

◆ skipGameScreenThumbnail()

void Stark::SaveMetadata::skipGameScreenThumbnail ( Common::SeekableReadStream stream)

Skip the game screen thumbnail in a stream

◆ writeGameScreenThumbnail()

void Stark::SaveMetadata::writeGameScreenThumbnail ( Common::WriteStream stream)

Write the game screen thumbnail to a stream


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