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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
|
/* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef CRYOMNI3D_VERSAILLES_ENGINE_H
#define CRYOMNI3D_VERSAILLES_ENGINE_H
#include "common/events.h"
#include "common/random.h"
#include "common/array.h"
#include "common/hashmap.h"
#include "common/str.h"
#include "cryomni3d/cryomni3d.h"
#include "cryomni3d/omni3d.h"
#include "cryomni3d/sprites.h"
#include "cryomni3d/wam_parser.h"
#include "cryomni3d/versailles/documentation.h"
#include "cryomni3d/versailles/toolbar.h"
#include "cryomni3d/versailles/dialogs_manager.h"
namespace Graphics {
class ManagedSurface;
struct Surface;
}
namespace CryOmni3D {
struct FixedImageConfiguration;
class ZonFixedImage;
}
namespace CryOmni3D {
namespace Versailles {
struct PlaceStateActionKey {
unsigned int placeId;
unsigned int placeState;
unsigned int actionId;
PlaceStateActionKey(unsigned int placeId_, unsigned int placeState_, unsigned int actionId_) :
placeId(placeId_), placeState(placeState_), actionId(actionId_) {}
bool operator==(const PlaceStateActionKey &other) const {
return other.placeId == placeId && other.placeState == placeState && other.actionId == actionId;
}
};
struct PlaceActionKey {
unsigned int placeId;
unsigned int actionId;
PlaceActionKey(unsigned int placeId_, unsigned int actionId_) :
placeId(placeId_), actionId(actionId_) {}
bool operator==(const PlaceActionKey &other) const {
return other.placeId == placeId && other.actionId == actionId;
}
};
}
}
namespace Common {
template<>
struct Hash<CryOmni3D::Versailles::PlaceStateActionKey> {
uint operator()(const CryOmni3D::Versailles::PlaceStateActionKey &k) const {
// placeState shouldn't be greater than 8 and placeId shouldn't be greater than 100
// originalActionId shouldn't be greater than 65536
return (k.placeId << 24 | k.placeState << 16) ^ k.actionId;
}
};
template<>
struct Hash<CryOmni3D::Versailles::PlaceActionKey> {
uint operator()(const CryOmni3D::Versailles::PlaceActionKey &k) const {
// placeId shouldn't be greater than 100
// originalActionId shouldn't be greater than 65536
return (k.placeId << 16) ^ k.actionId;
}
};
}
namespace CryOmni3D {
namespace Versailles {
class CryOmni3DEngine_Versailles;
enum AbortCommand {
AbortNoAbort = 0,
AbortQuit = 1,
AbortLoadGame = 2,
AbortNewGame = 3,
AbortNextLevel = 5,
AbortFinished = 6,
AbortGameOver = 7
};
struct GameVariables {
enum Var {
// TODO: make these enum members more correct
kCollectScore = 0, // OK // 0
kUnlockHiddenDoor, // OK
kAlreadyWent3_19, // OK
kMedalsDrawerStatus, // OK
kCurrentTime, // OK
kGotMedalsSolution, // OK
kCabinetDrawerStatus, // OK
kDecipherScore, // OK
kCollectLampoonArchitecture, // OK
kGotRevealedPaper, // OK
kCollectKey, // OK // 10
kCollectPortfolio, // OK
kSketchState, // OK
kFakeSketchChatState, // OK
kCollectNourriture,
kCollectPlume,
kStatePamphletReligion,
kCollectPetiteCle3,
kCollectGravure,
kCollectCordon,
kCollectPlanVauban, // 20
kCollectPlanVauban2,
kCollectEchelle,
kLostCordon,
kDescendreLustre,
kOrangerRatisse,
kDiscussedLabyrOrder,
kUsedBougieAllumee,
kStateBombe,
kInkSpilled, // OK
kCollectedPaperOnTable, // OK // 30
kCoffreUnlocked,
//kUselessVar,
kCollectedPaperInTrunk = 33, // OK
kBrushColor, // OK
kUsedScissors, // OK
kUnlockedAttic, // OK
kHasPlayedLebrun, // OK
kWarnedIncomplete,
kUsedPlanVauban1,
kUsedPlanVauban2, // 40
kSeenMemorandum,
kCollectScissors, // OK
kSavedCountdown, // TODO: calculate it in real time
kMax
};
};
// For random sounds we set a constant ID and avoid to use it elsewhere
struct SoundIds {
enum {
kOrgue = 0,
kLeb001,
kMax
};
};
struct PlaceState {
typedef void (CryOmni3DEngine_Versailles::*InitFunc)();
typedef bool (CryOmni3DEngine_Versailles::*FilterEventFunc)(unsigned int *event);
PlaceState() : initPlace(nullptr), filterEvent(nullptr), docImage(nullptr), state(0) {}
PlaceState(InitFunc initPlace_, FilterEventFunc filterEvent_, const char *docImage_) :
initPlace(initPlace_), filterEvent(filterEvent_), docImage(docImage_), state(0) {}
InitFunc initPlace;
FilterEventFunc filterEvent;
const char *docImage;
unsigned int state;
};
struct LevelInitialState {
unsigned int placeId;
double alpha;
double beta;
};
struct FakeTransitionActionPlace {
unsigned int actionId;
unsigned int placeId;
};
typedef void (CryOmni3DEngine_Versailles::*FixedImgCallback)(ZonFixedImage *);
struct MsgBoxParameters {
int font;
byte foreColor;
unsigned int lineHeight;
unsigned int spaceWidth;
unsigned int charSpacing;
unsigned int initialWidth;
unsigned int incrementWidth;
unsigned int initialHeight;
unsigned int incrementHeight;
unsigned int timeoutChar;
};
class CryOmni3DEngine_Versailles : public CryOmni3DEngine {
friend class Versailles_DialogsManager;
protected:
Common::Error run() override;
public:
CryOmni3DEngine_Versailles(OSystem *syst, const CryOmni3DGameDescription *gamedesc);
virtual ~CryOmni3DEngine_Versailles();
Common::String prepareFileName(const Common::String &baseName, const char *extension) const {
const char *const extensions[] = { extension, nullptr };
return prepareFileName(baseName, extensions);
}
virtual Common::String prepareFileName(const Common::String &baseName,
const char *const *extensions) const override;
void setupPalette(const byte *colors, uint start, uint num) override { setupPalette(colors, start, num, true); }
void makeTranslucent(Graphics::Surface &dst, const Graphics::Surface &src) const override;
virtual bool displayToolbar(const Graphics::Surface *original) override { return _toolbar.displayToolbar(original); };
virtual bool hasPlaceDocumentation() override;
virtual bool displayPlaceDocumentation() override;
virtual unsigned int displayOptions() override;
virtual bool shouldAbort() override { return g_engine->shouldQuit() || _abortCommand != AbortNoAbort; }
private:
void setupFonts();
void setupSprites();
void loadCursorsPalette();
void calculateTransparentMapping();
void setupMessages();
void setupObjects();
void setupDialogVariables();
void setupImgScripts();
void setupPaintingsTitles();
void syncOmni3DSettings();
void syncSoundSettings();
void playTransitionEndLevel(int level);
void changeLevel(int level);
void initNewLevel(int level);
void setupLevelWarps(int level);
void initPlacesStates();
void initWhoSpeaksWhere();
void initDocPeopleRecord();
void setupLevelActionsMask();
unsigned int currentGameTime() const { return _gameVariables[GameVariables::kCurrentTime]; }
void setGameTime(unsigned int newTime, unsigned int level);
void updateGameTimeDialVariables();
void gameStep();
void doGameOver();
void setPlaceState(unsigned int placeId, unsigned int newState);
void doPlaceChange();
void executeTransition(unsigned int nextPlaceId);
void fakeTransition(unsigned int dstPlaceId);
unsigned int determineTransitionAnimation(unsigned int srcId, unsigned int dstId,
const Transition **transition);
unsigned int getFakeTransition(unsigned int actionId) const;
void fixActionId(unsigned int *actionId) const;
int handleWarp();
bool handleWarpMouse(unsigned int *actionId, unsigned int movingCuror);
void animateWarpTransition(const Transition *transition);
void redrawWarp();
void handleFixedImg(const FixedImgCallback &callback);
void executeSeeAction(unsigned int actionId);
void executeSpeakAction(unsigned int actionId);
void setupDialogShows();
bool preprocessDialog(const Common::String &sequence);
void postprocessDialog(const Common::String &sequence);
void executeDocAction(unsigned int actionId);
void drawMenuTitle(Graphics::ManagedSurface *surface, byte color);
unsigned int displayFilePicker(const Graphics::Surface *bgFrame, bool saveMode,
Common::String &saveName);
unsigned int displayYesNoBox(Graphics::ManagedSurface &surface, const Common::Rect &position,
unsigned int msg_id);
void displayMessageBox(const MsgBoxParameters ¶ms, const Graphics::Surface *surface,
unsigned int msg_id, const Common::Point &position,
const Common::Functor0<void> &callback) { displayMessageBox(params, surface, _messages[msg_id], position, callback); }
void displayMessageBox(const MsgBoxParameters ¶ms, const Graphics::Surface *surface,
const Common::String &msg, const Common::Point &position,
const Common::Functor0<void> &callback);
void displayMessageBoxWarp(const Common::String &message);
void displayMessageBoxWarp(unsigned int msg_id) { displayMessageBoxWarp(_messages[msg_id]); }
void displayCredits();
void warpMsgBoxCB();
bool canVisit() const;
Common::String getSaveFileName(bool visit, unsigned int saveNum) const;
void getSavesList(bool visit, Common::Array<Common::String> &saveNames);
void saveGame(bool visit, unsigned int saveNum, const Common::String &saveName) const;
bool loadGame(bool visit, unsigned int saveNum);
void animateCursor(const Object *object);
void collectObject(Object *object, const ZonFixedImage *fimg = nullptr,
bool showObject = true);
void collectObject(unsigned int nameID, const ZonFixedImage *fimg = nullptr,
bool showObject = true) { collectObject(_objects.findObjectByNameID(nameID), fimg, showObject); }
typedef void (CryOmni3DEngine_Versailles::*DisplayObjectHook)(Graphics::ManagedSurface &surface);
void displayObject(const Common::String &imgName, DisplayObjectHook hook = nullptr);
void setMainPaletteColor(byte color, byte red, byte green, byte blue);
void setupPalette(const byte *colors, uint start, uint num, bool commit);
bool showSubtitles() const;
void playInGameVideo(const Common::String &filename, bool restoreCursorPalette = true);
void loadBMPs(const char *pattern, Graphics::Surface *bmps, unsigned int count);
unsigned int getMusicId(unsigned int level, unsigned int placeId) const;
bool musicWouldChange(unsigned int level, unsigned int placeId) const;
void musicUpdate();
void musicPause();
void musicResume();
void musicStop();
void musicSetQuiet(bool quiet);
Common::StringArray _messages;
static const unsigned int kSpritesMapTable[];
static const unsigned int kSpritesMapTableSize;
static const LevelInitialState kLevelInitialStates[];
static const FakeTransitionActionPlace kFakeTransitions[];
Common::HashMap<unsigned int, FixedImgCallback> _imgScripts;
Common::Array<Common::String> _paintingsTitles;
Toolbar _toolbar;
byte *_mainPalette;
byte *_cursorPalette;
bool _fadedPalette;
bool _forcePaletteUpdate;
bool _forceRedrawWarp;
byte *_transparentPaletteMap;
unsigned int _transparentSrcStart;
unsigned int _transparentSrcStop;
unsigned int _transparentDstStart;
unsigned int _transparentDstStop;
unsigned int _transparentNewStart;
unsigned int _transparentNewStop;
bool _isPlaying;
bool _isVisiting;
AbortCommand _abortCommand;
unsigned int _loadedSave;
int _omni3dSpeed;
unsigned int _currentLevel;
Versailles_DialogsManager _dialogsMan;
Omni3DManager _omni3dMan;
ZonFixedImage *_fixedImage;
Common::Array<unsigned int> _gameVariables;
Common::Array<PlaceState> _placeStates;
Common::HashMap<PlaceStateActionKey, unsigned int> _actionMasks;
Common::HashMap<PlaceActionKey, Common::String> _whoSpeaksWhere;
Common::HashMap<unsigned int, const char *> _docPeopleRecord;
bool _transitionAnimateWarp;
unsigned int _nextPlaceId;
WAMParser _wam;
unsigned int _currentPlaceId;
const Place *_currentPlace;
const Image::ImageDecoder *_currentWarpImage;
const char *_musicCurrentFile;
Audio::SoundHandle _musicHandle;
float _musicVolumeFactor;
static const char *kMusicFiles[8][8];
Versailles_Documentation _docManager;
static const MsgBoxParameters kWarpMsgBoxParameters;
static const MsgBoxParameters kFixedimageMsgBoxParameters;
static const FixedImageConfiguration kFixedImageConfiguration;
//Objects
template<unsigned int ID>
void genericDisplayObject();
void obj_105();
void obj_106();
void obj_107();
void obj_118();
void obj_121();
void obj_125();
// Fixed image
template<unsigned int ID>
void genericDumbImage(ZonFixedImage *fimg);
template<unsigned int ID>
void genericPainting(ZonFixedImage *fimg);
#define IMG_CB(name) void img_ ## name(ZonFixedImage *fimg)
IMG_CB(31101);
IMG_CB(31101b);
IMG_CB(31142);
IMG_CB(31142b);
IMG_CB(31142c);
IMG_CB(31142d);
IMG_CB(31143);
IMG_CB(31143b);
IMG_CB(31143c);
IMG_CB(31143d);
IMG_CB(32120);
IMG_CB(32120b);
IMG_CB(32120c);
IMG_CB(32201);
IMG_CB(32202);
IMG_CB(32203);
IMG_CB(32204);
IMG_CB(32204b);
IMG_CB(41202);
IMG_CB(41202b);
IMG_CB(41801);
IMG_CB(41801b);
IMG_CB(41801c);
IMG_CB(41802);
IMG_CB(41802b);
IMG_CB(41802c);
IMG_CB(41802d);
IMG_CB(43143);
IMG_CB(43143b);
IMG_CB(43145);
IMG_CB(43145b);
IMG_CB(43145c);
IMG_CB(43146);
IMG_CB(43146b);
IMG_CB(43146c);
IMG_CB(43160);
IMG_CB(43160b);
IMG_CB(43160c);
IMG_CB(43160d);
IMG_CB(43190);
IMG_CB(43190b);
IMG_CB(43190c);
IMG_CB(43190d);
IMG_CB(43190e);
IMG_CB(43190f);
IMG_CB(88001);
IMG_CB(88001b);
IMG_CB(88001c);
IMG_CB(88004);
IMG_CB(88004b);
#undef IMG_CB
#define FILTER_EVENT(level, place) bool filterEventLevel ## level ## Place ## place(unsigned int *event)
#define INIT_PLACE(level, place) void initPlaceLevel ## level ## Place ## place()
FILTER_EVENT(1, 1);
FILTER_EVENT(1, 2);
INIT_PLACE(1, 3);
FILTER_EVENT(1, 3);
//FILTER_EVENT(1, 7); // Not used
FILTER_EVENT(1, 14);
FILTER_EVENT(2, 1);
FILTER_EVENT(2, 2);
FILTER_EVENT(2, 5);
INIT_PLACE(2, 9);
FILTER_EVENT(2, 9);
FILTER_EVENT(2, 11);
FILTER_EVENT(2, 12);
FILTER_EVENT(2, 14);
FILTER_EVENT(3, 3);
FILTER_EVENT(3, 10);
FILTER_EVENT(3, 13);
FILTER_EVENT(3, 15);
FILTER_EVENT(3, 17);
FILTER_EVENT(3, 18);
FILTER_EVENT(3, 19);
FILTER_EVENT(3_5, 20);
FILTER_EVENT(3, 22);
FILTER_EVENT(3, 23);
bool filterEventLevel3Obj23151();
void collectLampoonArchitecture(const ZonFixedImage *fimg = nullptr);
#undef FILTER_EVENT
#undef INIT_PLACE
// Dialogs shows
void dialogShowBontempsShowThird();
void dialogShowHuissierShowPamphlet();
void dialogShowMonseigneurSorts();
void dialogShowLeBrunWatches();
void dialogShowDoorsOpen();
void dialogShowSwissGuardGives();
void dialogShowLullyCorrects();
void dialogShowBontempsGivesAuth();
void dialogShowCroissyLeave();
void dialogShowMaintenonGives();
void dialogShowLaChaizeGivesBack();
void dialogShowLaChaizeWrites();
void dialogShowLaChaizeGivesPamphlet();
void dialogShowBontempsGivesKey();
void dialogShowDuMaineLeaves();
void dialogShowTransitionScene();
void dialogShowEndOfGame();
void dialogShowLeBrunGives();
void dialogShowLeBrunLeave();
};
} // End of namespace Versailles
} // End of namespace CryOmni3D
#endif
|