OpenTTD Source  12.0-beta2
saveload.h
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 #ifndef SAVELOAD_H
11 #define SAVELOAD_H
12 
13 #include "../fileio_type.h"
14 #include "../fios.h"
15 #include "../strings_type.h"
16 #include "../core/span_type.hpp"
17 #include <optional>
18 #include <string>
19 #include <vector>
20 
34 enum SaveLoadVersion : uint16 {
36 
55 
62 
70 
76 
82 
88 
94 
100 
106 
112 
118 
124 
130 
136 
142 
148 
154 
160 
166 
172 
178 
184 
190 
196 
202 
208 
214 
220 
226 
232 
238 
244 
250 
256 
262 
268 
274 
277  SLV_192,
281 
287 
293 
299 
305 
311 
312  /* Patchpacks for a while considered it a good idea to jump a few versions
313  * above our version for their savegames. But as time continued, this gap
314  * has been closing, up to the point we would start to reuse versions from
315  * their patchpacks. This is not a problem from our perspective: the
316  * savegame will simply fail to load because they all contain chunks we
317  * cannot digest. But, this gives for ugly errors. As we have plenty of
318  * versions anyway, we simply skip the versions we know belong to
319  * patchpacks. This way we can present the user with a clean error
320  * indicate they are loading a savegame from a patchpack.
321  * For future patchpack creators: please follow a system like JGRPP, where
322  * the version is masked with 0x8000, and the true version is stored in
323  * its own chunk with feature toggles.
324  */
327 
331 
337 
341 
343 };
344 
347  SL_OK = 0,
348  SL_ERROR = 1,
349  SL_REINIT = 2,
350 };
351 
357  std::string name;
358  char title[255];
359 
360  void SetMode(FiosType ft);
362  void SetName(const char *name);
363  void SetTitle(const char *title);
364 };
365 
373  SGT_INVALID = 0xFF,
374 };
375 
377 
378 void GenerateDefaultSaveName(char *buf, const char *last);
379 void SetSaveLoadError(StringID str);
380 const char *GetSaveLoadErrorString();
381 SaveOrLoadResult SaveOrLoad(const std::string &filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded = true);
382 void WaitTillSaved();
384 void DoExitSave();
385 
387 
388 SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
390 
391 typedef void AutolengthProc(void *arg);
392 
394 enum ChunkType {
395  CH_RIFF = 0,
396  CH_ARRAY = 1,
397  CH_SPARSE_ARRAY = 2,
398  CH_TABLE = 3,
399  CH_SPARSE_TABLE = 4,
400 
401  CH_TYPE_MASK = 0xf,
403 };
404 
406 struct ChunkHandler {
407  uint32 id;
409 
410  ChunkHandler(uint32 id, ChunkType type) : id(id), type(type) {}
411 
412  virtual ~ChunkHandler() {}
413 
418  virtual void Save() const { NOT_REACHED(); }
419 
424  virtual void Load() const = 0;
425 
432  virtual void FixPointers() const {}
433 
439  virtual void LoadCheck(size_t len = 0) const;
440 };
441 
443 using ChunkHandlerRef = std::reference_wrapper<const ChunkHandler>;
444 
447 
450 
453 
456 public:
457  std::optional<std::vector<SaveLoad>> load_description;
458 
459  virtual ~SaveLoadHandler() {}
460 
465  virtual void Save(void *object) const {}
466 
471  virtual void Load(void *object) const {}
472 
477  virtual void LoadCheck(void *object) const {}
478 
483  virtual void FixPointers(void *object) const {}
484 
488  virtual SaveLoadTable GetDescription() const = 0;
489 
493  virtual SaveLoadCompatTable GetCompatDescription() const = 0;
494 
501 };
502 
514 template <class TImpl, class TObject>
516 public:
517  SaveLoadTable GetDescription() const override { return static_cast<const TImpl *>(this)->description; }
518  SaveLoadCompatTable GetCompatDescription() const override { return static_cast<const TImpl *>(this)->compat_description; }
519 
520  virtual void Save(TObject *object) const {}
521  void Save(void *object) const override { this->Save(static_cast<TObject *>(object)); }
522 
523  virtual void Load(TObject *object) const {}
524  void Load(void *object) const override { this->Load(static_cast<TObject *>(object)); }
525 
526  virtual void LoadCheck(TObject *object) const {}
527  void LoadCheck(void *object) const override { this->LoadCheck(static_cast<TObject *>(object)); }
528 
529  virtual void FixPointers(TObject *object) const {}
530  void FixPointers(void *object) const override { this->FixPointers(static_cast<TObject *>(object)); }
531 };
532 
534 enum SLRefType {
535  REF_ORDER = 0,
538  REF_TOWN = 3,
547 };
548 
557 enum VarTypes {
558  /* 4 bits allocated a maximum of 16 types for NumberType.
559  * NOTE: the SLE_FILE_NNN values are stored in the savegame! */
561  SLE_FILE_I8 = 1,
562  SLE_FILE_U8 = 2,
563  SLE_FILE_I16 = 3,
564  SLE_FILE_U16 = 4,
565  SLE_FILE_I32 = 5,
566  SLE_FILE_U32 = 6,
567  SLE_FILE_I64 = 7,
568  SLE_FILE_U64 = 8,
570  SLE_FILE_STRING = 10,
571  SLE_FILE_STRUCT = 11,
572  /* 4 more possible file-primitives */
573 
576 
577  /* 4 bits allocated a maximum of 16 types for NumberType */
578  SLE_VAR_BL = 0 << 4,
579  SLE_VAR_I8 = 1 << 4,
580  SLE_VAR_U8 = 2 << 4,
581  SLE_VAR_I16 = 3 << 4,
582  SLE_VAR_U16 = 4 << 4,
583  SLE_VAR_I32 = 5 << 4,
584  SLE_VAR_U32 = 6 << 4,
585  SLE_VAR_I64 = 7 << 4,
586  SLE_VAR_U64 = 8 << 4,
587  SLE_VAR_NULL = 9 << 4,
588  SLE_VAR_STRB = 10 << 4,
589  SLE_VAR_STR = 12 << 4,
590  SLE_VAR_STRQ = 13 << 4,
591  SLE_VAR_NAME = 14 << 4,
592  /* 1 more possible memory-primitives */
593 
594  /* Shortcut values */
595  SLE_VAR_CHAR = SLE_VAR_I8,
596 
597  /* Default combinations of variables. As savegames change, so can variables
598  * and thus it is possible that the saved value and internal size do not
599  * match and you need to specify custom combo. The defaults are listed here */
600  SLE_BOOL = SLE_FILE_I8 | SLE_VAR_BL,
601  SLE_INT8 = SLE_FILE_I8 | SLE_VAR_I8,
602  SLE_UINT8 = SLE_FILE_U8 | SLE_VAR_U8,
603  SLE_INT16 = SLE_FILE_I16 | SLE_VAR_I16,
604  SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,
605  SLE_INT32 = SLE_FILE_I32 | SLE_VAR_I32,
606  SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,
607  SLE_INT64 = SLE_FILE_I64 | SLE_VAR_I64,
608  SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,
609  SLE_CHAR = SLE_FILE_I8 | SLE_VAR_CHAR,
610  SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U32,
611  SLE_STRINGBUF = SLE_FILE_STRING | SLE_VAR_STRB,
612  SLE_STRING = SLE_FILE_STRING | SLE_VAR_STR,
613  SLE_STRINGQUOTE = SLE_FILE_STRING | SLE_VAR_STRQ,
614  SLE_NAME = SLE_FILE_STRINGID | SLE_VAR_NAME,
615 
616  /* Shortcut values */
617  SLE_UINT = SLE_UINT32,
618  SLE_INT = SLE_INT32,
619  SLE_STRB = SLE_STRINGBUF,
620  SLE_STR = SLE_STRING,
621  SLE_STRQ = SLE_STRINGQUOTE,
622 
623  /* 8 bits allocated for a maximum of 8 flags
624  * Flags directing saving/loading of a variable */
625  SLF_ALLOW_CONTROL = 1 << 8,
626  SLF_ALLOW_NEWLINE = 1 << 9,
627 };
628 
629 typedef uint32 VarType;
630 
632 enum SaveLoadType : byte {
633  SL_VAR = 0,
634  SL_REF = 1,
635  SL_STRUCT = 2,
636 
637  SL_STR = 3,
638  SL_STDSTR = 4,
639 
640  SL_ARR = 5,
641  SL_DEQUE = 6,
642  SL_VECTOR = 7,
645 
646  SL_SAVEBYTE = 10,
647  SL_NULL = 11,
648 };
649 
650 typedef void *SaveLoadAddrProc(void *base, size_t extra);
651 
653 struct SaveLoad {
654  std::string name;
656  VarType conv;
657  uint16 length;
660  size_t size;
661  SaveLoadAddrProc *address_proc;
662  size_t extra_data;
663  std::shared_ptr<SaveLoadHandler> handler;
664 };
665 
675  std::string name;
676  uint16 length;
679 };
680 
692 #define SLE_GENERAL(cmd, base, variable, type, length, from, to, extra) SaveLoad {#variable, cmd, type, length, from, to, cpp_sizeof(base, variable), [] (void *b, size_t) -> void * { assert(b != nullptr); return const_cast<void *>(static_cast<const void *>(std::addressof(static_cast<base *>(b)->variable))); }, extra, nullptr}
693 
702 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to, 0)
703 
712 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to, 0)
713 
723 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to, 0)
724 
734 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to, 0)
735 
744 #define SLE_CONDSSTR(base, variable, type, from, to) SLE_GENERAL(SL_STDSTR, base, variable, type, 0, from, to, 0)
745 
754 #define SLE_CONDREFLIST(base, variable, type, from, to) SLE_GENERAL(SL_REFLIST, base, variable, type, 0, from, to, 0)
755 
764 #define SLE_CONDDEQUE(base, variable, type, from, to) SLE_GENERAL(SL_DEQUE, base, variable, type, 0, from, to, 0)
765 
772 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
773 
780 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
781 
789 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, SL_MIN_VERSION, SL_MAX_VERSION)
790 
798 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, SL_MIN_VERSION, SL_MAX_VERSION)
799 
806 #define SLE_SSTR(base, variable, type) SLE_CONDSSTR(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
807 
814 #define SLE_REFLIST(base, variable, type) SLE_CONDREFLIST(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
815 
826 #define SLE_SAVEBYTE(base, variable) SLE_GENERAL(SL_SAVEBYTE, base, variable, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, 0)
827 
839 #define SLEG_GENERAL(name, cmd, variable, type, length, from, to, extra) SaveLoad {name, cmd, type, length, from, to, sizeof(variable), [] (void *, size_t) -> void * { return static_cast<void *>(std::addressof(variable)); }, extra, nullptr}
840 
849 #define SLEG_CONDVAR(name, variable, type, from, to) SLEG_GENERAL(name, SL_VAR, variable, type, 0, from, to, 0)
850 
859 #define SLEG_CONDREF(name, variable, type, from, to) SLEG_GENERAL(name, SL_REF, variable, type, 0, from, to, 0)
860 
870 #define SLEG_CONDARR(name, variable, type, length, from, to) SLEG_GENERAL(name, SL_ARR, variable, type, length, from, to, 0)
871 
881 #define SLEG_CONDSTR(name, variable, type, length, from, to) SLEG_GENERAL(name, SL_STR, variable, type, length, from, to, 0)
882 
891 #define SLEG_CONDSSTR(name, variable, type, from, to) SLEG_GENERAL(name, SL_STDSTR, variable, type, 0, from, to, 0)
892 
900 #define SLEG_CONDSTRUCT(name, handler, from, to) SaveLoad {name, SL_STRUCT, 0, 0, from, to, 0, nullptr, 0, std::make_shared<handler>()}
901 
910 #define SLEG_CONDREFLIST(name, variable, type, from, to) SLEG_GENERAL(name, SL_REFLIST, variable, type, 0, from, to, 0)
911 
920 #define SLEG_CONDVECTOR(name, variable, type, from, to) SLEG_GENERAL(name, SL_VECTOR, variable, type, 0, from, to, 0)
921 
929 #define SLEG_CONDSTRUCTLIST(name, handler, from, to) SaveLoad {name, SL_STRUCTLIST, 0, 0, from, to, 0, nullptr, 0, std::make_shared<handler>()}
930 
937 #define SLEG_VAR(name, variable, type) SLEG_CONDVAR(name, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
938 
945 #define SLEG_REF(name, variable, type) SLEG_CONDREF(name, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
946 
953 #define SLEG_ARR(name, variable, type) SLEG_CONDARR(name, variable, type, lengthof(variable), SL_MIN_VERSION, SL_MAX_VERSION)
954 
961 #define SLEG_STR(name, variable, type) SLEG_CONDSTR(name, variable, type, sizeof(variable), SL_MIN_VERSION, SL_MAX_VERSION)
962 
969 #define SLEG_SSTR(name, variable, type) SLEG_CONDSSTR(name, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
970 
976 #define SLEG_STRUCT(name, handler) SLEG_CONDSTRUCT(name, handler, SL_MIN_VERSION, SL_MAX_VERSION)
977 
984 #define SLEG_REFLIST(name, variable, type) SLEG_CONDREFLIST(name, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
985 
992 #define SLEG_VECTOR(name, variable, type) SLEG_CONDVECTOR(name, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
993 
999 #define SLEG_STRUCTLIST(name, handler) SLEG_CONDSTRUCTLIST(name, handler, SL_MIN_VERSION, SL_MAX_VERSION)
1000 
1005 #define SLC_VAR(name) {name, 0, SL_MIN_VERSION, SL_MAX_VERSION}
1006 
1013 #define SLC_NULL(length, from, to) {{}, length, from, to}
1014 
1016 #define SLC_END() {{}, 0, SL_MIN_VERSION, SL_MIN_VERSION}
1017 
1024 static inline bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor = 0)
1025 {
1027  extern byte _sl_minor_version;
1028  return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
1029 }
1030 
1039 {
1041  return _sl_version <= major;
1042 }
1043 
1051 static inline bool SlIsObjectCurrentlyValid(SaveLoadVersion version_from, SaveLoadVersion version_to)
1052 {
1053  extern const SaveLoadVersion SAVEGAME_VERSION;
1054  return version_from <= SAVEGAME_VERSION && SAVEGAME_VERSION < version_to;
1055 }
1056 
1063 static inline VarType GetVarMemType(VarType type)
1064 {
1065  return type & 0xF0; // GB(type, 4, 4) << 4;
1066 }
1067 
1074 static inline VarType GetVarFileType(VarType type)
1075 {
1076  return type & 0xF; // GB(type, 0, 4);
1077 }
1078 
1084 static inline bool IsNumericType(VarType conv)
1085 {
1086  return GetVarMemType(conv) <= SLE_VAR_U64;
1087 }
1088 
1094 static inline void *GetVariableAddress(const void *object, const SaveLoad &sld)
1095 {
1096  /* Entry is a null-variable, mostly used to read old savegames etc. */
1097  if (GetVarMemType(sld.conv) == SLE_VAR_NULL) {
1098  assert(sld.address_proc == nullptr);
1099  return nullptr;
1100  }
1101 
1102  /* Everything else should be a non-null pointer. */
1103  assert(sld.address_proc != nullptr);
1104  return sld.address_proc(const_cast<void *>(object), sld.extra_data);
1105 }
1106 
1107 int64 ReadValue(const void *ptr, VarType conv);
1108 void WriteValue(void *ptr, VarType conv, int64 val);
1109 
1110 void SlSetArrayIndex(uint index);
1111 int SlIterateArray();
1112 
1113 void SlSetStructListLength(size_t length);
1114 size_t SlGetStructListLength(size_t limit);
1115 
1116 void SlAutolength(AutolengthProc *proc, void *arg);
1117 size_t SlGetFieldLength();
1118 void SlSetLength(size_t length);
1119 size_t SlCalcObjMemberLength(const void *object, const SaveLoad &sld);
1120 size_t SlCalcObjLength(const void *object, const SaveLoadTable &slt);
1121 
1122 byte SlReadByte();
1123 void SlWriteByte(byte b);
1124 
1125 void SlGlobList(const SaveLoadTable &slt);
1126 void SlCopy(void *object, size_t length, VarType conv);
1127 std::vector<SaveLoad> SlTableHeader(const SaveLoadTable &slt);
1128 std::vector<SaveLoad> SlCompatTableHeader(const SaveLoadTable &slt, const SaveLoadCompatTable &slct);
1129 void SlObject(void *object, const SaveLoadTable &slt);
1130 void NORETURN SlError(StringID string, const char *extra_msg = nullptr);
1131 void NORETURN SlErrorCorrupt(const char *msg);
1132 void NORETURN SlErrorCorruptFmt(const char *format, ...) WARN_FORMAT(1, 2);
1133 
1135 
1141 static inline void SlSkipBytes(size_t length)
1142 {
1143  for (; length != 0; length--) SlReadByte();
1144 }
1145 
1146 extern std::string _savegame_format;
1147 extern bool _do_autosave;
1148 
1149 #endif /* SAVELOAD_H */
FileToSaveLoad::title
char title[255]
Internal name of the game.
Definition: saveload.h:358
SL_NULL
@ SL_NULL
Save null-bytes and load to nowhere.
Definition: saveload.h:647
SLV_131
@ SLV_131
131 18481
Definition: saveload.h:204
SGT_INVALID
@ SGT_INVALID
broken savegame (used internally)
Definition: saveload.h:373
SLV_187
@ SLV_187
187 25899 Linkgraph - restricted flows
Definition: saveload.h:271
SLV_65
@ SLV_65
65 10210
Definition: saveload.h:125
SaveLoad::version_to
SaveLoadVersion version_to
Save/load the variable before this savegame version.
Definition: saveload.h:659
SLV_186
@ SLV_186
186 25833 Objects storage
Definition: saveload.h:270
SLV_69
@ SLV_69
69 10319
Definition: saveload.h:129
REF_ORDER
@ REF_ORDER
Load/save a reference to an order.
Definition: saveload.h:535
SLV_144
@ SLV_144
144 20334
Definition: saveload.h:219
SaveLoadType
SaveLoadType
Type of data saved.
Definition: saveload.h:632
SLV_169
@ SLV_169
169 23816
Definition: saveload.h:249
DefaultSaveLoadHandler
Default handler for saving/loading an object to/from disk.
Definition: saveload.h:515
SLV_RIFF_TO_ARRAY
@ SLV_RIFF_TO_ARRAY
294 PR#9375 Changed many CH_RIFF chunks to CH_ARRAY chunks.
Definition: saveload.h:336
SLV_43
@ SLV_43
43 7642
Definition: saveload.h:98
SLV_114
@ SLV_114
114 15601
Definition: saveload.h:183
SLV_LINKGRAPH_TRAVEL_TIME
@ SLV_LINKGRAPH_TRAVEL_TIME
297 PR#9457 Store travel time in the linkgraph.
Definition: saveload.h:340
SGT_OTTD
@ SGT_OTTD
OTTD savegame.
Definition: saveload.h:371
SLV_62
@ SLV_62
62 9905
Definition: saveload.h:121
SLE_VAR_STR
@ SLE_VAR_STR
string pointer
Definition: saveload.h:589
SLV_TREES_WATER_CLASS
@ SLV_TREES_WATER_CLASS
213 PR#7405 WaterClass update for tree tiles.
Definition: saveload.h:303
GetVarFileType
static VarType GetVarFileType(VarType type)
Get the FileType of a setting.
Definition: saveload.h:1074
SLV_162
@ SLV_162
162 22713
Definition: saveload.h:241
SlErrorCorrupt
void NORETURN SlErrorCorrupt(const char *msg)
Error handler for corrupt savegames.
Definition: saveload.cpp:364
SLV_ROAD_TYPES
@ SLV_ROAD_TYPES
214 PR#6811 NewGRF road types.
Definition: saveload.h:304
SLV_133
@ SLV_133
133 18674
Definition: saveload.h:206
SL_MIN_VERSION
@ SL_MIN_VERSION
First savegame version.
Definition: saveload.h:35
REF_TOWN
@ REF_TOWN
Load/save a reference to a town.
Definition: saveload.h:538
SLV_85
@ SLV_85
85 11874
Definition: saveload.h:149
SLV_106
@ SLV_106
106 14919
Definition: saveload.h:174
SLV_40
@ SLV_40
40 7326
Definition: saveload.h:95
SL_STR
@ SL_STR
Save/load a string.
Definition: saveload.h:637
ProcessAsyncSaveFinish
void ProcessAsyncSaveFinish()
Handle async save finishes.
Definition: saveload.cpp:408
REF_ROADSTOPS
@ REF_ROADSTOPS
Load/save a reference to a bus/truck stop.
Definition: saveload.h:540
FileToSaveLoad::SetTitle
void SetTitle(const char *title)
Set the title of the file.
Definition: saveload.cpp:3431
SLV_32
@ SLV_32
32 6001
Definition: saveload.h:85
SLE_FILE_END
@ SLE_FILE_END
Used to mark end-of-header in tables.
Definition: saveload.h:560
SLV_155
@ SLV_155
155 21453
Definition: saveload.h:233
SLV_178
@ SLV_178
178 24789
Definition: saveload.h:260
SLV_124
@ SLV_124
124 16993
Definition: saveload.h:195
ChunkHandlerRef
std::reference_wrapper< const ChunkHandler > ChunkHandlerRef
A reference to ChunkHandler.
Definition: saveload.h:443
SLV_112
@ SLV_112
112 15290
Definition: saveload.h:181
SLV_GROUP_REPLACE_WAGON_REMOVAL
@ SLV_GROUP_REPLACE_WAGON_REMOVAL
291 PR#7441 Per-group wagon removal flag.
Definition: saveload.h:333
SLV_49
@ SLV_49
49 8969
Definition: saveload.h:105
SLV_146
@ SLV_146
146 20446
Definition: saveload.h:222
SLV_198
@ SLV_198
198 PR#6763 Switch town growth rate and counter to actual game ticks
Definition: saveload.h:285
SaveLoadOperation
SaveLoadOperation
Operation performed on the file.
Definition: fileio_type.h:47
SLV_117
@ SLV_117
117 16037
Definition: saveload.h:187
FileToSaveLoad::name
std::string name
Name of the file.
Definition: saveload.h:357
SLV_29
@ SLV_29
29 5070
Definition: saveload.h:81
SLV_79
@ SLV_79
79 11188
Definition: saveload.h:141
_do_autosave
bool _do_autosave
are we doing an autosave at the moment?
Definition: saveload.cpp:69
SaveLoad::size
size_t size
The sizeof size.
Definition: saveload.h:660
SLV_96
@ SLV_96
96 13226
Definition: saveload.h:162
SLV_166
@ SLV_166
166 23415
Definition: saveload.h:246
SLV_56
@ SLV_56
56 9667
Definition: saveload.h:114
SLF_ALLOW_NEWLINE
@ SLF_ALLOW_NEWLINE
Allow new lines in the strings.
Definition: saveload.h:626
SLV_84
@ SLV_84
84 11822
Definition: saveload.h:147
SLV_93
@ SLV_93
93 12648
Definition: saveload.h:158
SLV_52
@ SLV_52
52 9066
Definition: saveload.h:109
SLE_STR
#define SLE_STR(base, variable, type, length)
Storage of a string in every savegame version.
Definition: saveload.h:798
SLV_157
@ SLV_157
157 21862
Definition: saveload.h:235
SLV_119
@ SLV_119
119 16242
Definition: saveload.h:189
SLV_SHIPS_STOP_IN_LOCKS
@ SLV_SHIPS_STOP_IN_LOCKS
206 PR#7150 Ship/lock movement changes.
Definition: saveload.h:295
SLV_FIX_CARGO_MONITOR
@ SLV_FIX_CARGO_MONITOR
207 PR#7175 v1.9 Cargo monitor data packing fix to support 64 cargotypes.
Definition: saveload.h:296
SGT_TTDP1
@ SGT_TTDP1
TTDP savegame ( -//- ) (data at NW border)
Definition: saveload.h:369
SaveLoadHandler::FixPointers
virtual void FixPointers(void *object) const
A post-load callback to fix SL_REF integers into pointers.
Definition: saveload.h:483
SLV_66
@ SLV_66
66 10211
Definition: saveload.h:126
FileToSaveLoad
Deals with the type of the savegame, independent of extension.
Definition: saveload.h:353
FileToSaveLoad::SetName
void SetName(const char *name)
Set the name of the file.
Definition: saveload.cpp:3422
SLV_87
@ SLV_87
87 12129
Definition: saveload.h:151
SLV_20
@ SLV_20
20 3403
Definition: saveload.h:71
SLE_VAR_NULL
@ SLE_VAR_NULL
useful to write zeros in savegame.
Definition: saveload.h:587
SaveOrLoad
SaveOrLoadResult SaveOrLoad(const std::string &filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded=true)
Main Save or Load function where the high-level saveload functions are handled.
Definition: saveload.cpp:3240
SlTableHeader
std::vector< SaveLoad > SlTableHeader(const SaveLoadTable &slt)
Save or Load a table header.
Definition: saveload.cpp:1891
SLV_88
@ SLV_88
88 12134
Definition: saveload.h:152
SaveLoadHandler::GetLoadDescription
SaveLoadTable GetLoadDescription() const
Get the description for how to load the chunk.
Definition: saveload.cpp:3436
SLV_78
@ SLV_78
78 11176
Definition: saveload.h:140
ChunkHandler::type
ChunkType type
Type of the chunk.
Definition: saveload.h:408
SaveLoad::length
uint16 length
(Conditional) length of the variable (eg. arrays) (max array size is 65536 elements).
Definition: saveload.h:657
SLV_138
@ SLV_138
138 18942 1.0.x
Definition: saveload.h:212
SLV_35
@ SLV_35
35 6602
Definition: saveload.h:89
SLV_22
@ SLV_22
22 3726
Definition: saveload.h:73
SLV_104
@ SLV_104
104 14735
Definition: saveload.h:171
DefaultSaveLoadHandler::FixPointers
void FixPointers(void *object) const override
A post-load callback to fix SL_REF integers into pointers.
Definition: saveload.h:530
SLV_SERVE_NEUTRAL_INDUSTRIES
@ SLV_SERVE_NEUTRAL_INDUSTRIES
210 PR#7234 Company stations can serve industries with attached neutral stations.
Definition: saveload.h:300
SLV_15
@ SLV_15
15.0 2499
Definition: saveload.h:63
SLV_REMOVE_OPF
@ SLV_REMOVE_OPF
212 PR#7245 Remove OPF.
Definition: saveload.h:302
SlGlobList
void SlGlobList(const SaveLoadTable &slt)
Save or Load (a list of) global variables.
Definition: saveload.cpp:2083
SAVEGAME_VERSION
const SaveLoadVersion SAVEGAME_VERSION
current savegame version
IsSavegameVersionBeforeOrAt
static bool IsSavegameVersionBeforeOrAt(SaveLoadVersion major)
Checks whether the savegame is below or at major.
Definition: saveload.h:1038
SLV_113
@ SLV_113
113 15340
Definition: saveload.h:182
ChunkHandler
Handlers and description of chunk.
Definition: saveload.h:406
SaveLoad::conv
VarType conv
Type of the variable to be saved; this field combines both FileVarType and MemVarType.
Definition: saveload.h:656
SLV_102
@ SLV_102
102 14332
Definition: saveload.h:169
SLV_181
@ SLV_181
181 25012
Definition: saveload.h:264
SlSetStructListLength
void SlSetStructListLength(size_t length)
Set the length of this list.
Definition: saveload.cpp:1809
SLV_175
@ SLV_175
175 24136
Definition: saveload.h:257
SLV_GROUP_LIVERIES
@ SLV_GROUP_LIVERIES
205 PR#7108 Livery storage change and group liveries.
Definition: saveload.h:294
SLV_83
@ SLV_83
83 11589
Definition: saveload.h:146
SLV_76
@ SLV_76
76 11139
Definition: saveload.h:138
SLV_53
@ SLV_53
53 9316
Definition: saveload.h:110
SaveLoadHandler
Handler for saving/loading an object to/from disk.
Definition: saveload.h:455
SLV_163
@ SLV_163
163 22767
Definition: saveload.h:242
SLV_179
@ SLV_179
179 24810
Definition: saveload.h:261
SLV_100
@ SLV_100
100 13952
Definition: saveload.h:167
SLV_141
@ SLV_141
141 19799
Definition: saveload.h:216
SLV_172
@ SLV_172
172 23947
Definition: saveload.h:253
SlGetStructListLength
size_t SlGetStructListLength(size_t limit)
Get the length of this list; if it exceeds the limit, error out.
Definition: saveload.cpp:1825
SLV_EXTEND_PERSISTENT_STORAGE
@ SLV_EXTEND_PERSISTENT_STORAGE
201 PR#6885 Extend NewGRF persistent storages.
Definition: saveload.h:289
SaveLoadCompat::name
std::string name
Name of the field.
Definition: saveload.h:675
SLE_FILE_TYPE_MASK
@ SLE_FILE_TYPE_MASK
Mask to get the file-type (and not any flags).
Definition: saveload.h:574
SLV_14
@ SLV_14
14.0 2441
Definition: saveload.h:61
SlIterateArray
int SlIterateArray()
Iterate through the elements of an array and read the whole thing.
Definition: saveload.cpp:670
SLV_61
@ SLV_61
61 9892
Definition: saveload.h:120
SLV_41
@ SLV_41
41 7348 0.5.x
Definition: saveload.h:96
SLV_10
@ SLV_10
10.0 2030
Definition: saveload.h:56
GenerateDefaultSaveName
void GenerateDefaultSaveName(char *buf, const char *last)
Fill the buffer with the default name for a savegame or screenshot.
Definition: saveload.cpp:3360
GetSaveLoadErrorString
const char * GetSaveLoadErrorString()
Get the string representation of the error message.
Definition: saveload.cpp:2950
SLV_118
@ SLV_118
118 16129
Definition: saveload.h:188
REF_STATION
@ REF_STATION
Load/save a reference to a station.
Definition: saveload.h:537
SLV_98
@ SLV_98
98 13375
Definition: saveload.h:164
SlWriteByte
void SlWriteByte(byte b)
Wrapper for writing a byte to the dumper.
Definition: saveload.cpp:433
SLE_VAR_STRB
@ SLE_VAR_STRB
string (with pre-allocated buffer)
Definition: saveload.h:588
IsNumericType
static bool IsNumericType(VarType conv)
Check if the given saveload type is a numeric type.
Definition: saveload.h:1084
SLV_EXTEND_INDUSTRY_CARGO_SLOTS
@ SLV_EXTEND_INDUSTRY_CARGO_SLOTS
202 PR#6867 Increase industry cargo slots to 16 in, 16 out
Definition: saveload.h:290
SLV_160
@ SLV_160
160 21974 1.1.x
Definition: saveload.h:239
AbstractFileType
AbstractFileType
The different abstract types of files that the system knows about.
Definition: fileio_type.h:16
FileToSaveLoad::abstract_ftype
AbstractFileType abstract_ftype
Abstract type of file (scenario, heightmap, etc).
Definition: saveload.h:356
SLV_135
@ SLV_135
135 18719
Definition: saveload.h:209
SlSetLength
void SlSetLength(size_t length)
Sets the length of either a RIFF object or the number of items in an array.
Definition: saveload.cpp:723
SLV_154
@ SLV_154
154 21426
Definition: saveload.h:231
SLV_5
@ SLV_5
5.0 1429 5.1 1440 5.2 1525 0.3.6
Definition: saveload.h:47
SL_SAVEBYTE
@ SL_SAVEBYTE
Save (but not load) a byte.
Definition: saveload.h:646
SLV_174
@ SLV_174
174 23973 1.2.x
Definition: saveload.h:255
SLV_161
@ SLV_161
161 22567
Definition: saveload.h:240
SLF_ALLOW_CONTROL
@ SLF_ALLOW_CONTROL
Allow control codes in the strings.
Definition: saveload.h:625
SLE_FILE_HAS_LENGTH_FIELD
@ SLE_FILE_HAS_LENGTH_FIELD
Bit stored in savegame to indicate field has a length field for each entry.
Definition: saveload.h:575
SLV_156
@ SLV_156
156 21728
Definition: saveload.h:234
SLV_108
@ SLV_108
108 15045
Definition: saveload.h:176
SLV_111
@ SLV_111
111 15190
Definition: saveload.h:180
SLV_123
@ SLV_123
123 16909
Definition: saveload.h:194
SavegameType
SavegameType
Types of save games.
Definition: saveload.h:367
SLV_150
@ SLV_150
150 20857
Definition: saveload.h:227
SLV_115
@ SLV_115
115 15695
Definition: saveload.h:185
CH_TYPE_MASK
@ CH_TYPE_MASK
All ChunkType values have to be within this mask.
Definition: saveload.h:401
SLV_55
@ SLV_55
55 9638
Definition: saveload.h:113
SLV_164
@ SLV_164
164 23290
Definition: saveload.h:243
span
A trimmed down version of what std::span will be in C++20.
Definition: span_type.hpp:60
ChunkHandler::Save
virtual void Save() const
Save the chunk.
Definition: saveload.h:418
CH_READONLY
@ CH_READONLY
Chunk is never saved.
Definition: saveload.h:402
SGT_TTO
@ SGT_TTO
TTO savegame.
Definition: saveload.h:372
SLV_31
@ SLV_31
31 5999
Definition: saveload.h:84
SLV_TABLE_CHUNKS
@ SLV_TABLE_CHUNKS
295 PR#9322 Introduction of CH_TABLE and CH_SPARSE_TABLE.
Definition: saveload.h:338
SetSaveLoadError
void SetSaveLoadError(StringID str)
Set the error message from outside of the actual loading/saving of the game (AfterLoadGame and friend...
Definition: saveload.cpp:2944
SLV_MULTITILE_DOCKS
@ SLV_MULTITILE_DOCKS
216 PR#7380 Multiple docks per station.
Definition: saveload.h:307
ChunkHandler::id
uint32 id
Unique ID (4 letters).
Definition: saveload.h:407
SL_VAR
@ SL_VAR
Save/load a variable.
Definition: saveload.h:633
SLV_11
@ SLV_11
11.0 2033 11.1 2041
Definition: saveload.h:57
SLV_REMOVE_TOWN_CARGO_CACHE
@ SLV_REMOVE_TOWN_CARGO_CACHE
219 PR#8258 Remove town cargo acceptance and production caches.
Definition: saveload.h:310
SLV_67
@ SLV_67
67 10236
Definition: saveload.h:127
SLV_SCRIPT_MEMLIMIT
@ SLV_SCRIPT_MEMLIMIT
215 PR#7516 Limit on AI/GS memory consumption.
Definition: saveload.h:306
SLV_176
@ SLV_176
176 24446
Definition: saveload.h:258
SaveLoad::extra_data
size_t extra_data
Extra data for the callback proc.
Definition: saveload.h:662
SLV_126
@ SLV_126
126 17433
Definition: saveload.h:198
SLV_132
@ SLV_132
132 18522
Definition: saveload.h:205
SLV_86
@ SLV_86
86 12042
Definition: saveload.h:150
SL_REINIT
@ SL_REINIT
error that was caught in the middle of updating game state, need to clear it. (can only happen during...
Definition: saveload.h:349
SaveLoad::cmd
SaveLoadType cmd
The action to take with the saved/loaded type, All types need different action.
Definition: saveload.h:655
SLV_END_PATCHPACKS
@ SLV_END_PATCHPACKS
286 Last known patchpack to use a version just above ours.
Definition: saveload.h:326
SLV_27
@ SLV_27
27 4757
Definition: saveload.h:79
SLV_158
@ SLV_158
158 21933
Definition: saveload.h:236
SLV_130
@ SLV_130
130 18404
Definition: saveload.h:203
SLV_CUSTOM_SUBSIDY_DURATION
@ SLV_CUSTOM_SUBSIDY_DURATION
292 PR#9081 Configurable subsidy duration.
Definition: saveload.h:334
SLRefType
SLRefType
Type of reference (SLE_REF, SLE_CONDREF).
Definition: saveload.h:534
SLV_73
@ SLV_73
73 10903
Definition: saveload.h:134
SLV_46
@ SLV_46
46 8705
Definition: saveload.h:102
SLV_94
@ SLV_94
94 12816
Definition: saveload.h:159
SLV_74
@ SLV_74
74 11030
Definition: saveload.h:135
SaveLoadCompat::length
uint16 length
Length of the NULL field.
Definition: saveload.h:676
SLV_109
@ SLV_109
109 15075
Definition: saveload.h:177
SlAutolength
void SlAutolength(AutolengthProc *proc, void *arg)
Do something of which I have no idea what it is :P.
Definition: saveload.cpp:2093
SLV_54
@ SLV_54
54 9613
Definition: saveload.h:111
SLV_ROADVEH_PATH_CACHE
@ SLV_ROADVEH_PATH_CACHE
211 PR#7261 Add path cache for road vehicles.
Definition: saveload.h:301
SLV_TOWN_CARGOGEN
@ SLV_TOWN_CARGOGEN
208 PR#6965 New algorithms for town building cargo generation.
Definition: saveload.h:297
SLV_128
@ SLV_128
128 18281
Definition: saveload.h:200
SLV_MAPGEN_SETTINGS_REVAMP
@ SLV_MAPGEN_SETTINGS_REVAMP
290 PR#8891 v1.11 Revamp of some mapgen settings (snow coverage, desert coverage, heightmap height,...
Definition: saveload.h:332
SLV_EXTEND_CARGOTYPES
@ SLV_EXTEND_CARGOTYPES
199 PR#6802 Extend cargotypes to 64
Definition: saveload.h:286
SL_ARR
@ SL_ARR
Save/load a fixed-size array of SL_VAR elements.
Definition: saveload.h:640
SLE_FILE_STRINGID
@ SLE_FILE_STRINGID
StringID offset into strings-array.
Definition: saveload.h:569
REF_STORAGE
@ REF_STORAGE
Load/save a reference to a persistent storage.
Definition: saveload.h:544
SLV_168
@ SLV_168
168 23637
Definition: saveload.h:248
SaveLoadVersion
SaveLoadVersion
SaveLoad versions Previous savegame versions, the trunk revision where they were introduced and the r...
Definition: saveload.h:34
SLV_82
@ SLV_82
82 11410
Definition: saveload.h:145
SLV_183
@ SLV_183
183 25363 Cargodist
Definition: saveload.h:266
SLV_120
@ SLV_120
120 16439
Definition: saveload.h:191
IsSavegameVersionBefore
static bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor=0)
Checks whether the savegame is below major.
Definition: saveload.h:1024
SLV_45
@ SLV_45
45 8501
Definition: saveload.h:101
SLV_90
@ SLV_90
90 12293
Definition: saveload.h:155
SaveLoadHandler::Save
virtual void Save(void *object) const
Save the object to disk.
Definition: saveload.h:465
REF_ENGINE_RENEWS
@ REF_ENGINE_RENEWS
Load/save a reference to an engine renewal (autoreplace).
Definition: saveload.h:541
SLV_116
@ SLV_116
116 15893 0.7.x
Definition: saveload.h:186
SLV_125
@ SLV_125
125 17113
Definition: saveload.h:197
SLV_7
@ SLV_7
7.0 1770
Definition: saveload.h:52
REF_VEHICLE
@ REF_VEHICLE
Load/save a reference to a vehicle.
Definition: saveload.h:536
SL_REF
@ SL_REF
Save/load a reference.
Definition: saveload.h:634
REF_CARGO_PACKET
@ REF_CARGO_PACKET
Load/save a reference to a cargo packet.
Definition: saveload.h:542
SL_STRUCT
@ SL_STRUCT
Save/load a struct.
Definition: saveload.h:635
SLV_23
@ SLV_23
23 3915
Definition: saveload.h:74
SLV_25
@ SLV_25
25 4259
Definition: saveload.h:77
_file_to_saveload
FileToSaveLoad _file_to_saveload
File to save or load in the openttd loop.
Definition: saveload.cpp:63
DefaultSaveLoadHandler::Save
void Save(void *object) const override
Save the object to disk.
Definition: saveload.h:521
SLV_182
@ SLV_182
182 25115 FS#5492, r25259, r25296 Goal status
Definition: saveload.h:265
REF_VEHICLE_OLD
@ REF_VEHICLE_OLD
Load/save an old-style reference to a vehicle (for pre-4.4 savegames).
Definition: saveload.h:539
SLV_50
@ SLV_50
50 8973
Definition: saveload.h:107
SLV_17
@ SLV_17
17.0 3212 17.1 3218
Definition: saveload.h:66
SLV_SHIP_CURVE_PENALTY
@ SLV_SHIP_CURVE_PENALTY
209 PR#7289 Configurable ship curve penalties.
Definition: saveload.h:298
SLV_145
@ SLV_145
145 20376
Definition: saveload.h:221
SLV_INDUSTRY_TEXT
@ SLV_INDUSTRY_TEXT
289 PR#8576 v1.11.0-RC1 Additional GS text for industries.
Definition: saveload.h:330
ChunkHandler::Load
virtual void Load() const =0
Load the chunk.
_savegame_format
std::string _savegame_format
how to compress savegames
Definition: saveload.cpp:68
SLV_170
@ SLV_170
170 23826
Definition: saveload.h:251
SLV_42
@ SLV_42
42 7573
Definition: saveload.h:97
DoExitSave
void DoExitSave()
Do a save when exiting the game (_settings_client.gui.autosave_on_exit)
Definition: saveload.cpp:3350
SLV_136
@ SLV_136
136 18764
Definition: saveload.h:210
SLV_28
@ SLV_28
28 4987
Definition: saveload.h:80
SLV_107
@ SLV_107
107 15027
Definition: saveload.h:175
ChunkHandler::FixPointers
virtual void FixPointers() const
Fix the pointers.
Definition: saveload.h:432
SLV_64
@ SLV_64
64 10006
Definition: saveload.h:123
SLV_2
@ SLV_2
2.0 0.3.0 2.1 0.3.1, 0.3.2
Definition: saveload.h:38
SaveLoad::handler
std::shared_ptr< SaveLoadHandler > handler
Custom handler for Save/Load procs.
Definition: saveload.h:663
SlIsObjectCurrentlyValid
static bool SlIsObjectCurrentlyValid(SaveLoadVersion version_from, SaveLoadVersion version_to)
Checks if some version from/to combination falls within the range of the active savegame version.
Definition: saveload.h:1051
SLV_142
@ SLV_142
142 20003
Definition: saveload.h:217
SLV_59
@ SLV_59
59 9779
Definition: saveload.h:117
SLV_SCRIPT_INT64
@ SLV_SCRIPT_INT64
296 PR#9415 SQInteger is 64bit but was saved as 32bit.
Definition: saveload.h:339
SLV_12
@ SLV_12
12.1 2046
Definition: saveload.h:59
SLV_139
@ SLV_139
139 19346
Definition: saveload.h:213
SL_VECTOR
@ SL_VECTOR
Save/load a vector of SL_VAR elements.
Definition: saveload.h:642
SL_MAX_VERSION
@ SL_MAX_VERSION
Highest possible saveload version.
Definition: saveload.h:342
SaveLoadCompat::version_to
SaveLoadVersion version_to
Save/load the variable before this savegame version.
Definition: saveload.h:678
REF_LINK_GRAPH_JOB
@ REF_LINK_GRAPH_JOB
Load/save a reference to a link graph job.
Definition: saveload.h:546
SLV_8
@ SLV_8
8.0 1786
Definition: saveload.h:53
SaveLoadHandler::GetDescription
virtual SaveLoadTable GetDescription() const =0
Get the description of the fields in the savegame.
SGT_TTD
@ SGT_TTD
TTD savegame (can be detected incorrectly)
Definition: saveload.h:368
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SlErrorCorruptFmt
void NORETURN SlErrorCorruptFmt(const char *format,...)
Issue an SlErrorCorrupt with a format string.
Definition: saveload.cpp:376
SLV_33
@ SLV_33
33 6440
Definition: saveload.h:86
SLV_16
@ SLV_16
16.0 2817 16.1 3155
Definition: saveload.h:64
SLV_30
@ SLV_30
30 5946
Definition: saveload.h:83
SaveLoadCompat
SaveLoad information for backwards compatibility.
Definition: saveload.h:674
DoAutoOrNetsave
void DoAutoOrNetsave(FiosNumberedSaveName &counter)
Create an autosave or netsave.
Definition: saveload.cpp:3331
DefaultSaveLoadHandler::LoadCheck
void LoadCheck(void *object) const override
Similar to load, but used only to validate savegames.
Definition: saveload.h:527
FiosNumberedSaveName
A savegame name automatically numbered.
Definition: fios.h:131
REF_ORDERLIST
@ REF_ORDERLIST
Load/save a reference to an orderlist.
Definition: saveload.h:543
SLV_127
@ SLV_127
127 17439
Definition: saveload.h:199
DetailedFileType
DetailedFileType
Kinds of files in each AbstractFileType.
Definition: fileio_type.h:28
SLV_193
@ SLV_193
193 26802
Definition: saveload.h:279
SLV_189
@ SLV_189
189 26450 Hierarchical vehicle subgroups
Definition: saveload.h:273
SLV_47
@ SLV_47
47 8735
Definition: saveload.h:103
SLV_VEH_MOTION_COUNTER
@ SLV_VEH_MOTION_COUNTER
288 PR#8591 Desync safe motion counter
Definition: saveload.h:329
SLV_GS_INDUSTRY_CONTROL
@ SLV_GS_INDUSTRY_CONTROL
287 PR#7912 and PR#8115 GS industry control.
Definition: saveload.h:328
SLV_6
@ SLV_6
6.0 1721 6.1 1768
Definition: saveload.h:50
SL_REFLIST
@ SL_REFLIST
Save/load a list of SL_REF elements.
Definition: saveload.h:643
VarTypes
VarTypes
VarTypes is the general bitmasked magic type that tells us certain characteristics about the variable...
Definition: saveload.h:557
SaveFilter
Interface for filtering a savegame till it is written.
Definition: saveload_filter.h:60
SLV_36
@ SLV_36
36 6624
Definition: saveload.h:90
GetVarMemType
static VarType GetVarMemType(VarType type)
Get the NumberType of a setting.
Definition: saveload.h:1063
SLV_77
@ SLV_77
77 11172
Definition: saveload.h:139
SLV_91
@ SLV_91
91 12347
Definition: saveload.h:156
SLV_44
@ SLV_44
44 8144
Definition: saveload.h:99
SLV_197
@ SLV_197
197 27978 v1.8
Definition: saveload.h:284
SLV_24
@ SLV_24
24 4150
Definition: saveload.h:75
_sl_minor_version
byte _sl_minor_version
the minor savegame version, DO NOT USE!
Definition: saveload.cpp:67
DefaultSaveLoadHandler::GetDescription
SaveLoadTable GetDescription() const override
Get the description of the fields in the savegame.
Definition: saveload.h:517
SLV_81
@ SLV_81
81 11244
Definition: saveload.h:144
SLV_60
@ SLV_60
60 9874
Definition: saveload.h:119
SLV_89
@ SLV_89
89 12160
Definition: saveload.h:153
SLV_194
@ SLV_194
194 26881 v1.5
Definition: saveload.h:280
SLV_149
@ SLV_149
149 20832
Definition: saveload.h:225
SlReadByte
byte SlReadByte()
Wrapper for reading a byte from the buffer.
Definition: saveload.cpp:424
SaveLoadHandler::Load
virtual void Load(void *object) const
Load the object from disk.
Definition: saveload.h:471
SLV_134
@ SLV_134
134 18703
Definition: saveload.h:207
DefaultSaveLoadHandler::GetCompatDescription
SaveLoadCompatTable GetCompatDescription() const override
Get the pre-header description of the fields in the savegame.
Definition: saveload.h:518
SLV_122
@ SLV_122
122 16855
Definition: saveload.h:193
SaveLoadHandler::LoadCheck
virtual void LoadCheck(void *object) const
Similar to load, but used only to validate savegames.
Definition: saveload.h:477
SLV_129
@ SLV_129
129 18292
Definition: saveload.h:201
SLV_184
@ SLV_184
184 25508 Unit localisation split
Definition: saveload.h:267
SLV_38
@ SLV_38
38 7195
Definition: saveload.h:92
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
SaveLoad::version_from
SaveLoadVersion version_from
Save/load the variable starting from this savegame version.
Definition: saveload.h:658
SLV_147
@ SLV_147
147 20621
Definition: saveload.h:223
SaveOrLoadResult
SaveOrLoadResult
Save or load result codes.
Definition: saveload.h:346
SLV_105
@ SLV_105
105 14803
Definition: saveload.h:173
SLV_165
@ SLV_165
165 23304
Definition: saveload.h:245
SLV_3
@ SLV_3
3.x lost
Definition: saveload.h:40
FiosType
FiosType
Elements of a file system that are recognized.
Definition: fileio_type.h:67
SLV_ENDING_YEAR
@ SLV_ENDING_YEAR
218 PR#7747 v1.10 Configurable ending year.
Definition: saveload.h:309
SLE_VAR_STRQ
@ SLE_VAR_STRQ
string pointer enclosed in quotes
Definition: saveload.h:590
ChunkType
ChunkType
Type of a chunk.
Definition: saveload.h:394
SLV_148
@ SLV_148
148 20659
Definition: saveload.h:224
SlGetFieldLength
size_t SlGetFieldLength()
Get the length of the current object.
Definition: saveload.cpp:792
SLV_TRADING_AGE
@ SLV_TRADING_AGE
217 PR#7780 Configurable company trading age.
Definition: saveload.h:308
SLV_188
@ SLV_188
188 26169 v1.4 FS#5831 Unify RV travel time
Definition: saveload.h:272
SLV_99
@ SLV_99
99 13838
Definition: saveload.h:165
SLV_167
@ SLV_167
167 23504
Definition: saveload.h:247
SLV_68
@ SLV_68
68 10266
Definition: saveload.h:128
REF_LINK_GRAPH
@ REF_LINK_GRAPH
Load/save a reference to a link graph.
Definition: saveload.h:545
SLV_21
@ SLV_21
21 3472 0.4.x
Definition: saveload.h:72
SLV_97
@ SLV_97
97 13256
Definition: saveload.h:163
SLV_SHIP_PATH_CACHE
@ SLV_SHIP_PATH_CACHE
203 PR#7072 Add path cache for ships
Definition: saveload.h:291
LoadFilter
Interface for filtering a savegame till it is loaded.
Definition: saveload_filter.h:14
SLV_173
@ SLV_173
173 23967 1.2.0-RC1
Definition: saveload.h:254
SL_DEQUE
@ SL_DEQUE
Save/load a deque of SL_VAR elements.
Definition: saveload.h:641
SLV_171
@ SLV_171
171 23835
Definition: saveload.h:252
SLV_185
@ SLV_185
185 25620 Storybooks
Definition: saveload.h:269
SLV_103
@ SLV_103
103 14598
Definition: saveload.h:170
SLV_SAVELOAD_LIST_LENGTH
@ SLV_SAVELOAD_LIST_LENGTH
293 PR#9374 Consistency in list length with SL_STRUCT / SL_STRUCTLIST / SL_DEQUE / SL_REFLIST.
Definition: saveload.h:335
SLV_80
@ SLV_80
80 11228
Definition: saveload.h:143
GetVariableAddress
static void * GetVariableAddress(const void *object, const SaveLoad &sld)
Get the address of the variable.
Definition: saveload.h:1094
SlCopy
void SlCopy(void *object, size_t length, VarType conv)
Copy a list of SL_VARs to/from a savegame.
Definition: saveload.cpp:1151
LoadWithFilter
SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader)
Load the game using a (reader) filter.
Definition: saveload.cpp:3220
WriteValue
void WriteValue(void *ptr, VarType conv, int64 val)
Write the value of a setting.
Definition: saveload.cpp:828
SLV_180
@ SLV_180
180 24998 1.3.x
Definition: saveload.h:263
SLV_101
@ SLV_101
101 14233
Definition: saveload.h:168
SLV_195
@ SLV_195
195 27572 v1.6.1
Definition: saveload.h:282
SLV_19
@ SLV_19
19 3396
Definition: saveload.h:69
SlCompatTableHeader
std::vector< SaveLoad > SlCompatTableHeader(const SaveLoadTable &slt, const SaveLoadCompatTable &slct)
Load a table header in a savegame compatible way.
Definition: saveload.cpp:2029
SLV_191
@ SLV_191
191 26636 FS#6026 Fix disaster vehicle storage (No bump) 191 26646 FS#6041 Linkgraph - store location...
Definition: saveload.h:276
SLV_58
@ SLV_58
58 9762
Definition: saveload.h:116
SLV_192
@ SLV_192
192 26700 FS#6066 Fix saving of order backups
Definition: saveload.h:278
SLV_70
@ SLV_70
70 10541
Definition: saveload.h:131
SaveWithFilter
SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded)
Save the game using a (writer) filter.
Definition: saveload.cpp:3062
SL_ERROR
@ SL_ERROR
error that was caught before internal structures were modified
Definition: saveload.h:348
FileToSaveLoad::detail_ftype
DetailedFileType detail_ftype
Concrete file type (PNG, BMP, old save, etc).
Definition: saveload.h:355
SLV_92
@ SLV_92
92 12381 0.6.x
Definition: saveload.h:157
SLV_121
@ SLV_121
121 16694
Definition: saveload.h:192
SaveLoad::address_proc
SaveLoadAddrProc * address_proc
Callback proc the get the actual variable address in memory.
Definition: saveload.h:661
SLV_151
@ SLV_151
151 20918
Definition: saveload.h:228
SLV_75
@ SLV_75
75 11107
Definition: saveload.h:137
SLV_95
@ SLV_95
95 12924
Definition: saveload.h:161
SLV_110
@ SLV_110
110 15148
Definition: saveload.h:179
SaveLoad::name
std::string name
Name of this field (optional, used for tables).
Definition: saveload.h:654
SaveloadCrashWithMissingNewGRFs
void NORETURN bool SaveloadCrashWithMissingNewGRFs()
Did loading the savegame cause a crash? If so, were NewGRFs missing?
Definition: afterload.cpp:365
ChunkHandler::LoadCheck
virtual void LoadCheck(size_t len=0) const
Load the chunk for game preview.
Definition: saveload.cpp:2116
SaveLoadHandler::GetCompatDescription
virtual SaveLoadCompatTable GetCompatDescription() const =0
Get the pre-header description of the fields in the savegame.
SLV_START_PATCHPACKS
@ SLV_START_PATCHPACKS
220 First known patchpack to use a version just above ours.
Definition: saveload.h:325
SLV_4
@ SLV_4
4.0 1 4.1 122 0.3.3, 0.3.4 4.2 1222 0.3.5 4.3 1417 4.4 1426
Definition: saveload.h:41
FileToSaveLoad::SetMode
void SetMode(FiosType ft)
Set the mode and file type of the file to save or load based on the type of file entry at the file sy...
Definition: saveload.cpp:3393
SaveLoad
SaveLoad type struct.
Definition: saveload.h:653
SLV_153
@ SLV_153
153 21263
Definition: saveload.h:230
SLV_140
@ SLV_140
140 19382
Definition: saveload.h:215
SLV_26
@ SLV_26
26 4466
Definition: saveload.h:78
SLV_196
@ SLV_196
196 27778 v1.7
Definition: saveload.h:283
SLV_9
@ SLV_9
9.0 1909
Definition: saveload.h:54
SL_OK
@ SL_OK
completed successfully
Definition: saveload.h:347
SaveLoadCompat::version_from
SaveLoadVersion version_from
Save/load the variable starting from this savegame version.
Definition: saveload.h:677
SL_STDSTR
@ SL_STDSTR
Save/load a std::string.
Definition: saveload.h:638
SLV_51
@ SLV_51
51 8978
Definition: saveload.h:108
SLV_63
@ SLV_63
63 9956
Definition: saveload.h:122
SGT_TTDP2
@ SGT_TTDP2
TTDP savegame in new format (data at SE border)
Definition: saveload.h:370
SlSkipBytes
static void SlSkipBytes(size_t length)
Read in bytes from the file/data structure but don't do anything with them, discarding them in effect...
Definition: saveload.h:1141
_sl_version
SaveLoadVersion _sl_version
the major savegame version identifier
Definition: saveload.cpp:66
SlObject
void SlObject(void *object, const SaveLoadTable &slt)
Main SaveLoad function.
Definition: saveload.cpp:1838
SLE_VAR_NAME
@ SLE_VAR_NAME
old custom name to be converted to a char pointer
Definition: saveload.h:591
SLV_137
@ SLV_137
137 18912
Definition: saveload.h:211
SLV_143
@ SLV_143
143 20048
Definition: saveload.h:218
SLV_34
@ SLV_34
34 6455
Definition: saveload.h:87
SLV_57
@ SLV_57
57 9691
Definition: saveload.h:115
SLV_72
@ SLV_72
72 10601
Definition: saveload.h:133
SLV_152
@ SLV_152
152 21171
Definition: saveload.h:229
SlCalcObjLength
size_t SlCalcObjLength(const void *object, const SaveLoadTable &slt)
Calculate the size of an object.
Definition: saveload.cpp:1594
SLV_37
@ SLV_37
37 7182
Definition: saveload.h:91
SLV_1
@ SLV_1
1.0 0.1.x, 0.2.x
Definition: saveload.h:37
SlError
void NORETURN SlError(StringID string, const char *extra_msg=nullptr)
Error handler.
Definition: saveload.cpp:332
SLV_13
@ SLV_13
13.1 2080 0.4.0, 0.4.0.1
Definition: saveload.h:60
SLV_190
@ SLV_190
190 26547 Separate order travel and wait times
Definition: saveload.h:275
FileToSaveLoad::file_op
SaveLoadOperation file_op
File operation to perform.
Definition: saveload.h:354
SLV_SHIP_ROTATION
@ SLV_SHIP_ROTATION
204 PR#7065 Add extra rotation stages for ships.
Definition: saveload.h:292
SLV_39
@ SLV_39
39 7269
Definition: saveload.h:93
SLV_48
@ SLV_48
48 8935
Definition: saveload.h:104
DefaultSaveLoadHandler::Load
void Load(void *object) const override
Load the object from disk.
Definition: saveload.h:524
SLV_159
@ SLV_159
159 21962
Definition: saveload.h:237
SLV_18
@ SLV_18
18 3227
Definition: saveload.h:68
SLV_177
@ SLV_177
177 24619
Definition: saveload.h:259
SL_STRUCTLIST
@ SL_STRUCTLIST
Save/load a list of structs.
Definition: saveload.h:644
SLV_EXTEND_RAILTYPES
@ SLV_EXTEND_RAILTYPES
200 PR#6805 Extend railtypes to 64, adding uint16 to map array.
Definition: saveload.h:288
SLV_71
@ SLV_71
71 10567
Definition: saveload.h:132
ReadValue
int64 ReadValue(const void *ptr, VarType conv)
Return a signed-long version of the value of a setting.
Definition: saveload.cpp:804