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
|
/* 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.
*
* $URL$
* $Id$
*
*/
#ifndef GOB_GOB_H
#define GOB_GOB_H
#include "common/random.h"
#include "common/system.h"
#include "common/savefile.h"
#include "engines/engine.h"
#include "gob/console.h"
namespace GUI {
class StaticTextWidget;
}
/**
* This is the namespace of the Gob engine.
*
* Status of this engine: ???
*
* Games using this engine:
* - Gobliiins
* - Gobliins 2
* - Goblins 3
* - Ween: The Prophecy
* - Bargon Attack
* - Lost in Time
* - The Bizarre Adventures of Woodruff and the Schnibble
*/
namespace Gob {
class Game;
class Sound;
class Video;
class Global;
class Draw;
class DataIO;
class Goblin;
class VideoPlayer;
class Init;
class Inter;
class Map;
class Mult;
class PalAnim;
class Scenery;
class Util;
class SaveLoad;
class GobConsole;
#define WRITE_VAR_UINT32(var, val) _vm->_inter->_variables->writeVar32(var, val)
#define WRITE_VAR_UINT16(var, val) _vm->_inter->_variables->writeVar16(var, val)
#define WRITE_VAR_UINT8(var, val) _vm->_inter->_variables->writeVar8(var, val)
#define WRITE_VAR_STR(var, str) _vm->_inter->_variables->writeVarString(var, str)
#define WRITE_VARO_UINT32(off, val) _vm->_inter->_variables->writeOff32(off, val)
#define WRITE_VARO_UINT16(off, val) _vm->_inter->_variables->writeOff16(off, val)
#define WRITE_VARO_UINT8(off, val) _vm->_inter->_variables->writeOff8(off, val)
#define WRITE_VARO_STR(off, str) _vm->_inter->_variables->writeOffString(off, str)
#define READ_VAR_UINT32(var) _vm->_inter->_variables->readVar32(var)
#define READ_VAR_UINT16(var) _vm->_inter->_variables->readVar16(var)
#define READ_VAR_UINT8(var) _vm->_inter->_variables->readVar8(var)
#define READ_VARO_UINT32(off) _vm->_inter->_variables->readOff32(off)
#define READ_VARO_UINT16(off) _vm->_inter->_variables->readOff16(off)
#define READ_VARO_UINT8(off) _vm->_inter->_variables->readOff8(off)
#define GET_VAR_STR(var) _vm->_inter->_variables->getAddressVarString(var)
#define GET_VARO_STR(off) _vm->_inter->_variables->getAddressOffString(off)
#define GET_VAR_FSTR(var) _vm->_inter->_variables->getAddressVarString(var)
#define GET_VARO_FSTR(off) _vm->_inter->_variables->getAddressOffString(off)
#define WRITE_VAR_OFFSET(off, val) WRITE_VARO_UINT32((off), (val))
#define WRITE_VAR(var, val) WRITE_VAR_UINT32((var), (val))
#define VAR_OFFSET(off) READ_VARO_UINT32(off)
#define VAR(var) READ_VAR_UINT32(var)
// WARNING: Reordering these will invalidate save games!
enum Endianness {
kEndiannessLE,
kEndiannessBE
};
// WARNING: Reordering these will invalidate save games!
// Add new games to the bottom of the list.
enum GameType {
kGameTypeNone = 0,
kGameTypeGob1,
kGameTypeGob2,
kGameTypeGob3,
kGameTypeWoodruff,
kGameTypeBargon,
kGameTypeWeen,
kGameTypeLostInTime,
kGameTypeInca2,
kGameTypeDynasty,
kGameTypeUrban,
kGameTypePlaytoons,
kGameTypeBambou,
kGameTypeFascination,
kGameTypeGeisha,
kGameTypeAdi2,
kGameTypeAdi4,
kGameTypeAdibou2,
kGameTypeAdibou1
};
enum Features {
kFeaturesNone = 0,
kFeaturesCD = 1 << 0,
kFeaturesEGA = 1 << 1,
kFeaturesAdLib = 1 << 2,
kFeaturesSCNDemo = 1 << 3,
kFeaturesBATDemo = 1 << 4,
kFeatures640x480 = 1 << 5,
kFeatures800x600 = 1 << 6,
kFeaturesTrueColor = 1 << 7
};
enum {
kDebugFuncOp = 1 << 0,
kDebugDrawOp = 1 << 1,
kDebugGobOp = 1 << 2,
kDebugSound = 1 << 3,
kDebugExpression = 1 << 4,
kDebugGameFlow = 1 << 5,
kDebugFileIO = 1 << 6,
kDebugSaveLoad = 1 << 7,
kDebugGraphics = 1 << 8,
kDebugVideo = 1 << 9,
kDebugHotspots = 1 << 10,
kDebugDemo = 1 << 11
};
struct GOBGameDescription;
class GobEngine : public Engine {
private:
GameType _gameType;
int32 _features;
Common::Platform _platform;
GobConsole *_console;
uint32 _pauseStart;
// Engine APIs
virtual Common::Error run();
virtual bool hasFeature(EngineFeature f) const;
virtual void pauseEngineIntern(bool pause);
virtual void syncSoundSettings();
bool initGameParts();
void deinitGameParts();
bool initGraphics();
public:
static const Common::Language _gobToScummVMLang[];
Common::RandomSource _rnd;
Common::Language _language;
uint16 _width;
uint16 _height;
uint8 _mode;
Graphics::PixelFormat _pixelFormat;
Common::String _startStk;
Common::String _startTot;
uint32 _demoIndex;
bool _copyProtection;
bool _noMusic;
Global *_global;
Util *_util;
DataIO *_dataIO;
Game *_game;
Sound *_sound;
Video *_video;
Draw *_draw;
Goblin *_goblin;
Init *_init;
Map *_map;
Mult *_mult;
PalAnim *_palAnim;
Scenery *_scenery;
Inter *_inter;
SaveLoad *_saveLoad;
VideoPlayer *_vidPlayer;
const char *getLangDesc(int16 language) const;
void validateLanguage();
void validateVideoMode(int16 videoMode);
void pauseGame();
Endianness getEndianness() const;
Common::Platform getPlatform() const;
GameType getGameType() const;
bool isCD() const;
bool isEGA() const;
bool hasAdLib() const;
bool isSCNDemo() const;
bool isBATDemo() const;
bool is640x480() const;
bool is800x600() const;
bool isTrueColor() const;
bool isDemo() const;
bool isCurrentTot(const Common::String &tot) const;
void setTrueColor(bool trueColor);
GUI::Debugger *getDebugger() { return _console; }
const Graphics::PixelFormat &getPixelFormat() const;
GobEngine(OSystem *syst);
virtual ~GobEngine();
void initGame(const GOBGameDescription *gd);
};
} // End of namespace Gob
#endif // GOB_GOB_H
|
