DefaultSaveLoadHandler< TImpl, TObject > Class Template Reference

Default handler for saving/loading an object to/from disk. More...

#include <saveload.h>

Inheritance diagram for DefaultSaveLoadHandler< TImpl, TObject >:

Public Member Functions
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	Save (TObject *object) const
	Save the object to disk.
void	Save (void *object) const override
	Save the object to disk.
virtual void	Load (TObject *object) const
	Load the object from disk.
void	Load (void *object) const override
	Load the object from disk.
virtual void	LoadCheck (TObject *object) const
	Similar to load, but used only to validate savegames.
void	LoadCheck (void *object) const override
	Similar to load, but used only to validate savegames.
virtual void	FixPointers (TObject *object) const
	A post-load callback to fix SL_REF integers into pointers.
void	FixPointers (void *object) const override
	A post-load callback to fix SL_REF integers into pointers.
Public Member Functions inherited from SaveLoadHandler
virtual	~SaveLoadHandler ()=default
	Ensure the destructor of the sub classes are called as well.
SaveLoadTable	GetLoadDescription () const
	Get the description for how to load the chunk.

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

Detailed Description

template<class TImpl, class TObject>
class DefaultSaveLoadHandler< TImpl, TObject >

Default handler for saving/loading an object to/from disk.

This handles a few common things for handlers, meaning the actual handler needs less code.

Usage: class SlMine : public DefaultSaveLoadHandler<SlMine, MyObject> {}

Template Parameters

TImpl	The class initializing this template.
TObject	The class of the object using this SaveLoadHandler.

Definition at line 603 of file saveload.h.

Member Function Documentation

FixPointers() [1/2]

template<class TImpl, class TObject>

virtual void DefaultSaveLoadHandler< TImpl, TObject >::FixPointers ( TObject * object ) const

inlinevirtual

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

Parameters

object

The object to fix.

Reimplemented in SlCompanyEconomy, SlCompanySettings, SlStationBase, SlStationCargo, SlStationGoods, SlStationNormal, SlStationWaypoint, SlVehicleAircraft, SlVehicleCommon, SlVehicleDisaster, SlVehicleEffect, SlVehicleRoadVeh, SlVehicleShip, and SlVehicleTrain.

Definition at line 634 of file saveload.h.

FixPointers() [2/2]

template<class TImpl, class TObject>

void DefaultSaveLoadHandler< TImpl, TObject >::FixPointers ( void * object ) const

inlineoverridevirtual

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

Parameters

object

The object to fix.

Reimplemented from SaveLoadHandler.

Definition at line 635 of file saveload.h.

References FixPointers().

Referenced by FixPointers().

GetCompatDescription()

template<class TImpl, class TObject>

SaveLoadCompatTable DefaultSaveLoadHandler< TImpl, TObject >::GetCompatDescription ( ) const

inlineoverridevirtual

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

Returns

Compatibility save load description.

Implements SaveLoadHandler.

Definition at line 607 of file saveload.h.

GetDescription()

template<class TImpl, class TObject>

SaveLoadTable DefaultSaveLoadHandler< TImpl, TObject >::GetDescription ( ) const

inlineoverridevirtual

Get the description of the fields in the savegame.

Returns

Save load description.

Implements SaveLoadHandler.

Reimplemented in SlCompanyOldAIBuildRec, and SlLinkgraphJobProxy.

Definition at line 605 of file saveload.h.

Referenced by VectorSaveLoadHandler< TImpl, TObject, TElementType, MAX_LENGTH >::Save().

Load() [1/2]

template<class TImpl, class TObject>

virtual void DefaultSaveLoadHandler< TImpl, TObject >::Load ( TObject * object ) const

inlinevirtual

Load the object from disk.

Parameters

object

The object to load.

Reimplemented in SlCompanyEconomy, SlCompanyLiveries, SlCompanyOldAI, SlCompanyOldAIBuildRec, SlCompanyOldEconomy, SlCompanySettings, SlGameLanguageString, SlGamelogAction, SlGamelogEmergency, SlGamelogGrfadd, SlGamelogGrfbug, SlGamelogGrfcompat, SlGamelogGrfmove, SlGamelogGrfparam, SlGamelogGrfrem, SlGamelogMode, SlGamelogOldver, SlGamelogRevision, SlGamelogSetting, SlIndustryAcceptedHistory, SlIndustryProducedHistory, SlLinkgraphEdge, SlLinkgraphJobProxy, SlLinkgraphNode, SlStationBase, SlStationCargo, SlStationFlow, SlStationGoods, SlStationNormal, SlStationWaitingTriggers, SlStationWaypoint, SlTownAcceptanceMatrix, SlTownOldSupplied, SlTownReceived, SlTownSuppliedHistory, SlVehicleAircraft, SlVehicleCommon, SlVehicleDisaster, SlVehicleEffect, SlVehicleRoadVeh, SlVehicleShip, SlVehicleTrain, VectorSaveLoadHandler< TImpl, TObject, TElementType, MAX_LENGTH >, VectorSaveLoadHandler< SlAllowListData, CompanyProperties, std::string >, VectorSaveLoadHandler< SlIndustryAccepted, Industry, Industry::AcceptedCargo, INDUSTRY_NUM_INPUTS >, VectorSaveLoadHandler< SlIndustryProduced, Industry, Industry::ProducedCargo, INDUSTRY_NUM_OUTPUTS >, VectorSaveLoadHandler< SlOrders< T >, T, Order >, VectorSaveLoadHandler< SlRoadStopTileData, BaseStation, RoadStopTileData >, VectorSaveLoadHandler< SlStationSpecList< T >, BaseStation, SpecMapping< T > >, VectorSaveLoadHandler< SlTownSupplied, Town, Town::SuppliedCargo >, VectorSaveLoadHandler< SlVehicleRoadVehPath, RoadVehicle, RoadVehPathElement >, and VectorSaveLoadHandler< SlVehicleShipPath, Ship, ShipPathElement >.

