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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
/* 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 RIVEN_CARD_H
#define RIVEN_CARD_H
#include "mohawk/riven_scripts.h"
#include "mohawk/riven_sound.h"
#include "common/rect.h"
#include "common/system.h"
namespace Mohawk {
class RivenHotspot;
struct MLSTRecord;
/**
* A game view
*
* The names Card and Stack are legacy from the HyperCard engine used in
* the original mac version of Myst.
*
* Cards contain hotspots, scripts, and resource lists.
*/
class RivenCard {
public:
RivenCard(MohawkEngine_Riven *vm, uint16 id);
~RivenCard();
/**
* An image that can be drawn in this card
*/
struct Picture {
uint16 index;
uint16 id;
Common::Rect rect;
};
/** Initialization routine used to draw a card for the first time or to refresh it */
void enter(bool unkMovies);
/** Run the card's leave scripts */
void leave();
/** Run one of the card's scripts */
void runScript(uint16 scriptType);
/** Get the id of the card in the stack */
uint16 getId() const;
/** Get the card's picture with the specified index */
Picture getPicture(uint16 index) const;
/** Draw one of the card's pictures synchronously or asynchronously */
void drawPicture(uint16 index, bool queue = false);
/** Play the card's ambient sounds with the specified index */
void playSound(uint16 index, bool queue = false);
/** Get the card's sound description with the specified index */
SLSTRecord getSound(uint16 index) const;
/** Replace an ambient sound list with another one */
void overrideSound(uint16 index, uint16 withIndex);
/** Play the card's movie with the specified index */
void playMovie(uint16 index, bool queue = false);
/** Get the card's movie description with the specified index */
MLSTRecord getMovie(uint16 index) const;
/** Draw borders for all the hotspots in the card */
void drawHotspotRects();
/** Enable the zip hotspots if they match to already visited locations */
void initializeZipMode();
/** Get the hotspot containing the specified point */
RivenHotspot *getHotspotContainingPoint(const Common::Point &point) const;
/** Get the hotspot with the specified name */
RivenHotspot *getHotspotByName(const Common::String &name) const;
/** Get the hotspot with the specified BLST id */
RivenHotspot *getHotspotByBlstId(const uint16 blstId) const;
/** Get the currently hovered hotspot if any */
RivenHotspot *getCurHotspot() const;
/** Get all the hotspots in the card. To be used for debugging features only */
Common::Array<RivenHotspot *> getHotspots() const;
/** Activate a hotspot using a hotspot enable list entry */
void activateHotspotEnableRecord(uint16 index);
/** Activate a water effect list entry */
void activateWaterEffect(uint16 index);
/** Handle a mouse down event */
RivenScriptPtr onMouseDown(const Common::Point &mouse);
/** Handle a mouse up event */
RivenScriptPtr onMouseUp(const Common::Point &mouse);
/** Handle a mouse move event */
RivenScriptPtr onMouseMove(const Common::Point &mouse);
/** General frame update handler */
RivenScriptPtr onFrame();
/** Frame update handler for the mouse cursor */
RivenScriptPtr onMouseUpdate();
/** Frame update handler for mouse dragging */
RivenScriptPtr onMouseDragUpdate();
/** Write all of the card's data to standard output */
void dump() const;
private:
void loadCardResource(uint16 id);
void loadHotspots(uint16 id);
void loadCardPictureList(uint16 id);
void loadCardSoundList(uint16 id);
void loadCardMovieList(uint16 id);
void loadCardHotspotEnableList(uint16 id);
void loadCardWaterEffectList(uint16 id);
void setCurrentCardVariable();
RivenScriptPtr getScript(uint16 scriptType) const;
void defaultLoadScript();
void updateMouseCursor();
struct HotspotEnableRecord {
uint16 index;
uint16 enabled;
uint16 hotspotId;
};
struct WaterEffectRecord {
uint16 index;
uint16 sfxeId;
uint16 u0;
};
MohawkEngine_Riven *_vm;
// General card data
uint16 _id;
int16 _name;
uint16 _zipModePlace;
RivenScriptList _scripts;
Common::Array<RivenHotspot *> _hotspots;
RivenHotspot *_hoveredHotspot;
RivenHotspot *_pressedHotspot;
// Resource lists
Common::Array<Picture> _pictureList;
Common::Array<SLSTRecord> _soundList;
Common::Array<MLSTRecord> _movieList;
Common::Array<HotspotEnableRecord> _hotspotEnableList;
Common::Array<WaterEffectRecord> _waterEffectList;
};
struct MLSTRecord {
uint16 index;
uint16 movieID;
uint16 playbackSlot;
uint16 left;
uint16 top;
uint16 lowBoundTime;
uint16 startTime;
uint16 highBoundTime;
uint16 loop;
uint16 volume;
uint16 rate;
};
/**
* A Card Hotspot
*
* Hotspots are named rectangular areas of the view.
* Hotspots can be interactive through their scripts.
*/
class RivenHotspot {
public:
RivenHotspot(MohawkEngine_Riven *vm, Common::ReadStream *stream);
/** Get the one of the hotspot's scripts */
RivenScriptPtr getScript(uint16 scriptType) const;
/** Enable or disable the hotspot */
void enable(bool e);
/** Can the hotspot be interacted with? */
bool isEnabled() const;
/** Is the hotspot's purpose to zip to another card */
bool isZip() const;
/** Get the hotspot'a rect in Card coordinates */
Common::Rect getRect() const;
/** Does the hotspot contain the specified point? */
bool containsPoint(const Common::Point &point) const;
/** Override the hotspot's default rect */
void setRect(const Common::Rect &rect);
/** Get the default mouse cursor id to be used when hovering the hostpot */
uint16 getMouseCursor() const;
/** Get the hotspot's name from the current stack's name list */
Common::String getName() const;
/** Get the hotspot's name id */
int16 getNameId() const;
/** Get the hotspot's order in the view */
uint16 getIndex() const;
/** Get the hotspot's enable list id */
uint16 getBlstId() const;
/** Write all of the hotspot's data to standard output */
void dump() const;
private:
enum {
kFlagZip = 1,
kFlagEnabled = 2
};
void loadFromStream(Common::ReadStream *stream);
MohawkEngine_Riven *_vm;
uint16 _blstID;
int16 _nameResource;
Common::Rect _rect;
uint16 _u0;
uint16 _mouseCursor;
uint16 _index;
int16 _u1;
uint16 _flags;
RivenScriptList _scripts;
};
} // End of namespace Mohawk
#endif
|
