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

Public Member Functions

size_t GetNumCargo () const
 Get the number of cargoes used by this savegame version.
void Save (BaseStation *bst) const override
 Save the object to disk.
void Load (BaseStation *bst) const override
 Load the object from disk.
void FixPointers (BaseStation *bst) const override
 A post-load callback to fix SaveLoadType::Reference integers into pointers.
Public Member Functions inherited from DefaultSaveLoadHandler< SlStationGoods, BaseStation >
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 LoadCheck (BaseStation *object) const
 Similar to load, but used only to validate savegames.
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 uint cargo_reserved_count
static const SaveLoad description []
static const SaveLoadCompatTable compat_description = _station_goods_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 370 of file station_sl.cpp.

Member Function Documentation

◆ FixPointers()

void SlStationGoods::FixPointers ( BaseStation * object) const
inlineoverridevirtual

A post-load callback to fix SaveLoadType::Reference integers into pointers.

Parameters
objectThe object to fix.

Reimplemented from DefaultSaveLoadHandler< SlStationGoods, BaseStation >.

Definition at line 469 of file station_sl.cpp.

References Cargodist, ExtendCargotypes, SpecializedStation< Station, false >::From(), DefaultSaveLoadHandler< SlStationGoods, BaseStation >::GetDescription(), Station::goods, IsSavegameVersionBefore(), NewGRFCargo, NUM_CARGO, SlObject(), and SwapPackets().

◆ GetNumCargo()

size_t SlStationGoods::GetNumCargo ( ) const
inline

Get the number of cargoes used by this savegame version.

Returns
The number of cargoes used by this savegame version.

Definition at line 405 of file station_sl.cpp.

References ExtendCargotypes, IsSavegameVersionBefore(), NewGRFCargo, NUM_CARGO, SaveloadListLength, and SlGetStructListLength().

◆ Load()

void SlStationGoods::Load ( BaseStation * object) const
inlineoverridevirtual

Load the object from disk.

Parameters
objectThe object to load.

Reimplemented from DefaultSaveLoadHandler< SlStationGoods, BaseStation >.

Definition at line 426 of file station_sl.cpp.