Definition at line 620 of file saveload.h.

Load() [2/2]

template<class TImpl, class TObject>

void DefaultSaveLoadHandler< TImpl, TObject >::Load ( void * object ) const

inlineoverridevirtual

Load the object from disk.

Parameters

object

The object to load.

Reimplemented from SaveLoadHandler.

Definition at line 621 of file saveload.h.

References Load().

Referenced by Load().

LoadCheck() [1/2]

template<class TImpl, class TObject>

virtual void DefaultSaveLoadHandler< TImpl, TObject >::LoadCheck ( TObject * object ) const

inlinevirtual

Similar to load, but used only to validate savegames.

Parameters

object

The object to load.

Reimplemented in SlAllowListData, SlCompanyEconomy, SlCompanyLiveries, SlCompanyOldAI, SlCompanyOldAIBuildRec, SlCompanyOldEconomy, SlCompanySettings, SlGamelogAction, SlGamelogEmergency, SlGamelogGrfadd, SlGamelogGrfbug, SlGamelogGrfcompat, SlGamelogGrfmove, SlGamelogGrfparam, SlGamelogGrfrem, SlGamelogMode, SlGamelogOldver, SlGamelogRevision, SlGamelogSetting, and SlOrders< T >.

Definition at line 627 of file saveload.h.

LoadCheck() [2/2]

template<class TImpl, class TObject>

void DefaultSaveLoadHandler< TImpl, TObject >::LoadCheck ( void * object ) const

inlineoverridevirtual

Similar to load, but used only to validate savegames.

Parameters

object

The object to load.

Reimplemented from SaveLoadHandler.

Definition at line 628 of file saveload.h.

References LoadCheck().

Referenced by LoadCheck().

Save() [1/2]

template<class TImpl, class TObject>

virtual void DefaultSaveLoadHandler< TImpl, TObject >::Save ( TObject * object ) const

inlinevirtual

Save the object to disk.

Parameters

object

The object to store.

Reimplemented in SlCompanyEconomy, SlCompanyLiveries, SlCompanyOldEconomy, SlCompanySettings, SlGameLanguageString, SlGamelogAction, SlGamelogEmergency, SlGamelogGrfadd, SlGamelogGrfbug, SlGamelogGrfcompat, SlGamelogGrfmove, SlGamelogGrfparam, SlGamelogGrfrem, SlGamelogMode, SlGamelogOldver, SlGamelogRevision, SlGamelogSetting, SlIndustryAcceptedHistory, SlIndustryProducedHistory, SlLinkgraphEdge, SlLinkgraphJobProxy, SlLinkgraphNode, SlStationBase, SlStationCargo, SlStationFlow, SlStationGoods, SlStationNormal, SlStationWaitingTriggers, SlStationWaypoint, SlTownReceived, SlTownSuppliedHistory, SlVehicleAircraft, SlVehicleCommon, SlVehicleDisaster, SlVehicleEffect, SlVehicleRoadVeh, SlVehicleShip, SlVehicleTrain, VectorSaveLoadHandler< TImpl, TObject, TElementType, MAX_LENGTH >, VectorSaveLoadHandler< SlAllowListData, CompanyProperties, std::string >, VectorSaveLoadHandler< SlIndustryAccepted, Industry, Industry::AcceptedCargo, INDUSTRY_NUM_INPUTS >, VectorSaveLoadHandler< SlIndustryProduced, Industry, Industry::ProducedCargo, INDUSTRY_NUM_OUTPUTS >, VectorSaveLoadHandler< SlOrders< T >, T, Order >, VectorSaveLoadHandler< SlRoadStopTileData, BaseStation, RoadStopTileData >, VectorSaveLoadHandler< SlStationSpecList< T >, BaseStation, SpecMapping< T > >, VectorSaveLoadHandler< SlTownSupplied, Town, Town::SuppliedCargo >, VectorSaveLoadHandler< SlVehicleRoadVehPath, RoadVehicle, RoadVehPathElement >, and VectorSaveLoadHandler< SlVehicleShipPath, Ship, ShipPathElement >.

Definition at line 613 of file saveload.h.

Save() [2/2]

template<class TImpl, class TObject>

void DefaultSaveLoadHandler< TImpl, TObject >::Save ( void * object ) const

inlineoverridevirtual

Save the object to disk.

Parameters

object

The object to store.

Reimplemented from SaveLoadHandler.

Definition at line 614 of file saveload.h.

References Save().

Referenced by Save().

---

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

• src/saveload/saveload.h