SaveLoadHandler Class Reference

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

#include <saveload.h>

Inheritance diagram for SaveLoadHandler:

Public Member Functions
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 SL_REF integers into pointers.
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.

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

Detailed Description

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

Definition at line 538 of file saveload.h.

Member Function Documentation

FixPointers()

virtual void SaveLoadHandler::FixPointers ( void * object ) const

inlinevirtual

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

Parameters

object

The object to fix.

Reimplemented in DefaultSaveLoadHandler< TImpl, TObject >.

Definition at line 566 of file saveload.h.

GetCompatDescription()

virtual SaveLoadCompatTable SaveLoadHandler::GetCompatDescription ( ) const

pure virtual

Get the pre-header description of the fields in the savegame.

Returns

Compatibility save load description.

Implemented in 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< SlIndustryAcceptedHistory, Industry::AcceptedCargo >, DefaultSaveLoadHandler< SlIndustryProduced, Industry >, DefaultSaveLoadHandler< SlIndustryProducedHistory, Industry::ProducedCargo >, DefaultSaveLoadHandler< SlLinkgraphEdge, Node >, DefaultSaveLoadHandler< SlLinkgraphJobProxy, LinkGraphJob >, DefaultSaveLoadHandler< SlLinkgraphNode, LinkGraph >, DefaultSaveLoadHandler< SlOrders< T >, T >, DefaultSaveLoadHandler< SlRoadStopTileData, BaseStation >, DefaultSaveLoadHandler< SlStationBase, BaseStation >, DefaultSaveLoadHandler< SlStationCargo, GoodsEntry >, DefaultSaveLoadHandler< SlStationFlow, GoodsEntry >, DefaultSaveLoadHandler< SlStationGoods, BaseStation >, DefaultSaveLoadHandler< SlStationNormal, BaseStation >, DefaultSaveLoadHandler< SlStationSpecList< T >, BaseStation >, DefaultSaveLoadHandler< SlStationWaitingTriggers, BaseStation >, DefaultSaveLoadHandler< SlStationWaypoint, BaseStation >, DefaultSaveLoadHandler< SlTownAcceptanceMatrix, Town >, DefaultSaveLoadHandler< SlTownOldSupplied, Town >, DefaultSaveLoadHandler< SlTownReceived, Town >, DefaultSaveLoadHandler< SlTownSupplied, Town >, DefaultSaveLoadHandler< SlTownSuppliedHistory, Town::SuppliedCargo >, DefaultSaveLoadHandler< SlVehicleAircraft, Vehicle >, DefaultSaveLoadHandler< SlVehicleCommon, Vehicle >, DefaultSaveLoadHandler< SlVehicleDisaster, Vehicle >, DefaultSaveLoadHandler< SlVehicleEffect, Vehicle >, DefaultSaveLoadHandler< SlVehicleRoadVeh, Vehicle >, DefaultSaveLoadHandler< SlVehicleRoadVehPath, RoadVehicle >, DefaultSaveLoadHandler< SlVehicleShip, Vehicle >, DefaultSaveLoadHandler< SlVehicleShipPath, Ship >, DefaultSaveLoadHandler< SlVehicleTrain, Vehicle >, and SlSkipHandler.

GetDescription()

virtual SaveLoadTable SaveLoadHandler::GetDescription ( ) const

pure virtual

Get the description of the fields in the savegame.

Returns

Save load description.

