OpenTTD Source  20240919-master-gdf0233f4c2
Public Member Functions | Data Fields
SaveLoadHandler Class Referenceabstract

Handler for saving/loading an object to/from disk. More...

#include <saveload.h>

Inheritance diagram for SaveLoadHandler:
DefaultSaveLoadHandler< TImpl, TObject > DefaultSaveLoadHandler< SlAllowListData, CompanyProperties > DefaultSaveLoadHandler< SlCompanyEconomy, CompanyProperties > DefaultSaveLoadHandler< SlCompanyLiveries, CompanyProperties > DefaultSaveLoadHandler< SlCompanyOldAI, CompanyProperties > DefaultSaveLoadHandler< SlCompanyOldAIBuildRec, CompanyOldAI > DefaultSaveLoadHandler< SlCompanySettings, CompanyProperties > DefaultSaveLoadHandler< SlGameLanguageString, LanguageStrings > DefaultSaveLoadHandler< SlGamelogAction, LoggedAction > DefaultSaveLoadHandler< SlGamelogEmergency, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfadd, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfbug, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfcompat, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfmove, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfparam, LoggedChange > DefaultSaveLoadHandler< SlGamelogGrfrem, LoggedChange > DefaultSaveLoadHandler< SlGamelogMode, LoggedChange > DefaultSaveLoadHandler< SlGamelogOldver, LoggedChange > DefaultSaveLoadHandler< SlGamelogRevision, LoggedChange > DefaultSaveLoadHandler< SlGamelogSetting, LoggedChange > DefaultSaveLoadHandler< SlIndustryAccepted, Industry > DefaultSaveLoadHandler< SlIndustryProduced, Industry > DefaultSaveLoadHandler< SlIndustryProducedHistory, Industry::ProducedCargo > DefaultSaveLoadHandler< SlLinkgraphEdge, Node > DefaultSaveLoadHandler< SlLinkgraphJobProxy, LinkGraphJob > DefaultSaveLoadHandler< SlLinkgraphNode, LinkGraph > DefaultSaveLoadHandler< SlRoadStopTileData, BaseStation > DefaultSaveLoadHandler< SlStationBase, BaseStation > DefaultSaveLoadHandler< SlStationCargo, GoodsEntry > DefaultSaveLoadHandler< SlStationFlow, GoodsEntry > DefaultSaveLoadHandler< SlStationGoods, BaseStation > DefaultSaveLoadHandler< SlStationNormal, BaseStation > DefaultSaveLoadHandler< SlStationSpecList< T >, BaseStation > DefaultSaveLoadHandler< SlStationWaypoint, BaseStation > DefaultSaveLoadHandler< SlTownAcceptanceMatrix, Town > DefaultSaveLoadHandler< SlTownReceived, Town > DefaultSaveLoadHandler< SlTownSupplied, Town > DefaultSaveLoadHandler< SlVehicleAircraft, Vehicle > DefaultSaveLoadHandler< SlVehicleCommon, Vehicle > DefaultSaveLoadHandler< SlVehicleDisaster, Vehicle > DefaultSaveLoadHandler< SlVehicleEffect, Vehicle > DefaultSaveLoadHandler< SlVehicleRoadVeh, Vehicle > DefaultSaveLoadHandler< SlVehicleShip, Vehicle > DefaultSaveLoadHandler< SlVehicleTrain, Vehicle > SlSkipHandler

Public Member Functions

virtual void Save ([[maybe_unused]] void *object) const
 Save the object to disk. More...
 
virtual void Load ([[maybe_unused]] void *object) const
 Load the object from disk. More...
 
virtual void LoadCheck ([[maybe_unused]] void *object) const
 Similar to load, but used only to validate savegames. More...
 
virtual void FixPointers ([[maybe_unused]] void *object) const
 A post-load callback to fix SL_REF integers into pointers. More...
 
virtual SaveLoadTable GetDescription () const =0
 Get the description of the fields in the savegame.
 
virtual SaveLoadCompatTable GetCompatDescription () const =0
 Get the pre-header description of the fields in the savegame.
 
SaveLoadTable GetLoadDescription () const
 Get the description for how to load the chunk. More...
 

Data Fields

std::optional< std::vector< SaveLoad > > load_description
 

Detailed Description

Handler for saving/loading an object to/from disk.

Definition at line 513 of file saveload.h.

Member Function Documentation

◆ FixPointers()

virtual void SaveLoadHandler::FixPointers ( [[maybe_unused] ] void *  object) const
inlinevirtual

A post-load callback to fix SL_REF integers into pointers.

Parameters
objectThe object to fix.

Definition at line 541 of file saveload.h.

◆ GetLoadDescription()

SaveLoadTable SaveLoadHandler::GetLoadDescription ( ) const

Get the description for how to load the chunk.

Depending on the savegame version this can either use the headers in the savegame or fall back to backwards compatibility and uses hard-coded headers.

Definition at line 3288 of file saveload.cpp.

◆ Load()

virtual void SaveLoadHandler::Load ( [[maybe_unused] ] void *  object) const
inlinevirtual

Load the object from disk.

Parameters
objectThe object to load.

Definition at line 529 of file saveload.h.

◆ LoadCheck()

virtual void SaveLoadHandler::LoadCheck ( [[maybe_unused] ] void *  object) const
inlinevirtual

Similar to load, but used only to validate savegames.

Parameters
objectThe object to load.

Definition at line 535 of file saveload.h.

◆ Save()

virtual void SaveLoadHandler::Save ( [[maybe_unused] ] void *  object) const
inlinevirtual

Save the object to disk.

Parameters
objectThe object to store.

Definition at line 523 of file saveload.h.

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