1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef CINE_SAVELOAD_H
#define CINE_SAVELOAD_H
#include "common/endian.h"
namespace Cine {
extern int16 currentDisk;
/**
* Cine engine's save game formats.
* Enumeration entries (Excluding the one used as an error)
* are sorted according to age (i.e. top one is oldest, last one newest etc).
*
* ANIMSIZE_UNKNOWN:
* - Animation data entry size is unknown (Used as an error).
*
* ANIMSIZE_23:
* - Animation data entry size is 23 bytes.
* - Used at least by 0.11.0 and 0.11.1 releases of ScummVM.
* - Introduced in revision 21772, stopped using in revision 31444.
*
* ANIMSIZE_30_PTRS_BROKEN:
* - Animation data entry size is 30 bytes.
* - Data and mask pointers in the saved structs are always NULL.
* - Introduced in revision 31453, stopped using in revision 32073.
*
* ANIMSIZE_30_PTRS_INTACT:
* - Animation data entry size is 30 bytes.
* - Data and mask pointers in the saved structs are intact,
* so you can test them for equality or inequality with NULL
* but don't try using them for anything else, it won't work.
* - Introduced in revision 31444, got broken in revision 31453,
* got fixed in revision 32073 and used after that.
*
* TEMP_OS_FORMAT:
* - Temporary Operation Stealth savegame format.
* - NOT backward compatible and NOT to be supported in the future.
* This format should ONLY be used during development and abandoned
* later in favor of a better format!
*/
enum CineSaveGameFormat {
ANIMSIZE_UNKNOWN,
ANIMSIZE_23,
ANIMSIZE_30_PTRS_BROKEN,
ANIMSIZE_30_PTRS_INTACT,
TEMP_OS_FORMAT,
VERSIONED_FW_FORMAT,
VERSIONED_OS_FORMAT
};
/** Identifier for the temporary Operation Stealth savegame format. */
static const uint32 TEMP_OS_FORMAT_ID = MKTAG('T', 'E', 'M', 'P');
/** Identifiers for versioned Future Wars and Operation Stealth savegame formats. */
static const uint32 VERSIONED_FW_FORMAT_ID = MKTAG('C', '1', 'F', 'W');
static const uint32 VERSIONED_OS_FORMAT_ID = MKTAG('C', '2', 'O', 'S');
/** The current version number of versioned Future Wars and Operation Stealth savegame formats.
Version 4: First version used. Added disableSystemMenu to Future Wars savegame format.
*/
static const uint32 CURRENT_SAVE_VER = 4;
/** The last version number of temporary Operation Stealth's savegame format.
Version 0: Color count was not saved, was assumed to be 256. BGIncrust.bgIdx does not exist, _currentBg was used.
Version 1: Saving of real color count was added but still 256 colors were always saved.
Version 2: BGIncrust.bgIdx was added.
Version 3: Saving real values for current music name, music playing status, current background index,
scroll background index and background scrolling was added.
*/
static const uint32 LAST_TEMP_OS_SAVE_VER = 3;
/** Chunk header used by the temporary Operation Stealth savegame format. */
struct ChunkHeader {
uint32 id; ///< Identifier (e.g. MKTAG('T','E','M','P'))
uint32 version; ///< Version number
uint32 size; ///< Size of the chunk after this header in bytes
};
} // End of namespace Cine
#endif
|