Implemented in 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< SlIndustryAcceptedHistory, Industry::AcceptedCargo >, DefaultSaveLoadHandler< SlIndustryProduced, Industry >, DefaultSaveLoadHandler< SlIndustryProducedHistory, Industry::ProducedCargo >, DefaultSaveLoadHandler< SlLinkgraphEdge, Node >, DefaultSaveLoadHandler< SlLinkgraphJobProxy, LinkGraphJob >, DefaultSaveLoadHandler< SlLinkgraphNode, LinkGraph >, DefaultSaveLoadHandler< SlOrders< T >, T >, DefaultSaveLoadHandler< SlRoadStopTileData, BaseStation >, DefaultSaveLoadHandler< SlStationBase, BaseStation >, DefaultSaveLoadHandler< SlStationCargo, GoodsEntry >, DefaultSaveLoadHandler< SlStationFlow, GoodsEntry >, DefaultSaveLoadHandler< SlStationGoods, BaseStation >, DefaultSaveLoadHandler< SlStationNormal, BaseStation >, DefaultSaveLoadHandler< SlStationSpecList< T >, BaseStation >, DefaultSaveLoadHandler< SlStationWaitingTriggers, BaseStation >, DefaultSaveLoadHandler< SlStationWaypoint, BaseStation >, DefaultSaveLoadHandler< SlTownAcceptanceMatrix, Town >, DefaultSaveLoadHandler< SlTownOldSupplied, Town >, DefaultSaveLoadHandler< SlTownReceived, Town >, DefaultSaveLoadHandler< SlTownSupplied, Town >, DefaultSaveLoadHandler< SlTownSuppliedHistory, Town::SuppliedCargo >, DefaultSaveLoadHandler< SlVehicleAircraft, Vehicle >, DefaultSaveLoadHandler< SlVehicleCommon, Vehicle >, DefaultSaveLoadHandler< SlVehicleDisaster, Vehicle >, DefaultSaveLoadHandler< SlVehicleEffect, Vehicle >, DefaultSaveLoadHandler< SlVehicleRoadVeh, Vehicle >, DefaultSaveLoadHandler< SlVehicleRoadVehPath, RoadVehicle >, DefaultSaveLoadHandler< SlVehicleShip, Vehicle >, DefaultSaveLoadHandler< SlVehicleShipPath, Ship >, DefaultSaveLoadHandler< SlVehicleTrain, Vehicle >, SlCompanyOldAIBuildRec, SlLinkgraphJobProxy, and SlSkipHandler.

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 3445 of file saveload.cpp.

References load_description.

Referenced by SlCompanyOldAI::Load(), SlCompanyOldAIBuildRec::Load(), SlCompanySettings::Load(), SlGameLanguageString::Load(), SlGamelogEmergency::Load(), SlGamelogGrfadd::Load(), SlGamelogGrfbug::Load(), SlGamelogGrfcompat::Load(), SlGamelogGrfmove::Load(), SlGamelogGrfparam::Load(), SlGamelogGrfrem::Load(), SlGamelogMode::Load(), SlGamelogOldver::Load(), SlGamelogRevision::Load(), SlGamelogSetting::Load(), SlIndustryAcceptedHistory::Load(), SlIndustryProducedHistory::Load(), SlLinkgraphEdge::Load(), SlSkipHandler::Load(), SlStationBase::Load(), SlStationCargo::Load(), SlStationFlow::Load(), SlStationGoods::Load(), SlStationNormal::Load(), SlStationWaitingTriggers::Load(), SlStationWaypoint::Load(), SlTownAcceptanceMatrix::Load(), SlTownOldSupplied::Load(), SlTownSuppliedHistory::Load(), SlVehicleAircraft::Load(), SlVehicleCommon::Load(), SlVehicleDisaster::Load(), SlVehicleEffect::Load(), SlVehicleRoadVeh::Load(), SlVehicleShip::Load(), SlVehicleTrain::Load(), and VectorSaveLoadHandler< TImpl, TObject, TElementType, MAX_LENGTH >::Load().

Load()

virtual void SaveLoadHandler::Load ( void * object ) const

inlinevirtual

Load the object from disk.

Parameters

object

The object to load.

Reimplemented in DefaultSaveLoadHandler< TImpl, TObject >, and SlSkipHandler.

Definition at line 554 of file saveload.h.

LoadCheck()

virtual void SaveLoadHandler::LoadCheck ( void * object ) const

inlinevirtual

Similar to load, but used only to validate savegames.

Parameters

object

The object to load.

Reimplemented in DefaultSaveLoadHandler< TImpl, TObject >, and SlSkipHandler.

Definition at line 560 of file saveload.h.

Save()

virtual void SaveLoadHandler::Save ( void * object ) const

inlinevirtual

Save the object to disk.

Parameters

object

The object to store.

Reimplemented in DefaultSaveLoadHandler< TImpl, TObject >, and SlSkipHandler.

Definition at line 548 of file saveload.h.

Field Documentation

load_description

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

Description derived from savegame being loaded.

Definition at line 540 of file saveload.h.

Referenced by GetLoadDescription().

---

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

• src/saveload/saveload.h
• src/saveload/saveload.cpp