OpenTTD Source 20260917-master-gec444f7315
group_sl.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "../stdafx.h"
11#include "../group.h"
12#include "../company_base.h"
13
14#include "saveload.h"
16
17#include "../safeguards.h"
18
19static const SaveLoad _group_desc[] = {
23 SaveLoad::Variable<VarFileType::U8>("vehicle_type", SLE_OBJECT_ADDRESS(Group, vehicle_type)),
30};
31
32struct GRPSChunkHandler : ChunkHandler {
33 GRPSChunkHandler() : ChunkHandler("GRPS", ChunkType::Table) {}
34
35 void Save() const override
36 {
37 SlTableHeader(_group_desc);
38
39 for (Group *g : Group::Iterate()) {
40 SlSetArrayIndex(g->index);
41 SlObject(g, _group_desc);
42 }
43 }
44
45
46 void Load() const override
47 {
48 const std::vector<SaveLoad> slt = SlCompatTableHeader(_group_desc, _group_sl_compat);
49
50 int index;
51
52 while ((index = SlIterateArray()) != -1) {
53 Group *g = Group::CreateAtIndex(GroupID(index));
54 SlObject(g, slt);
55
57 }
58 }
59};
60
61static const GRPSChunkHandler GRPS;
62static const ChunkHandlerRef group_chunk_handlers[] = {
63 GRPS,
64};
65
66extern const ChunkHandlerTable _group_chunk_handlers(group_chunk_handlers);
Definition of stuff that is very close to a company, like the company struct itself.
Base class for groups and group functions.
Loading of group chunks before table headers were added.
const SaveLoadCompat _group_sl_compat[]
Original field order for _group_desc.
A number of safeguards to prevent using unsafe methods.
std::vector< SaveLoad > SlCompatTableHeader(const SaveLoadTable &slt, const SaveLoadCompatTable &slct)
Load a table header in a savegame compatible way.
int SlIterateArray()
Iterate through the elements of an array and read the whole thing.
Definition saveload.cpp:745
void SlObject(void *object, const SaveLoadTable &slt)
Main SaveLoad function.
std::vector< SaveLoad > SlTableHeader(const SaveLoadTable &slt)
Save or Load a table header.
Functions/types related to saving and loading games.
#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
std::reference_wrapper< const ChunkHandler > ChunkHandlerRef
A reference to ChunkHandler.
Definition saveload.h:513
std::span< const ChunkHandlerRef > ChunkHandlerTable
A table of ChunkHandler entries.
Definition saveload.h:516
bool IsSavegameVersionBefore(SaveLoadVersion major, uint8_t minor=0)
Checks whether the savegame is below major.
Definition saveload.h:1226
@ GroupHierarchy
Saveload version: 189, SVN revision: 26450 Hierarchical vehicle subgroups.
Definition saveload.h:276
@ ReplaceCustomNameArray
Saveload version: 84, SVN revision: 11822 Replace single fixed size array of custom names,...
Definition saveload.h:150
@ GroupLiveries
Saveload version: 205, GitHub pull request: 7108 Livery storage change and group liveries.
Definition saveload.h:296
@ MinVersion
First savegame version.
Definition saveload.h:37
@ GroupNumbers
Saveload version: 336, GitHub pull request: 12297 Add per-company group numbers.
Definition saveload.h:389
@ Table
An Array with a header describing the elements.
Definition saveload.h:450
Definition of base types and functions in a cross-platform compatible way.
@ AllowControlCode
Allow the special control codes.
Definition string_type.h:47
ChunkHandler(ChunkId id, ChunkType type)
Create this ChunkHandler.
Definition saveload.h:470
void Load() const override
Load the chunk.
Definition group_sl.cpp:46
void Save() const override
Save the chunk.
Definition group_sl.cpp:35
Group data.
Definition group.h:76
GroupID parent
Parent group.
Definition group.h:88
static Pool::IterateWrapper< Group > Iterate(size_t from=0)
static T * CreateAtIndex(GroupID index, Targs &&... args)
SaveLoad type struct.
Definition saveload.h:764
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
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