References GoodsEntry::Acceptance, Airport, Station::airport, StationCargoList::Append(), GoodsEntry::GoodsEntryData::cargo, Cargodist, CargoPackets, CargoReservation, BaseStation::facilities, SpecializedStation< Station, false >::From(), GB(), SaveLoadHandler::GetLoadDescription(), GoodsEntry::GetOrCreateData(), Station::goods, HasBit(), Invalid, IsSavegameVersionBefore(), LargerCargoSource, NewGRFAirportSmoke, PersistentStoragePool, Airport::psa, GoodsEntry::Rating, StationCargoList::reserved_count, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), SlObject(), GoodsEntry::status, PersistentStorageArray< TYPE, SIZE >::storage, SwapPackets(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ Save()

void SlStationGoods::Save ( BaseStation * object) const
inlineoverridevirtual

Save the object to disk.

Parameters
objectThe object to store.

Reimplemented from DefaultSaveLoadHandler< SlStationGoods, BaseStation >.

Definition at line 414 of file station_sl.cpp.

References GoodsEntry::GoodsEntryData::cargo, SpecializedStation< Station, false >::From(), GoodsEntry::GetData(), DefaultSaveLoadHandler< SlStationGoods, BaseStation >::GetDescription(), Station::goods, GoodsEntry::HasData(), NUM_CARGO, StationCargoList::reserved_count, SlObject(), and SlSetStructListLength().

Field Documentation

◆ cargo_reserved_count

uint SlStationGoods::cargo_reserved_count
inlinestatic

Definition at line 372 of file station_sl.cpp.

◆ compat_description

const SaveLoadCompatTable SlStationGoods::compat_description = _station_goods_sl_compat
inlinestatic

Definition at line 399 of file station_sl.cpp.

◆ description

const SaveLoad SlStationGoods::description[]
inlinestatic
Initial value:
= {
SaveLoad::Variable<VarFileType::U16>("waiting_acceptance", SLE_GLOBAL_ADDRESS(_waiting_acceptance), SaveLoadVersion::MinVersion, SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U8>("status", SLE_OBJECT_ADDRESS(GoodsEntry, status), SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U8>("time_since_pickup", SLE_OBJECT_ADDRESS(GoodsEntry, time_since_pickup)),
SaveLoad::Variable<VarFileType::U8>("rating", SLE_OBJECT_ADDRESS(GoodsEntry, rating)),
SaveLoad::Variable<VarFileType::U8>("cargo_source", SLE_GLOBAL_ADDRESS(_cargo_source), SaveLoadVersion::MinVersion, SaveLoadVersion::LargerCargoSource),
SaveLoad::Variable<VarFileType::U16>("cargo_source", SLE_GLOBAL_ADDRESS(_cargo_source), SaveLoadVersion::LargerCargoSource, SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U32>("cargo_source_xy", SLE_GLOBAL_ADDRESS(_cargo_source_xy), SaveLoadVersion::CargoSourceTile, SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U8>("cargo_days", SLE_GLOBAL_ADDRESS(_cargo_periods), SaveLoadVersion::MinVersion, SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U8>("last_speed", SLE_OBJECT_ADDRESS(GoodsEntry, last_speed)),
SaveLoad::Variable<VarFileType::U8>("last_age", SLE_OBJECT_ADDRESS(GoodsEntry, last_age)),
SaveLoad::Variable<VarFileType::U32>("cargo_feeder_share", SLE_GLOBAL_ADDRESS(_cargo_feeder_share), SaveLoadVersion::TransferOrder, SaveLoadVersion::UnifyCurrency),
SaveLoad::Variable<VarFileType::I64>("cargo_feeder_share", SLE_GLOBAL_ADDRESS(_cargo_feeder_share), SaveLoadVersion::UnifyCurrency, SaveLoadVersion::CargoPackets),
SaveLoad::Variable<VarFileType::U8>("amount_fract", SLE_OBJECT_ADDRESS(GoodsEntry, amount_fract), SaveLoadVersion::FractionalCargoDelivery),
SaveLoad::ReferenceList<SLRefType::CargoPacket>("packets", SLE_GLOBAL_ADDRESS(_packets), SaveLoadVersion::CargoPackets, SaveLoadVersion::Cargodist),
SaveLoad::Variable<VarFileType::U32>("old_num_dests", SLE_GLOBAL_ADDRESS(_old_num_dests), SaveLoadVersion::Cargodist, SaveLoadVersion::SaveloadListLength),
SaveLoad::Variable<VarFileType::U32>("cargo.reserved_count", SLE_GLOBAL_ADDRESS(SlStationGoods::cargo_reserved_count), SaveLoadVersion::CargoReservation),
SaveLoad::Variable<VarFileType::U16>("link_graph", SLE_OBJECT_ADDRESS(GoodsEntry, link_graph), SaveLoadVersion::Cargodist),
SaveLoad::Variable<VarFileType::U16>("node", SLE_OBJECT_ADDRESS(GoodsEntry, node), SaveLoadVersion::Cargodist),
SaveLoad::Variable<VarFileType::U32>("old_num_flows", SLE_GLOBAL_ADDRESS(_old_num_flows), SaveLoadVersion::Cargodist, SaveLoadVersion::SaveloadListLength),
SaveLoad::Variable<VarFileType::U32>("max_waiting_cargo", SLE_OBJECT_ADDRESS(GoodsEntry, max_waiting_cargo), SaveLoadVersion::Cargodist),
SaveLoad::StructList<SlStationFlow>("flow", SaveLoadVersion::Cargodist),
SaveLoad::StructList<SlStationCargo>("cargo", SaveLoadVersion::Cargodist),
}
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::UnifyCurrency
@ UnifyCurrency
Saveload version: 65, SVN revision: 10210 Make all variables related to currency 64 bits.
Definition saveload.h:128
SaveLoadVersion::CargoReservation
@ CargoReservation
Saveload version: 181, SVN revision: 25012 Persist the reservation of cargo for vehicles instead of ...
Definition saveload.h:267
SaveLoadVersion::LargerCargoSource
@ LargerCargoSource
Saveload version: 7.0, SVN revision: 1770 With more stations, the size of the cargo source needed to...
Definition saveload.h:55
SaveLoadVersion::TransferOrder
@ TransferOrder
Saveload version: 14.0, SVN revision: 2441 Transfer orders for feeder systems.
Definition saveload.h:64
SaveLoadVersion::FractionalCargoDelivery
@ FractionalCargoDelivery
Saveload version: 150, SVN revision: 20857 When spreading cargo over stations, spread fractional amo...
Definition saveload.h:230
SaveLoadVersion::CargoSourceTile
@ CargoSourceTile
Saveload version: 44, SVN revision: 8144 Store the source tile of the cargo, so accurate payment can...
Definition saveload.h:102
SaveLoadVersion::Cargodist
@ Cargodist
Saveload version: 183, SVN revision: 25363 Cargodist.
Definition saveload.h:269
SaveLoadVersion::MinVersion
@ MinVersion
First savegame version.
Definition saveload.h:37
SaveLoadVersion::SaveloadListLength
@ SaveloadListLength
Saveload version: 293, GitHub pull request: 9374 Consistency in list length with SaveLoadType::Struc...
Definition saveload.h:337
SaveLoadVersion::CargoPackets
@ CargoPackets
Saveload version: 68, SVN revision: 10266 Account for individual units of cargo, i....
Definition saveload.h:131
GoodsEntry
Stores station stats for a single cargo.
Definition station_base.h:167
SaveLoad::StructList
static SaveLoad StructList(std::string name, SaveLoadVersion from=SaveLoadVersion::MinVersion, SaveLoadVersion to=SaveLoadVersion::MaxVersion)
Storage of a list of structs, optionally in some savegame versions.
Definition saveload.h:1103
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::ReferenceList
static SaveLoad ReferenceList(std::string name, AddressFunction< T > address_func, SaveLoadVersion from=SaveLoadVersion::MinVersion, SaveLoadVersion to=SaveLoadVersion::MaxVersion)
Storage of a list of references to pool elements in some savegame versions.
Definition saveload.h:1078

Definition at line 374 of file station_sl.cpp.

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