OpenTTD Source 20260917-master-gec444f7315
SlGamelogRevision Class Reference
Inheritance diagram for SlGamelogRevision:
DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange > SaveLoadHandler

Public Member Functions

void Save (LoggedChange *lc) const override
 Save the object to disk.
void Load (LoggedChange *lc) const override
 Load the object from disk.
void LoadCheck (LoggedChange *lc) const override
 Similar to load, but used only to validate savegames.
Public Member Functions inherited from DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange >
SaveLoadTable GetDescription () const override
 Get the description of the fields in the savegame.
SaveLoadCompatTable GetCompatDescription () const override
 Get the pre-header description of the fields in the savegame.
virtual void FixPointers (LoggedChange *object) const
 A post-load callback to fix SaveLoadType::Reference integers into pointers.
Public Member Functions inherited from SaveLoadHandler
virtual ~SaveLoadHandler ()=default
 Ensure the destructor of the sub classes are called as well.
virtual void Save (void *object) const
 Save the object to disk.
virtual void Load (void *object) const
 Load the object from disk.
virtual void LoadCheck (void *object) const
 Similar to load, but used only to validate savegames.
virtual void FixPointers (void *object) const
 A post-load callback to fix SaveLoadType::Reference integers into pointers.
SaveLoadTable GetLoadDescription () const
 Get the description for how to load the chunk.

Static Public Attributes

static const size_t GAMELOG_REVISION_LENGTH = 15
 Length of the old revision text length.
static std::array< char, GAMELOG_REVISION_LENGTH > revision_text
 Temporary location to store the old revision text.
static const SaveLoad description []
static const SaveLoadCompatTable compat_description = _gamelog_revision_sl_compat

Additional Inherited Members

Data Fields inherited from SaveLoadHandler
std::optional< std::vector< SaveLoad > > load_description
 Description derived from savegame being loaded.

Detailed Description

Definition at line 45 of file gamelog_sl.cpp.

Member Function Documentation

◆ Load()

void SlGamelogRevision::Load ( LoggedChange * object) const
inlineoverridevirtual

Load the object from disk.

Parameters
objectThe object to load.

Reimplemented from DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange >.

Definition at line 65 of file gamelog_sl.cpp.

References LoggedChange::ct, SaveLoadHandler::GetLoadDescription(), IsSavegameVersionBefore(), Revision, revision_text, SlObject(), StringGamelog, and StrMakeValid().

Referenced by LoadCheck().

◆ LoadCheck()

void SlGamelogRevision::LoadCheck ( LoggedChange * object) const
inlineoverridevirtual

Similar to load, but used only to validate savegames.

Parameters
objectThe object to load.

Reimplemented from DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange >.

Definition at line 75 of file gamelog_sl.cpp.

References Load().

◆ Save()

void SlGamelogRevision::Save ( LoggedChange * object) const
inlineoverridevirtual

Save the object to disk.

Parameters
objectThe object to store.

Reimplemented from DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange >.

Definition at line 59 of file gamelog_sl.cpp.

References LoggedChange::ct, DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange >::GetDescription(), Revision, and SlObject().

Field Documentation

◆ compat_description

const SaveLoadCompatTable SlGamelogRevision::compat_description = _gamelog_revision_sl_compat
inlinestatic

Definition at line 57 of file gamelog_sl.cpp.

◆ description

const SaveLoad SlGamelogRevision::description[]
inlinestatic
Initial value:
= {
SaveLoad::Array<VarFileType::U8, GAMELOG_REVISION_LENGTH>("revision.text", SLE_GLOBAL_ADDRESS(SlGamelogRevision::revision_text), SaveLoadVersion::MinVersion, SaveLoadVersion::StringGamelog),
SaveLoad::String("revision.text", SLE_OBJECT_ADDRESS(LoggedChangeRevision, text), {}, SaveLoadVersion::StringGamelog),
SaveLoad::Variable<VarFileType::U32>("revision.newgrf", SLE_OBJECT_ADDRESS(LoggedChangeRevision, newgrf)),
SaveLoad::Variable<VarFileType::U16>("revision.slver", SLE_OBJECT_ADDRESS(LoggedChangeRevision, slver)),
SaveLoad::Variable<VarFileType::U8>("revision.modified", SLE_OBJECT_ADDRESS(LoggedChangeRevision, modified)),
}
SlGamelogRevision::revision_text
static std::array< char, GAMELOG_REVISION_LENGTH > revision_text
Temporary location to store the old revision text.
Definition gamelog_sl.cpp:48
SLE_OBJECT_ADDRESS
#define SLE_OBJECT_ADDRESS(base, variable)
Macro to be able to pass the variable type and construct the SaveLoad::AddressFunction given a base c...
Definition saveload.h:754
SLE_GLOBAL_ADDRESS
#define SLE_GLOBAL_ADDRESS(variable)
Macro to be able to pass the variable type and construct the SaveLoad::AddressFunction given a global...
Definition saveload.h:761
SaveLoadVersion::StringGamelog
@ StringGamelog
Saveload version: 314, GitHub pull request: 10801 Use std::string in gamelog.
Definition saveload.h:362
SaveLoadVersion::MinVersion
@ MinVersion
First savegame version.
Definition saveload.h:37
LoggedChangeRevision
A log entry for a change in OpenTTD version.
Definition gamelog_internal.h:80
SaveLoad::Variable
static SaveLoad Variable(std::string name, AddressFunction< T > address_func, SaveLoadVersion from=SaveLoadVersion::MinVersion, SaveLoadVersion to=SaveLoadVersion::MaxVersion, size_t extra=0)
Storage of a variable in some savegame versions.
Definition saveload.h:926
SaveLoad::Array
static SaveLoad Array(std::string name, AddressFunction< T > address_func, SaveLoadVersion from=SaveLoadVersion::MinVersion, SaveLoadVersion to=SaveLoadVersion::MaxVersion, size_t extra=0)
Storage of an array in some savegame versions.
Definition saveload.h:1026
SaveLoad::String
static SaveLoad String(std::string name, AddressFunction< T > address_func, StringValidationSettings string_validation_settings={}, SaveLoadVersion from=SaveLoadVersion::MinVersion, SaveLoadVersion to=SaveLoadVersion::MaxVersion, size_t extra=0)
Storage of a string in some savegame versions.
Definition saveload.h:977

Definition at line 50 of file gamelog_sl.cpp.

◆ GAMELOG_REVISION_LENGTH

const size_t SlGamelogRevision::GAMELOG_REVISION_LENGTH = 15
static

Length of the old revision text length.

Definition at line 47 of file gamelog_sl.cpp.

◆ revision_text

std::array<char, GAMELOG_REVISION_LENGTH> SlGamelogRevision::revision_text
inlinestatic

Temporary location to store the old revision text.

Definition at line 48 of file gamelog_sl.cpp.

Referenced by Load().

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