aboutsummaryrefslogtreecommitdiff
path: root/engines/illusions/illusions.h
blob: 8110c686a5582a7216a2e20d9d2b1b6b2e245972 (plain)
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
/* 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 ILLUSIONS_ILLUSIONS_H
#define ILLUSIONS_ILLUSIONS_H

#include "illusions/graphics.h"
#include "audio/mixer.h"
#include "audio/decoders/aiff.h"
#include "common/array.h"
#include "common/events.h"
#include "common/file.h"
#include "common/memstream.h"
#include "common/random.h"
#include "common/str.h"
#include "common/substream.h"
#include "common/system.h"
#include "common/winexe.h"
#include "common/winexe_pe.h"
#include "engines/engine.h"
#include "graphics/surface.h"

namespace Illusions {

char *debugW2I(byte *wstr);

#define ILLUSIONS_SAVEGAME_VERSION 0

class ResourceSystem;
class BaseResourceReader;

struct SurfInfo;

class ActorInstanceList;
struct ActorType;
class BackgroundInstanceList;
class BackgroundResource;
class Camera;
class Control;
class Controls;
class Cursor;
class Dictionary;
struct Fader;
class FramesList;
struct IllusionsGameDescription;
class Input;
class Screen;
class ScreenText;
class ScriptOpcodes;
class ScriptResource;
class ScriptStack;
struct Sequence;
class SoundMan;
class SpecialCode;
class TalkInstanceList;
class ThreadList;
class UpdateFunctions;
class GameState;
class ScreenPaletteBase;

enum {
	kGameIdBBDOU   = 1,
	kGameIdDuckman = 2
};

class IllusionsEngine : public Engine {
public:
	IllusionsEngine(OSystem *syst, const IllusionsGameDescription *gd);
	~IllusionsEngine();
	const Common::String getTargetName() { return _targetName; }
private:
	const IllusionsGameDescription *_gameDescription;
	Graphics::PixelFormat _pixelFormat;
public:

	Common::RandomSource *_random;
	Dictionary *_dict;
	ResourceSystem *_resSys;
	BaseResourceReader *_resReader;
	UpdateFunctions *_updateFunctions;
	GameState *_gameState;

	void updateEvents();

	Screen *_screen;
	ScreenPaletteBase *_screenPalette;
	ScreenText *_screenText;
	Input *_input;
	ActorInstanceList *_actorInstances;
	BackgroundInstanceList *_backgroundInstances;
	Camera *_camera;
	Controls *_controls;
	TalkInstanceList *_talkItems;
	ScriptOpcodes *_scriptOpcodes;
	SpecialCode *_specialCode;
	ThreadList *_threads;
	SoundMan *_soundMan;

	uint32 _nextTempThreadId;
	bool _doScriptThreadInit;
	ScriptStack *_stack;
	ScriptResource *_scriptResource;
	bool _rerunThreads;

	Fader *_fader;

	int _pauseCtr;

	int _resGetCtr;
	uint32 _resGetTime;
	bool _unpauseControlActorFlag;
	uint32 _lastUpdateTime;

	int _resumeFromSavegameRequested;
	int _savegameSlotNum;
	Common::String _savegameDescription;
	uint32 _savegameSceneId;
	uint32 _savegameThreadId;

	uint32 _fontId;
	int _field8;
	uint32 _fieldA;
	uint32 _subtitleDuration;

	WidthHeight _defaultTextDimensions;
	Common::Point _defaultTextPosition;

	int16 _menuChoiceOfs;

	int getGameId() const;

	void runUpdateFunctions();
	int updateActors(uint flags);
	int updateSequences(uint flags);
	int updateGraphics(uint flags);
	int updateSoundMan(uint flags);
	int updateSprites(uint flags);

	uint32 getElapsedUpdateTime();
	Common::Point *getObjectActorPositionPtr(uint32 objectId);
	int getRandom(int max);
	int convertPanXCoord(int16 x);
	bool calcPointDirection(Common::Point &srcPt, Common::Point &dstPt, uint &facing);
	bool isSoundActive();

	virtual void updateFader() {};
	virtual void clearFader() {};
	virtual void pauseFader() {};
	virtual void unpauseFader() {};
	virtual bool isVideoPlaying() { return false; }

	void setCurrFontId(uint32 fontId);
	bool checkActiveTalkThreads();
	void setTextDuration(int kind, uint32 duration);
	uint32 clipTextDuration(uint32 duration);
	void getDefaultTextDimensions(WidthHeight &dimensions);
	void setDefaultTextDimensions(WidthHeight &dimensions);
	void getDefaultTextPosition(Common::Point &position);
	void setDefaultTextPosition(Common::Point &position);

	uint16 getSubtitleDuration();
	void setSubtitleDuration(uint16 duration);

	FramesList *findActorSequenceFrames(Sequence *sequence);

	virtual void setDefaultTextCoords() = 0;
	virtual void loadSpecialCode(uint32 resId) = 0;
	virtual void unloadSpecialCode(uint32 resId) = 0;
	virtual void notifyThreadId(uint32 &threadId) = 0;
	virtual bool testMainActorFastWalk(Control *control) = 0;
	virtual bool testMainActorCollision(Control *control) = 0;
	virtual Control *getObjectControl(uint32 objectId) = 0;
	virtual Common::Point getNamedPointPosition(uint32 namedPointId) = 0;
	virtual uint32 getPriorityFromBase(int16 priority) = 0;
	virtual uint32 getPrevScene() = 0;
	virtual uint32 getCurrentScene() = 0;
	virtual bool isCursorObject(uint32 actorTypeId, uint32 objectId) = 0;
	virtual void setCursorControlRoutine(Control *control) = 0;
	virtual void placeCursorControl(Control *control, uint32 sequenceId) = 0;
	virtual void setCursorControl(Control *control) = 0;
	virtual void showCursor() = 0;
	virtual void hideCursor() = 0;
	virtual void startScriptThreadSimple(uint32 threadId, uint32 callingThreadId) = 0;
	virtual uint32 startTempScriptThread(byte *scriptCodeIp, uint32 callingThreadId,
		uint32 value8, uint32 valueC, uint32 value10) = 0;

	// Savegame API

	enum kReadSaveHeaderError {
		kRSHENoError = 0,
		kRSHEInvalidType = 1,
		kRSHEInvalidVersion = 2,
		kRSHEIoError = 3
	};

	struct SaveHeader {
		Common::String description;
		uint32 version;
		byte gameID;
		uint32 flags;
		uint32 saveDate;
		uint32 saveTime;
		uint32 playTime;
		Graphics::Surface *thumbnail;
	};

	bool _isSaveAllowed;

	bool canLoadGameStateCurrently() { return _isSaveAllowed; }
	bool canSaveGameStateCurrently() { return _isSaveAllowed; }
	Common::Error loadGameState(int slot);
	Common::Error saveGameState(int slot, const Common::String &description);
	Common::Error removeGameState(int slot);
	bool savegame(const char *filename, const char *description);
	bool loadgame(const char *filename);
	const char *getSavegameFilename(int num);
	bool existsSavegame(int num);
	static Common::String getSavegameFilename(const Common::String &target, int num);
	static kReadSaveHeaderError readSaveHeader(Common::SeekableReadStream *in, SaveHeader &header, bool skipThumbnail = true);

};

} // End of namespace Illusions

#endif // ILLUSIONS_ILLUSIONS_H