ScummVM API documentation
saveload.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef HOLLYWOOD_RUNAWAY_SAVELOAD_H
23#define HOLLYWOOD_RUNAWAY_SAVELOAD_H
24
25#include "common/serializer.h"
26#include "hollywood/runaway/detection.h"
27
28namespace Hollywood {
29
30// Persistent state survives scene changes. Saves are made between actions;
31// resources, pointers and animation clocks are rebuilt when restoring it.
33 struct Hospital {
34 byte glassTaken = 0, pillsTaken = 0, sheetTaken = 0, bagTaken = 0, exitMapRead = 0;
35 byte markerTaken = 0, alcohol = 0;
36 byte window = 0, chartReplaced = 0, chartMoved = 0, decoy = 0, attacked = 0, medicineRead = 0;
37 byte storeroomVisited = 0, syringesSeen = 0, sprayTaken = 0, book = 0, blankChart = 0, headTaken = 0, pillowsTaken = 0;
38 } hospital;
39
40 struct Museum {
41 byte susan = 0, restoration = 0, laserUpgraded = 0, laserSeen = 0, shelvesSeen = 0;
42 byte susanMet = 0, labVisited = 0, shelfBooksSeen = 0, safeUsed = 0;
43 byte officeVisited = 0, exhibitionVisited = 0, phonePlanExplained = 0;
44 byte willyMet = 0, batteryRequested = 0, coffeeMachine = 0, coffeeSeen = 0;
45 byte basketSeen = 0, needsPackage = 0, needsGroundCoffee = 0, willyInLab = 0;
46 byte keypad = 0, sawCode = 0, phoneUsed = 0, voiceLockSeen = 0;
47 byte chamberOpen = 0, maskTaken = 0, keyTaken = 0, ladleTaken = 0;
48 byte cabinetSeen = 0, scannerSeen = 0, nitrogenSeen = 0, microscopeSeen = 0;
49 byte talcSeen = 0, varnishSeen = 0, mayanObjectsSeen = 0, coffeeBeansTaken = 0;
50 byte buttonSeen = 0, ownVoiceTried = 0, analysisDoorSeen = 0, leftLabOnce = 0, keySeen = 0;
51 byte exhibitSeen[3] = {};
52 uint16 keypadDigits = 0;
53 uint32 chamberTime = 0;
54 } museum;
55
56 struct MuseumItems {
57 byte businessCardExamined = 0;
58 byte restoredCrucifix = 0, voiceRecorded = 0, coffee = 0, frozenBattery = 0;
59 byte rubyRemoved = 0, recorderBattery = 0, batteryInLadle = 0, packageFilled = 0;
60 } museumItems;
61
62 struct Desert {
63 byte visited[10] = {};
64 byte escapedCabin = 0, hatchSeen = 0, bucketTaken = 0;
65 byte helmetTaken = 0, beltTaken = 0, beltSeen = 0, gun = 0, gunSeen = 0;
66 byte mariolaHelped = 0, ballTaken = 0, tanningOil = 0, lulaHelped = 0;
67 byte busPosterSeen = 0, lulaCalled = 0, lulaRefused = 0;
68 byte dynamitePlaced = 0, oilSeen = 0;
69 byte antsDistracted = 0, dynamite = 0, shedTried = 0, trainEntered = 0;
70 byte barrel = 0, screwSeen = 0, screwTaken = 0, bucket = 0, trainDoorOpen = 0, powderNeeded = 0;
71 byte barnDoor = 0, footrest = 0, guard = 0, insideBarn = 0, beerSeen = 0;
72 byte peanutButter = 0, motorcycleSeen = 0, footrestSeen = 0;
73 byte lulaDistractedGuard = 0, guardWeaknessKnown = 0;
74 byte busDoor = 0, lipstickShelf = 0, keyTaken = 0, glassesTaken = 0;
75 byte vacuum = 0, crank = 0, necklacesSeen = 0, ringsSeen = 0;
76 byte fridgeOpened = 0, ventCleaned = 0, ventSeen = 0, needle = 0, fridgeSeen = 0;
77 byte carlaMet = 0, carlaStory = 0, planKnown = 0;
78 uint32 carlaTopics = 0, lulaTopics = 0;
79 } desert;
80
81 struct DesertItems {
82 byte antTrickKnown = 0;
83 byte helmet = 0, lipstick = 0, lipsticks = 0, belt = 0, ball = 0;
84 byte glasses = 0, pill = 0, bucket = 0;
85 byte gunReady = 0, bombReady = 0, helicopterReady = 0;
86 } desertItems;
87
88 struct Town {
89 byte arrived = 0, streetVisited = 0, strapSeen = 0;
90 byte sushiMet = 0, mineMapKnown = 0;
91 byte bankVisited = 0, bankShelves = 0, bankStampTaken = 0, basementKnown = 0;
92 byte bodySeen = 0, doctorKnown = 0, firewoodTaken = 0, cellOpen = 0;
93 byte bagSearched = 0, bucketSeen = 0, bottleSeen = 0, cellRefusals = 0;
94 byte safeSeen = 0, oscarTobacco = 0, stethoscopeTaken = 0, linimentTaken = 0;
95 byte locomotiveVisited = 0, locomotiveKey = 0, waterTank = 0;
96 byte cabVisited = 0, cabExited = 0, boiler = 0;
97 byte steamLever = 0, pressureWheel = 0, drainSeen = 0;
98 byte craterSeen = 0;
99 byte mineVisited = 0, oilCan = 0, rockMoved = 0;
100 byte houseVisited = 0, stone = 0, vessel = 0;
101 byte oscarMet = 0, oscarHelpRefused = 0, rawTobaccoRefused = 0;
102 byte saloonEntranceVisited = 0, saloonDoorKnown = 0, saloonVisited = 0;
103 byte flowerPotTaken = 0, gardeningShed = 0, tobaccoLeavesTaken = 0;
104 byte artichokeSeen = 0, carnivorousPlantSeen = 0;
105 byte craterVisited = 0, joshuaMet = 0, campLeft = 0;
106 byte strapDelivered = 0, wrenchDelivered = 0, wrenchNeeded = 0, fuelNeeded = 0;
107 byte machineKnown = 0, rotorKnown = 0, batteryKnown = 0, helmetKnown = 0, dimensionalDoorKnown = 0;
108 byte strapIdea = 0;
109 byte sandingBlock = 0, wrenchThrown = 0, wrenchFound = 0, wrenchInTroughSeen = 0;
110 byte kevinAway = 0, craterFloorVisited = 0, joshuaGone = 0, helmetTaken = 0;
111 byte kevinMet = 0, catapult = 0, statueLowered = 0, blowtorchTaken = 0;
112 byte sculptureTraded = 0, craneKnown = 0, craneTried = 0, wrenchPermission = 0;
113 byte fuelTradeKnown = 0, waterPermission = 0, waterRequested = 0, hopiDiscussed = 0;
114 byte roughSculptureRefused = 0, polishedSculptureRefused = 0, oscarStrengthKnown = 0;
115 byte basementVisited = 0, bankImpactSeen = 0;
116 byte safeOpened = 0, stethoscopeTried = 0, safeDialVisited = 0;
117 byte safeDial = 69, safeProgress = 0;
118 byte machinePowered = 0, melodyTried = 0, campingGearTaken = 0;
119 } town;
120
121 struct TownItems {
122 byte strap = 0; // Loose, needs joining, joined.
123 byte sculpture = 0; // Rough, sanded, decorated with amber.
124 byte oilCanFull = 0, bottleContents = 0;
125 byte tube30 = 0, tube50 = 0; // Contents in units of ten cubic centimeters.
126 byte mortar = 0, mortarIdea = 0;
127 } townItems;
128
129 struct Hopi {
130 byte cliffVisited = 0, skeletonSeen = 0, nail = 0, timber = 0;
131 byte femurTaken = 0, rockTried = 0;
132 byte ginaFound = 0, villageLevel = 0, rope = 0, legSplinted = 0;
133 byte cryptVisited = 0;
134 byte canyonVisited = 0, cryptEntranceVisited = 0, keyholeBlockedKnown = 0, bushSeen = 0;
135 byte cryptDoor = 0; // Sand-blocked, cleared, open, sealed after visiting Wupuchim.
136 byte statueVisited = 0, tomahawk = 0, leftCrossSeen = 0, rightCrossSeen = 0;
137 } hopi;
138
139 struct HopiItems {
140 byte toolHandle = 0;
141 } hopiItems;
142
143 struct Finale {
144 byte doritaMet = 0, mediumDiscussed = 0, mediumTests = 0, seanceComplete = 0;
145 byte oscarAway = 0, gangsters = 0, moneyFound = 0, nunsHabit = 0;
146 byte trailerFound = 0; // Unknown, directions from Saturn, visited.
147 byte recordingPlan = 0, recordings = 0, ginaUpdates = 0, ginaVisitPending = 0;
148 byte gangstersMet = 0, gangsterBag = 0; // Bag: absent, present, examined, taken.
149 byte scalpelNeeded = 0, streetVisited = 0, sheriffThanked = 0, sushiVisited = 0;
150 byte bankResearch = 0; // Not started, requested, Brian went away, results ready.
151 byte voicePlanPending = 0, voiceEditing = 0, departure = 0;
152 byte rutgerMet = 0, rutgerTranceDiscussed = 0, rutgerBrewDiscussed = 0, rutgerPlantHint = 0;
153 byte rutgerBrew = 0; // Not started, brewing, consumed, discussed afterward.
154 byte saloonVisited = 0;
155 byte locomotiveBadge = 0; // In the boiler, on the ground, examined, taken.
156 byte saturnMet = 0, craterVisited = 0;
157 byte hotelVisited = 0, rifle = 0, pokerTaken = 0, bellRings = 0;
158 byte sushiTruthTold = 0, hackerKnown = 0, trailerDiscussed = 0, gangstersDiscussed = 0;
159 byte bagDelivered = 0; // Not delivered, waiting for Sushi, examined.
160 byte movieFanKnown = 0;
161 byte trailerVisited = 0, trailerDoor = 0, trailerDoorTried = 0, bankBrochureTaken = 0;
162 byte trailerWarnings = 0, trailerInteriorVisited = 0;
163 byte ginaVisited = 0, ginaMediumDiscussed = 0;
164 } finale;
165
166 struct FinaleItems {
167 byte scalpel = 0; // Cold, hot, cooled after cutting the pods.
168 byte heatNeeded = 0, podsOpened = 0;
169 } finaleItems;
170
171 uint16 scene = 5030, x = 623, y = 447, camera = 111;
172 byte facing = 3, lidOpen = 0, unplugged = 0, windowClean = 0;
173 byte coolerMoved = 0, coolerInspected = 0, peeked = 0, ice = 0, hatch = 0;
174 byte pickedUp[20] = {}, examined[20] = {};
175 byte itemCount = 0, items[32] = {}, selected = 0, cloth = 0;
176 byte inventoryOpen = 0, verb = 0;
177 uint32 randomSeed = 0, playTime = 0;
178 byte game = kRunawayCabinDemo;
179 uint16 cameraY = 0;
180 byte upperFloor = 1, books = 0, recorder = 0, moneyIdentified = 0, safeOpen = 0;
181 byte varnishTaken = 0, talcTaken = 0, coffeeTaken = 0, keyCount = 0;
182 byte water = 0;
183 byte markerInk = 0, syringeFilled = 0, chartWritten = 0, headWig = 0;
184
185 byte chapter() const;
186 bool valid() const;
187 bool read(Common::SeekableReadStream &stream);
188 bool write(Common::WriteStream &stream);
189
190private:
191 void sync(Common::Serializer &s);
192};
193
194} // End of namespace Hollywood
195
196#endif
Definition: stream.h:745
Definition: serializer.h:80
Definition: stream.h:77
Definition: saveload.h:62
Definition: saveload.h:143
Definition: saveload.h:129
Definition: saveload.h:139
Definition: saveload.h:33
Definition: saveload.h:40
Definition: saveload.h:88
Definition: saveload.h:121
Definition: saveload.h:32