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
|
/* 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 KYRA_KYRA_H
#define KYRA_KYRA_H
#include "engines/engine.h"
#include "common/rect.h"
#include "common/array.h"
#include "common/events.h"
#include "kyra/util.h"
namespace Common {
class InSaveFile;
class OutSaveFile;
} // end of namespace Common
namespace Kyra {
struct GameFlags {
Common::Language lang;
Common::Platform platform;
bool isDemo;
bool useAltShapeHeader; // alternative shape header (uses 2 bytes more, those are unused though)
bool isTalkie;
bool useHiResOverlay;
byte gameID;
};
struct Rect {
int x, y;
int x2, y2;
};
enum {
GI_KYRA1 = 0,
GI_KYRA2 = 1,
GI_KYRA3 = 2
};
struct AudioDataStruct {
const char * const *_fileList;
const int _fileListLen;
const void * const _cdaTracks;
const int _cdaNumTracks;
};
// TODO: this is just the start of makeing the debug output of the kyra engine a bit more useable
// in the future we maybe merge some flags and/or create new ones
enum kDebugLevels {
kDebugLevelScriptFuncs = 1 << 0, // prints debug output of o#_* functions
kDebugLevelScript = 1 << 1, // prints debug output of "ScriptHelper" functions
kDebugLevelSprites = 1 << 2, // prints debug output of "Sprites" functions
kDebugLevelScreen = 1 << 3, // prints debug output of "Screen" functions
kDebugLevelSound = 1 << 4, // prints debug output of "Sound" functions
kDebugLevelAnimator = 1 << 5, // prints debug output of "ScreenAnimator" functions
kDebugLevelMain = 1 << 6, // prints debug output of common "KyraEngine(_v#)" functions && "TextDisplayer" functions
kDebugLevelGUI = 1 << 7, // prints debug output of "KyraEngine*" gui functions
kDebugLevelSequence = 1 << 8, // prints debug output of "SeqPlayer" functions
kDebugLevelMovie = 1 << 9, // prints debug output of movie specific funtions
kDebugLevelTimer = 1 << 10 // prints debug output of "TimerManager" functions
};
enum kMusicDataID {
kMusicIntro = 0,
kMusicIngame,
kMusicFinale
};
class Screen;
class Resource;
class Sound;
class Movie;
class TextDisplayer;
class StaticResource;
class TimerManager;
class ScriptHelper;
class KyraEngine : public Engine {
public:
KyraEngine(OSystem *system, const GameFlags &flags);
virtual ~KyraEngine();
bool quit() const { return _quitFlag; }
uint8 game() const { return _flags.gameID; }
const GameFlags &gameFlags() const { return _flags; }
// access to Kyra specific functionallity
Resource *resource() { return _res; }
virtual Screen *screen() = 0;
TextDisplayer *text() { return _text; }
Sound *sound() { return _sound; }
StaticResource *staticres() { return _staticres; }
TimerManager *timer() { return _timer; }
uint32 tickLength() const { return _tickLength; }
virtual Movie *createWSAMovie() = 0;
Common::RandomSource _rnd;
// config specific
bool speechEnabled();
bool textEnabled();
// quit handling
virtual void quitGame();
// game flag handling
int setGameFlag(int flag);
int queryGameFlag(int flag) const;
int resetGameFlag(int flag);
// sound
virtual void snd_playTheme(int file, int track = 0);
virtual void snd_playSoundEffect(int id);
virtual void snd_playWanderScoreViaMap(int command, int restart);
virtual void snd_playVoiceFile(int id) = 0;
virtual bool snd_voiceIsPlaying();
virtual void snd_stopVoice();
// delay functionallity
virtual void delayUntil(uint32 timestamp, bool updateGameTimers = false, bool update = false, bool isMainLoop = false);
virtual void delay(uint32 millis, bool update = false, bool isMainLoop = false);
virtual void delayWithTicks(int ticks);
protected:
virtual int go() = 0;
virtual int init();
// quit Handling
bool _quitFlag;
// intern
Resource *_res;
Sound *_sound;
TextDisplayer *_text;
StaticResource *_staticres;
TimerManager *_timer;
ScriptHelper *_scriptInterpreter;
// config specific
virtual void registerDefaultSettings();
virtual void readSettings();
virtual void writeSettings();
uint8 _configWalkspeed;
int _configMusic;
bool _configSounds;
uint8 _configVoice;
// game speed
virtual bool skipFlag() const = 0;
virtual void resetSkipFlag(bool removeEvent = true) = 0;
uint16 _tickLength;
uint16 _gameSpeed;
// timer
virtual void setupTimers() = 0;
virtual void setWalkspeed(uint8 speed) = 0;
// detection
GameFlags _flags;
int _lang;
// opcode
virtual void setupOpcodeTable() = 0;
Common::Array<const Opcode*> _opcodes;
// game flags
uint8 _flagsTable[100]; // TODO: check this value
// sound
Common::String _speechFile;
int _curMusicTheme;
int _curSfxFile;
int16 _lastMusicCommand;
const int8 *_trackMap;
int _trackMapSize;
// input
Common::Point getMousePos() const;
void setMousePos(int x, int y);
// pathfinder
virtual int findWay(int x, int y, int toX, int toY, int *moveTable, int moveTableSize);
int findSubPath(int x, int y, int toX, int toY, int *moveTable, int start, int end);
int getFacingFromPointToPoint(int x, int y, int toX, int toY);
int getOppositeFacingDirection(int dir);
void changePosTowardsFacing(int &x, int &y, int facing);
int getMoveTableSize(int *moveTable);
virtual bool lineIsPassable(int x, int y) = 0;
static const int8 _addXPosTable[];
static const int8 _addYPosTable[];
// save/load
virtual uint32 saveGameID() const = 0;
const char *getSavegameFilename(int num);
Common::InSaveFile *openSaveForReading(const char *filename, uint32 &version, char *saveName);
Common::OutSaveFile *openSaveForWriting(const char *filename, const char *saveName) const;
};
} // End of namespace Kyra
#endif
|
