ScummVM API documentation
Gob::SavePartInfo Class Reference

#include <savefile.h>

Inheritance diagram for Gob::SavePartInfo:
Gob::SavePart

Public Member Functions

 SavePartInfo (uint32 descMaxLength, uint32 gameID, uint32 gameVersion, byte endian, uint32 varCount)
 
const char * getDesc () const
 
uint32 getDescMaxLength () const
 
void setVarCount (uint32 varCount)
 
void setDesc (const char *desc=0)
 
void setDesc (const byte *desc, uint32 size)
 
bool read (Common::ReadStream &stream) override
 
bool write (Common::WriteStream &stream) const override
 
- Public Member Functions inherited from Gob::SavePart
virtual uint32 getSize () const
 

Static Public Attributes

static const uint32 kVersion = 1
 
static const uint32 kID = MKTAG('I','N','F','O')
 

Additional Inherited Members

- Protected Attributes inherited from Gob::SavePart
SaveHeader _header
 

Detailed Description

A save part containing informations about the save's game.

Constructor & Destructor Documentation

◆ SavePartInfo()

Gob::SavePartInfo::SavePartInfo ( uint32  descMaxLength,
uint32  gameID,
uint32  gameVersion,
byte  endian,
uint32  varCount 
)

The constructor.

Parameters
descMaxLengthThe maximal number of bytes that fit into the description.
gameIDAn ID for the game (Gob1, Gob2, Gob3, ...).
gameVersionAn ID for game specific versioning
endianEndianness of the platform the game originally ran on.
varCountThe number of script variables.

Member Function Documentation

◆ getDesc()

const char* Gob::SavePartInfo::getDesc ( ) const

Return the save's description.

◆ getDescMaxLength()

uint32 Gob::SavePartInfo::getDescMaxLength ( ) const

Return the description's maximal length.

◆ setVarCount()

void Gob::SavePartInfo::setVarCount ( uint32  varCount)

Set the variable count.

◆ setDesc() [1/2]

void Gob::SavePartInfo::setDesc ( const char *  desc = 0)

Set the save's description.

◆ setDesc() [2/2]

void Gob::SavePartInfo::setDesc ( const byte *  desc,
uint32  size 
)

Set the save's description.

◆ read()

bool Gob::SavePartInfo::read ( Common::ReadStream stream)
overridevirtual

Read the part (with header) out of the stream.

Implements Gob::SavePart.

◆ write()

bool Gob::SavePartInfo::write ( Common::WriteStream stream) const
overridevirtual

Write the part (with header) into the stream.

Implements Gob::SavePart.


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