aboutsummaryrefslogtreecommitdiff
path: root/engines/adl/adl.h
blob: 4c8180eeab72a2e1d1cd2e83cb97cc2ef9bd9ecd (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
/* 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 ADL_ADL_H
#define ADL_ADL_H

#include "common/random.h"
#include "common/rect.h"

#include "engines/engine.h"

#include "gui/debugger.h"

namespace Common {
class ReadStream;
class SeekableReadStream;
}

namespace Adl {

class Display;
class Parser;
class Console;
struct AdlGameDescription;

enum GameType {
	kGameTypeNone = 0,
	kGameTypeHires1
};

struct StringOffset {
	int stringIdx;
	uint offset;
};

// Messages used outside of scripts
enum EngineMessage {
	IDI_MSG_CANT_GO_THERE,
	IDI_MSG_DONT_UNDERSTAND,
	IDI_MSG_ITEM_DOESNT_MOVE,
	IDI_MSG_ITEM_NOT_HERE,
	IDI_MSG_THANKS_FOR_PLAYING
};

// Strings embedded in the executable
enum EngineString {
	IDI_STR_ENTER_COMMAND,
	IDI_STR_VERB_ERROR,
	IDI_STR_NOUN_ERROR,
	IDI_STR_PLAY_AGAIN,

	IDI_STR_TOTAL
};

struct Room {
	byte description;
	byte connections[6];
	byte field8;
	byte picture;
};

struct Picture {
	byte block;
	uint16 offset;
};

struct Command {
	byte room;
	byte verb, noun;
	byte numCond, numAct;
	Common::Array<byte> script;
};

enum {
	IDI_ITEM_NOT_MOVED,
	IDI_ITEM_MOVED,
	IDI_ITEM_DOESNT_MOVE
};

#define IDI_NONE 0xfe

struct Item {
	byte noun;
	byte room;
	byte picture;
	bool isDrawing;
	Common::Point position;
	int state;
	byte description;
	Common::Array<byte> roomPictures;
};

typedef Common::List<Command> Commands;

class AdlEngine : public Engine {
public:
	AdlEngine(OSystem *syst, const AdlGameDescription *gd);
	virtual ~AdlEngine();

	const AdlGameDescription *_gameDescription;
	uint32 getFeatures() const;
	const char *getGameId() const;

	static AdlEngine *create(GameType type, OSystem *syst, const AdlGameDescription *gd);

	Common::Error run();
	virtual Common::String getEngineString(int str);

protected:
	virtual void runGame() = 0;
	virtual uint getEngineMessage(EngineMessage msg) = 0;
	Common::String readString(Common::ReadStream &stream, byte until = 0);
	void printStrings(Common::SeekableReadStream &stream, int count = 1);
	virtual void printMessage(uint idx, bool wait = true);
	void wordWrap(Common::String &str);
	void readCommands(Common::ReadStream &stream, Commands &commands);
	bool checkCommand(const Command &command, byte verb, byte noun);
	bool doOneCommand(const Commands &commands, byte verb, byte noun);
	void doAllCommands(const Commands &commands, byte verb, byte noun);
	void doActions(const Command &command, byte noun, byte offset);
	void clearScreen();
	void takeItem(byte noun);
	void dropItem(byte noun);

	Display *_display;
	Parser *_parser;

	Common::Array<Common::String> _strings;
	Common::Array<Common::String> _messages;
	Common::Array<Picture> _pictures;
	Common::Array<Item> _inventory;
	Common::Array<Common::Point> _itemOffsets;
	Common::Array<Common::Array<byte> > _drawings;
	Commands _roomCommands;
	Commands _globalCommands;

	// Game state
	Common::Array<Room> _rooms;
	byte _room;
	uint16 _steps;
	Common::Array<byte> _variables;
	bool _isDark;

private:
	void printEngineMessage(EngineMessage);
};

AdlEngine *HiRes1Engine__create(OSystem *syst, const AdlGameDescription *gd);

} // End of namespace Adl

#endif