OpenTTD Source: src/saveload/group_sl.cpp Source File

OpenTTD Source 12.0-beta1

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 <http://www.gnu.org/licenses/>.
6 */
7
10 #include "../stdafx.h"
11 #include "../group.h"
12 #include "../company_base.h"
13
14 #include "saveload.h"
15 #include "compat/group_sl_compat.h"
16
17 #include "../safeguards.h"
18
19 static const SaveLoad _group_desc[] = {
20 SLE_CONDVAR(Group, name, SLE_NAME, SL_MIN_VERSION, SLV_84),
21 SLE_CONDSSTR(Group, name, SLE_STR | SLF_ALLOW_CONTROL, SLV_84, SL_MAX_VERSION),
22 SLE_VAR(Group, owner, SLE_UINT8),
23 SLE_VAR(Group, vehicle_type, SLE_UINT8),
24 SLE_VAR(Group, flags, SLE_UINT8),
25 SLE_CONDVAR(Group, livery.in_use, SLE_UINT8, SLV_GROUP_LIVERIES, SL_MAX_VERSION),
26 SLE_CONDVAR(Group, livery.colour1, SLE_UINT8, SLV_GROUP_LIVERIES, SL_MAX_VERSION),
27 SLE_CONDVAR(Group, livery.colour2, SLE_UINT8, SLV_GROUP_LIVERIES, SL_MAX_VERSION),
28 SLE_CONDVAR(Group, parent, SLE_UINT16, SLV_189, SL_MAX_VERSION),
29 };
30
31 struct GRPSChunkHandler : ChunkHandler {
32 GRPSChunkHandler() : ChunkHandler('GRPS', CH_TABLE) {}
33
34 void Save() const override
35 {
36 SlTableHeader(_group_desc);
37
38 for (Group *g : Group::Iterate()) {
39 SlSetArrayIndex(g->index);
40 SlObject(g, _group_desc);
41 }
42 }
43
44
45 void Load() const override
46 {
47 const std::vector<SaveLoad> slt = SlCompatTableHeader(_group_desc, _group_sl_compat);
48
49 int index;
50
51 while ((index = SlIterateArray()) != -1) {
52 Group *g = new (index) Group();
53 SlObject(g, slt);
54
55 if (IsSavegameVersionBefore(SLV_189)) g->parent = INVALID_GROUP;
56
57 if (IsSavegameVersionBefore(SLV_GROUP_LIVERIES)) {
58 const Company *c = Company::Get(g->owner);
59 g->livery.colour1 = c->livery[LS_DEFAULT].colour1;
60 g->livery.colour2 = c->livery[LS_DEFAULT].colour2;
61 }
62 }
63 }
64 };
65
66 static const GRPSChunkHandler GRPS;
67 static const ChunkHandlerRef group_chunk_handlers[] = {
68 GRPS,
69 };
70
71 extern const ChunkHandlerTable _group_chunk_handlers(group_chunk_handlers);
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
SL_MIN_VERSION
@ SL_MIN_VERSION
First savegame version.
Definition: saveload.h:35
SLE_CONDSSTR
#define SLE_CONDSSTR(base, variable, type, from, to)
Storage of a std::string in some savegame versions.
Definition: saveload.h:743
ChunkHandlerRef
std::reference_wrapper< const ChunkHandler > ChunkHandlerRef
A reference to ChunkHandler.
Definition: saveload.h:442
Group::parent
GroupID parent
Parent group.
Definition: group.h:83
SLE_CONDVAR
#define SLE_CONDVAR(base, variable, type, from, to)
Storage of a variable in some savegame versions.
Definition: saveload.h:701
SLV_84
@ SLV_84
84 11822
Definition: saveload.h:147
SLE_STR
#define SLE_STR(base, variable, type, length)
Storage of a string in every savegame version.
Definition: saveload.h:797
saveload.h
Group::livery
Livery livery
Custom colour scheme for vehicles in this group.
Definition: group.h:78
ChunkHandler
Handlers and description of chunk.
Definition: saveload.h:405
SLV_GROUP_LIVERIES
@ SLV_GROUP_LIVERIES
205 PR#7108 Livery storage change and group liveries.
Definition: saveload.h:294
GRPSChunkHandler
Definition: group_sl.cpp:31
Group
Group data.
Definition: group.h:72
SLF_ALLOW_CONTROL
@ SLF_ALLOW_CONTROL
Allow control codes in the strings.
Definition: saveload.h:624
INVALID_GROUP
static const GroupID INVALID_GROUP
Sentinel for invalid groups.
Definition: group_type.h:18
span
A trimmed down version of what std::span will be in C++20.
Definition: span_type.hpp:60
GRPSChunkHandler::Load
void Load() const override
Load the chunk.
Definition: group_sl.cpp:45
Group::owner
Owner owner
Group Owner.
Definition: group.h:74
_group_sl_compat
const SaveLoadCompat _group_sl_compat[]
Original field order for _group_desc.
Definition: group_sl_compat.h:16
IsSavegameVersionBefore
static bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor=0)
Checks whether the savegame is below major.
Definition: saveload.h:1023
SL_MAX_VERSION
@ SL_MAX_VERSION
Highest possible saveload version.
Definition: saveload.h:341
SLE_VAR
#define SLE_VAR(base, variable, type)
Storage of a variable in every version of a savegame.
Definition: saveload.h:771
Pool::PoolItem<&_group_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
SLV_189
@ SLV_189
189 26450 Hierarchical vehicle subgroups
Definition: saveload.h:273
GRPSChunkHandler::Save
void Save() const override
Save the chunk.
Definition: group_sl.cpp:34
SlCompatTableHeader
std::vector< SaveLoad > SlCompatTableHeader(const SaveLoadTable &slt, const SaveLoadCompatTable &slct)
Load a table header in a savegame compatible way.
Definition: saveload.cpp:2029
SlObject
void SlObject(void *object, const SaveLoadTable &slt)
Main SaveLoad function.
Definition: saveload.cpp:1838
SlTableHeader
std::vector< SaveLoad > SlTableHeader(const SaveLoadTable &slt)
Save or Load a table header.
Definition: saveload.cpp:1891
SaveLoad
SaveLoad type struct.
Definition: saveload.h:652
Company
Definition: company_base.h:115
group_sl_compat.h
SlIterateArray
int SlIterateArray()
Iterate through the elements of an array and read the whole thing.
Definition: saveload.cpp:670
Livery::colour2
byte colour2
Second colour, for vehicles with 2CC support.
Definition: livery.h:81
Livery::colour1
byte colour1
First colour, for all vehicles.
Definition: livery.h:80