aboutsummaryrefslogtreecommitdiff
path: root/engines/access/access.h
blob: a0099402fdd3f8dab5c8c2b1af97682003cac9db (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 ACCESS_ACCESS_H
#define ACCESS_ACCESS_H

#include "common/scummsys.h"
#include "common/system.h"
#include "common/error.h"
#include "common/random.h"
#include "common/util.h"
#include "engines/engine.h"
#include "graphics/surface.h"
#include "access/data.h"
#include "access/debugger.h"
#include "access/events.h"
#include "access/files.h"
#include "access/player.h"
#include "access/room.h"
#include "access/screen.h"
#include "access/scripts.h"
#include "access/sound.h"

/**
 * This is the namespace of the Access engine.
 *
 * Status of this engine: In Development
 *
 * Games using this engine:
 * - Amazon: Guardians of Eden
 */
namespace Access {

#define DEBUG_BASIC 1
#define DEBUG_INTERMEDIATE 2
#define DEBUG_DETAILED 3

enum {
	GType_Amazon = 1,
	GType_MeanStreets = 2
};

enum AccessDebugChannels {
	kDebugPath      = 1 << 0,
	kDebugScripts	= 1 << 1,
	kDebugGraphics	= 1 << 2
};

struct AccessGameDescription;

class AccessEngine : public Engine {
private:
	/**
	 * Handles basic initialisation
	 */
	void initialize();

	/**
	 * Set VGA mode
	 */
	void setVGA();

	void dummyLoop();

	void doEstablish(int v);
protected:
	const AccessGameDescription *_gameDescription;
	Common::RandomSource _randomSource;

	/**
	 * Main handler for showing game rooms
	 */
	void doRoom();

	// Engine APIs
	virtual Common::Error run();
	virtual bool hasFeature(EngineFeature f) const;
protected:
	/**
	 * Play the game
	 */
	virtual void playGame() = 0;
public:
	Debugger *_debugger;
	EventsManager *_events;
	FileManager *_files;
	Player *_player;
	Room *_room;
	Screen *_screen;
	Scripts *_scripts;
	SoundManager *_sound;

	byte *_destIn;
	ASurface _buffer1;
	ASurface _buffer2;
	byte *_objectsTable[100];
	int _establishTable[100];
	bool _establishFlag;
	int _establishMode;
	int _establishGroup;
	int _numAnimTimers;
	Common::Array<TimerEntry> _timers;
	Common::Array<Common::Rect> _newRect;
	Common::Array<Common::Rect> _oldRect;
	Common::Array<ExtraCell> _extraCells;
	int _pCount;
	int _selectCommand;
	bool _normalMouse;
	int _mouseMode;
	int _numImages;
	int _nextImage;

	int _currentManOld;
	byte *_man;
	byte *_man1;
	byte *_inactive;
	byte *_manPal1;
	byte *_music;
	byte *_anim;
	byte *_title;
	int _converseMode;
	int _startInvItem;
	int _startAboutItem;
	int _startTravelItem;
	int _startInvBox;
	int _startAboutBox;
	int _startTravelBox;
	bool _currentCharFlag;
	bool _boxSelect;
	int _charFlag;
	int _scale;
	int _scaleH1, _scaleH2;
	int _scaleN1;
	int _scaleT1;
	int _scaleMaxY;
	int _scaleI;
	int _playFieldHeight;

	// Fields that are included in savegames
	int _conversation;
	int _currentMan;
	uint32 _newTime;
	uint32 _newDate;
	int _intTim[3];
	int _timer[3];
	bool _timerFlag;
	byte _flags[99];
	byte _useItem[23];
	int _guardLoc;
	int _guardFind;
	int _helpLevel;
	int _jasMayaFlag;
	int _moreHelp;
	int _startup;
	bool _flashbackFlag;
	int _manScaleOff;
	bool _riverFlag;
	bool _antOutFlag;
	int _badEnd;
	bool _noHints;
	bool _antFlag;
	bool _allenFlag;
	bool _noSound;
	int inv[85];
	byte _help1[366];
	byte _help2[366];
	byte _help3[366];
	int _travel;
	int _ask;
	int _rScrollRow;
	int _rScrollCol;
	int _rSrcollX;
	int _rScrollY;
	int _rOldRectCount;
	int _rNewRectCount;
	int _rKeyFlag;
	int _mapOffset;
	int _screenVirtX;
public:
	AccessEngine(OSystem *syst, const AccessGameDescription *gameDesc);
	virtual ~AccessEngine();

	uint32 getFeatures() const;
	Common::Language getLanguage() const;
	Common::Platform getPlatform() const;
	uint16 getVersion() const;
	uint32 getGameID() const;
	uint32 getGameFeatures() const;

	int getRandomNumber(int maxNumber);

	void freeAnimationData();

	void loadCells(Common::Array<RoomInfo::CellIdent> &cells);

	/**
	* Clear the cell table
	*/
	void clearCellTable();

	/**
	* Free the cell data
	*/
	void freeCells();

	/**
	 * Free the inactive data
	 */
	void freeInactiveData();

	/**
	 * Free animation data
	 */
	void freeManData();

	void establish(int v);

	void establishCenter(int v);

	void loadPlayField(int fileNum, int subfile);
};

} // End of namespace Access

#endif /* ACCESS_ACCESS_H */