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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
|
/* 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.
*
*/
#include "mohawk/riven_card.h"
#include "mohawk/cursors.h"
#include "mohawk/riven_graphics.h"
#include "mohawk/riven_stack.h"
#include "mohawk/riven_video.h"
#include "mohawk/resource.h"
#include "mohawk/riven.h"
#include "common/memstream.h"
namespace Mohawk {
RivenCard::RivenCard(MohawkEngine_Riven *vm, uint16 id) :
_vm(vm),
_id(id),
_hoveredHotspot(nullptr),
_pressedHotspot(nullptr) {
loadCardResource(id);
loadHotspots(id);
loadCardPictureList(id);
loadCardSoundList(id);
loadCardMovieList(id);
loadCardHotspotEnableList(id);
loadCardWaterEffectList(id);
applyPatches(id);
}
RivenCard::~RivenCard() {
for (uint i = 0; i < _hotspots.size(); i++) {
delete _hotspots[i];
}
_vm->_gfx->clearWaterEffects();
_vm->_gfx->clearFliesEffect();
_vm->_video->closeVideos();
}
void RivenCard::loadCardResource(uint16 id) {
Common::SeekableReadStream *inStream = _vm->getResource(ID_CARD, id);
_name = inStream->readSint16BE();
_zipModePlace = inStream->readUint16BE();
_scripts = _vm->_scriptMan->readScripts(inStream);
delete inStream;
}
void RivenCard::applyPatches(uint16 id) {
uint32 globalId = _vm->getStack()->getCardGlobalId(id);
// Apply properties patches
// On Jungle Island on the back side of the "beetle" gate, the forward hotspot
// is always enabled, preventing keyboard navigation from automatically opening
// the gate.
// We patch the card so that the forward opcode is enabled only when the gate is open.
//
// New hotspot enable entries:
// == Hotspot enable 5 ==
// hotspotId: 3
// enabled: 1
//
// == Hotspot enable 6 ==
// hotspotId: 3
// enabled: 0
//
// Additional load script fragment:
// switch (jgate) {
// case 0:
// activateBLST(6);
// break;
// case 1:
// activateBLST(5);
// break;
if (globalId == 0x8EB7) {
HotspotEnableRecord forwardEnabled;
forwardEnabled.index = _hotspotEnableList.back().index + 1;
forwardEnabled.hotspotId = 3;
forwardEnabled.enabled = 1;
_hotspotEnableList.push_back(forwardEnabled);
HotspotEnableRecord forwardDisabled;
forwardDisabled.index = _hotspotEnableList.back().index + 1;
forwardDisabled.hotspotId = 3;
forwardDisabled.enabled = 0;
_hotspotEnableList.push_back(forwardDisabled);
uint16 jGateVariable = _vm->getStack()->getIdFromName(kVariableNames, "jgate");
uint16 patchData[] = {
1, // Command count in script
kRivenCommandSwitch,
2, // Unused
jGateVariable,
2, // Branches count
0, // jgate == 0 branch (gate closed)
1, // Command count in sub-script
kRivenCommandActivateBLST,
1, // Argument count
forwardDisabled.index,
1, // jgate == 1 branch (gate open)
1, // Command count in sub-script
kRivenCommandActivateBLST,
1, // Argument count
forwardEnabled.index
};
// Script data is expected to be in big endian
for (uint i = 0; i < ARRAYSIZE(patchData); i++) {
patchData[i] = TO_BE_16(patchData[i]);
}
Common::MemoryReadStream patchStream((const byte *)(patchData), ARRAYSIZE(patchData) * sizeof(uint16));
RivenScriptPtr patchScript = _vm->_scriptMan->readScript(&patchStream);
// Append the patch to the existing script
RivenScriptPtr loadScript = getScript(kCardLoadScript);
loadScript += patchScript;
debugC(kRivenDebugPatches, "Applied fix always enabled forward hotspot in card %x", globalId);
}
// Apply script patches
for (uint i = 0; i < _scripts.size(); i++) {
_scripts[i].script->applyCardPatches(_vm, globalId, _scripts[i].type, 0xFFFF);
}
}
void RivenCard::enter(bool unkMovies) {
setCurrentCardVariable();
_vm->_activatedPLST = false;
_vm->_activatedSLST = false;
_vm->_gfx->beginScreenUpdate();
runScript(kCardLoadScript);
defaultLoadScript();
initializeZipMode();
_vm->_gfx->applyScreenUpdate(true);
if (_vm->_showHotspots) {
drawHotspotRects();
}
runScript(kCardEnterScript);
}
void RivenCard::initializeZipMode() {
if (_zipModePlace) {
_vm->addZipVisitedCard(_id, _name);
}
// Check if a zip mode hotspot is enabled by checking the name/id against the ZIPS records.
for (uint32 i = 0; i < _hotspots.size(); i++) {
if (_hotspots[i]->isZip()) {
if (_vm->_vars["azip"] != 0) {
// Check if a zip mode hotspot is enabled by checking the name/id against the ZIPS records.
Common::String hotspotName = _hotspots[i]->getName();
bool visited = _vm->isZipVisitedCard(hotspotName);
_hotspots[i]->enable(visited);
} else // Disable the hotspot if zip mode is disabled
_hotspots[i]->enable(false);
}
}
}
RivenScriptPtr RivenCard::getScript(uint16 scriptType) const {
for (uint16 i = 0; i < _scripts.size(); i++)
if (_scripts[i].type == scriptType) {
return _scripts[i].script;
}
return RivenScriptPtr();
}
void RivenCard::runScript(uint16 scriptType) {
RivenScriptPtr script = getScript(scriptType);
_vm->_scriptMan->runScript(script, false);
}
uint16 RivenCard::getId() const {
return _id;
}
void RivenCard::defaultLoadScript() {
// Activate the first picture list if none have been activated
if (!_vm->_activatedPLST)
drawPicture(1);
// Activate the first sound list if none have been activated
if (!_vm->_activatedSLST)
playSound(1);
}
void RivenCard::loadCardPictureList(uint16 id) {
Common::SeekableReadStream* plst = _vm->getResource(ID_PLST, id);
uint16 recordCount = plst->readUint16BE();
_pictureList.resize(recordCount);
for (uint16 i = 0; i < recordCount; i++) {
Picture &picture = _pictureList[i];
picture.index = plst->readUint16BE();
picture.id = plst->readUint16BE();
picture.rect.left = plst->readUint16BE();
picture.rect.top = plst->readUint16BE();
picture.rect.right = plst->readUint16BE();
picture.rect.bottom = plst->readUint16BE();
}
delete plst;
}
void RivenCard::drawPicture(uint16 index, bool queue) {
if (index > 0 && index <= _pictureList.size()) {
RivenScriptPtr script = _vm->_scriptMan->createScriptFromData(1, kRivenCommandActivatePLST, 1, index);
_vm->_scriptMan->runScript(script, queue);
}
}
RivenCard::Picture RivenCard::getPicture(uint16 index) const {
for (uint16 i = 0; i < _pictureList.size(); i++) {
if (_pictureList[i].index == index) {
return _pictureList[i];
}
}
error("Could not find picture %d in card %d", index, _id);
}
void RivenCard::loadCardSoundList(uint16 id) {
Common::SeekableReadStream *slstStream = _vm->getResource(ID_SLST, id);
uint16 recordCount = slstStream->readUint16BE();
_soundList.resize(recordCount);
for (uint16 i = 0; i < recordCount; i++) {
SLSTRecord &slstRecord = _soundList[i];
slstRecord.index = slstStream->readUint16BE();
uint16 soundCount = slstStream->readUint16BE();
slstRecord.soundIds.resize(soundCount);
for (uint16 j = 0; j < soundCount; j++)
slstRecord.soundIds[j] = slstStream->readUint16BE();
slstRecord.fadeFlags = slstStream->readUint16BE();
slstRecord.loop = slstStream->readUint16BE();
slstRecord.globalVolume = slstStream->readUint16BE();
slstRecord.u0 = slstStream->readUint16BE(); // Unknown
if (slstRecord.u0 > 1)
warning("slstRecord.u0: %d non-boolean", slstRecord.u0);
slstRecord.suspend = slstStream->readUint16BE();
if (slstRecord.suspend != 0)
warning("slstRecord.suspend: %d non-zero", slstRecord.suspend);
slstRecord.volumes.resize(soundCount);
slstRecord.balances.resize(soundCount);
slstRecord.u2.resize(soundCount);
for (uint16 j = 0; j < soundCount; j++)
slstRecord.volumes[j] = slstStream->readUint16BE();
for (uint16 j = 0; j < soundCount; j++)
slstRecord.balances[j] = slstStream->readSint16BE(); // negative = left, 0 = center, positive = right
for (uint16 j = 0; j < soundCount; j++) {
slstRecord.u2[j] = slstStream->readUint16BE(); // Unknown
if (slstRecord.u2[j] != 255 && slstRecord.u2[j] != 256)
warning("slstRecord.u2[%d]: %d not 255 or 256", j, slstRecord.u2[j]);
}
}
delete slstStream;
}
void RivenCard::playSound(uint16 index, bool queue) {
if (index > 0 && index <= _soundList.size()) {
RivenScriptPtr script = _vm->_scriptMan->createScriptFromData(1, kRivenCommandActivateSLST, 1, index);
_vm->_scriptMan->runScript(script, queue);
}
}
SLSTRecord RivenCard::getSound(uint16 index) const {
for (uint16 i = 0; i < _soundList.size(); i++) {
if (_soundList[i].index == index) {
return _soundList[i];
}
}
error("Could not find sound %d in card %d", index, _id);
}
void RivenCard::overrideSound(uint16 index, uint16 withIndex) {
_soundList[index].soundIds = _soundList[withIndex].soundIds;
}
void RivenCard::loadHotspots(uint16 id) {
Common::SeekableReadStream *inStream = _vm->getResource(ID_HSPT, id);
uint16 hotspotCount = inStream->readUint16BE();
_hotspots.resize(hotspotCount);
uint32 globalId = _vm->getStack()->getCardGlobalId(id);
for (uint16 i = 0; i < hotspotCount; i++) {
_hotspots[i] = new RivenHotspot(_vm, inStream);
_hotspots[i]->applyPropertiesPatches(globalId);
_hotspots[i]->applyScriptPatches(globalId);
}
delete inStream;
}
void RivenCard::drawHotspotRects() {
for (uint16 i = 0; i < _hotspots.size(); i++)
_vm->_gfx->drawRect(_hotspots[i]->getRect(), _hotspots[i]->isEnabled());
}
RivenHotspot *RivenCard::getHotspotContainingPoint(const Common::Point &point) const {
RivenHotspot *hotspot = nullptr;
for (uint16 i = 0; i < _hotspots.size(); i++)
if (_hotspots[i]->isEnabled() && _hotspots[i]->containsPoint(point)) {
hotspot = _hotspots[i];
}
return hotspot;
}
Common::Array<RivenHotspot *> RivenCard::getHotspots() const {
return _hotspots;
}
RivenHotspot *RivenCard::getHotspotByName(const Common::String &name, bool optional) const {
int16 nameId = _vm->getStack()->getIdFromName(kHotspotNames, name);
for (uint i = 0; i < _hotspots.size(); i++) {
if (_hotspots[i]->getNameId() == nameId && nameId != -1) {
return _hotspots[i];
}
}
if (optional) {
return nullptr;
} else {
error("Card %d does not have an hotspot named %s", _id, name.c_str());
}
}
RivenHotspot *RivenCard::getHotspotByBlstId(const uint16 blstId) const {
for (uint i = 0; i < _hotspots.size(); i++) {
if (_hotspots[i]->getBlstId() == blstId) {
return _hotspots[i];
}
}
return nullptr;
}
void RivenCard::loadCardHotspotEnableList(uint16 id) {
Common::SeekableReadStream *blst = _vm->getResource(ID_BLST, id);
uint16 recordCount = blst->readUint16BE();
_hotspotEnableList.resize(recordCount);
for (uint16 i = 0; i < recordCount; i++) {
HotspotEnableRecord &record = _hotspotEnableList[i];
record.index = blst->readUint16BE();
record.enabled = blst->readUint16BE();
record.hotspotId = blst->readUint16BE();
}
delete blst;
}
void RivenCard::activateHotspotEnableRecord(uint16 index) {
for (uint16 i = 0; i < _hotspotEnableList.size(); i++) {
const HotspotEnableRecord &record = _hotspotEnableList[i];
if (record.index == index) {
RivenHotspot *hotspot = getHotspotByBlstId(record.hotspotId);
hotspot->enable(record.enabled == 1);
break;
}
}
}
void RivenCard::loadCardWaterEffectList(uint16 id) {
Common::SeekableReadStream *flst = _vm->getResource(ID_FLST, id);
uint16 recordCount = flst->readUint16BE();
_waterEffectList.resize(recordCount);
for (uint16 i = 0; i < recordCount; i++) {
WaterEffectRecord &record = _waterEffectList[i];
record.index = flst->readUint16BE();
record.sfxeId = flst->readUint16BE();
record.u0 = flst->readUint16BE();
if (record.u0 != 0) {
warning("FLST u0 non-zero");
}
}
delete flst;
}
void RivenCard::activateWaterEffect(uint16 index) {
for (uint16 i = 0; i < _waterEffectList.size(); i++) {
const WaterEffectRecord &record = _waterEffectList[i];
if (record.index == index) {
_vm->_gfx->scheduleWaterEffect(record.sfxeId);
break;
}
}
}
RivenHotspot *RivenCard::getCurHotspot() const {
return _hoveredHotspot;
}
RivenScriptPtr RivenCard::onMouseDown(const Common::Point &mouse) {
RivenScriptPtr script = onMouseMove(mouse);
_pressedHotspot = _hoveredHotspot;
if (_pressedHotspot) {
script += _pressedHotspot->getScript(kMouseDownScript);
}
return script;
}
RivenScriptPtr RivenCard::onMouseUp(const Common::Point &mouse) {
RivenScriptPtr script = onMouseMove(mouse);
if (_pressedHotspot && _pressedHotspot == _hoveredHotspot) {
script += _pressedHotspot->getScript(kMouseUpScript);
}
_pressedHotspot = nullptr;
return script;
}
RivenScriptPtr RivenCard::onMouseMove(const Common::Point &mouse) {
RivenHotspot *hotspot = getHotspotContainingPoint(mouse);
RivenScriptPtr script = RivenScriptPtr(new RivenScript());
// Detect hotspot exit
if (_hoveredHotspot && (!hotspot || hotspot != _hoveredHotspot)) {
script += _hoveredHotspot->getScript(kMouseLeaveScript);
}
// Detect hotspot entry
if (hotspot && hotspot != _hoveredHotspot) {
_hoveredHotspot = hotspot;
script += _hoveredHotspot->getScript(kMouseEnterScript);
}
if (!hotspot) {
_hoveredHotspot = nullptr;
}
return script;
}
RivenScriptPtr RivenCard::onMouseDragUpdate() {
RivenScriptPtr script;
if (_pressedHotspot) {
script = _pressedHotspot->getScript(kMouseDragScript);
}
return script;
}
RivenScriptPtr RivenCard::onFrame() {
return getScript(kCardFrameScript);
}
RivenScriptPtr RivenCard::onMouseUpdate() {
RivenScriptPtr script;
if (_hoveredHotspot) {
script = _hoveredHotspot->getScript(kMouseInsideScript);
}
if (!script || script->empty()) {
updateMouseCursor();
}
return script;
}
void RivenCard::updateMouseCursor() {
uint16 cursor;
if (_hoveredHotspot) {
cursor = _hoveredHotspot->getMouseCursor();
} else {
cursor = kRivenMainCursor;
}
_vm->_cursor->setCursor(cursor);
}
void RivenCard::leave() {
RivenScriptPtr script(new RivenScript());
if (_pressedHotspot) {
script += _pressedHotspot->getScript(kMouseUpScript);
}
if (_hoveredHotspot) {
script += _hoveredHotspot->getScript(kMouseLeaveScript);
}
script += getScript(kCardLeaveScript);
_vm->_scriptMan->runScript(script, false);
}
void RivenCard::setCurrentCardVariable() {
_vm->_vars["currentcardid"] = _id;
}
void RivenCard::dump() const {
debug("== Card ==");
debug("id: %d", _id);
if (_name >= 0) {
debug("name: %s", _vm->getStack()->getName(kCardNames, _name).c_str());
} else {
debug("name: [no name]");
}
debug("zipModePlace: %d", _zipModePlace);
debug("globalId: %x", _vm->getStack()->getCardGlobalId(_id));
debugN("\n");
for (uint i = 0; i < _scripts.size(); i++) {
debug("== Script %d ==", i);
debug("type: %s", RivenScript::getTypeName(_scripts[i].type));
_scripts[i].script->dumpScript(0);
debugN("\n");
}
for (uint i = 0; i < _hotspots.size(); i++) {
debug("== Hotspot %d ==", i);
_hotspots[i]->dump();
}
for (uint i = 0; i < _pictureList.size(); i++) {
const Common::Rect &rect = _pictureList[i].rect;
debug("== Picture %d ==", _pictureList[i].index);
debug("pictureId: %d", _pictureList[i].id);
debug("rect: (%d, %d, %d, %d)", rect.left, rect.top, rect.right, rect.bottom);
debugN("\n");
}
for (uint i = 0; i < _waterEffectList.size(); i++) {
debug("== Effect %d ==", _waterEffectList[i].index);
debug("sfxeId: %d", _waterEffectList[i].sfxeId);
debug("u0: %d", _waterEffectList[i].u0);
debugN("\n");
}
for (uint i = 0; i < _hotspotEnableList.size(); i++) {
debug("== Hotspot enable %d ==", _hotspotEnableList[i].index);
debug("hotspotId: %d", _hotspotEnableList[i].hotspotId);
debug("enabled: %d", _hotspotEnableList[i].enabled);
debugN("\n");
}
for (uint i = 0; i < _soundList.size(); i++) {
debug("== Ambient sound list %d ==", _soundList[i].index);
debug("globalVolume: %d", _soundList[i].globalVolume);
debug("fadeFlags: %d", _soundList[i].fadeFlags);
debug("loop: %d", _soundList[i].loop);
debug("suspend: %d", _soundList[i].suspend);
debug("u0: %d", _soundList[i].u0);
for (uint j = 0; j < _soundList[i].soundIds.size(); j++) {
debug("sound[%d].id: %d", j, _soundList[i].soundIds[j]);
debug("sound[%d].volume: %d", j, _soundList[i].volumes[j]);
debug("sound[%d].balance: %d", j, _soundList[i].balances[j]);
debug("sound[%d].u2: %d", j, _soundList[i].u2[j]);
}
debugN("\n");
}
for (uint i = 0; i < _movieList.size(); i++) {
debug("== Movie %d ==", _movieList[i].index);
debug("movieID: %d", _movieList[i].movieID);
debug("playbackSlot: %d", _movieList[i].playbackSlot);
debug("left: %d", _movieList[i].left);
debug("top: %d", _movieList[i].top);
debug("lowBoundTime: %d", _movieList[i].lowBoundTime);
debug("startTime: %d", _movieList[i].startTime);
debug("highBoundTime: %d", _movieList[i].highBoundTime);
debug("loop: %d", _movieList[i].loop);
debug("volume: %d", _movieList[i].volume);
debug("rate: %d", _movieList[i].rate);
debugN("\n");
}
}
void RivenCard::loadCardMovieList(uint16 id) {
Common::SeekableReadStream *mlstStream = _vm->getResource(ID_MLST, id);
uint16 recordCount = mlstStream->readUint16BE();
_movieList.resize(recordCount);
for (uint16 i = 0; i < recordCount; i++) {
MLSTRecord &mlstRecord = _movieList[i];
mlstRecord.index = mlstStream->readUint16BE();
mlstRecord.movieID = mlstStream->readUint16BE();
mlstRecord.playbackSlot = mlstStream->readUint16BE();
mlstRecord.left = mlstStream->readUint16BE();
mlstRecord.top = mlstStream->readUint16BE();
mlstRecord.lowBoundTime = mlstStream->readUint16BE();
mlstRecord.startTime = mlstStream->readUint16BE();
mlstRecord.highBoundTime = mlstStream->readUint16BE();
mlstRecord.loop = mlstStream->readUint16BE();
mlstRecord.volume = mlstStream->readUint16BE();
mlstRecord.rate = mlstStream->readUint16BE();
if (mlstRecord.lowBoundTime != 0)
warning("lowBoundTime in MLST not 0");
if (mlstRecord.startTime != 0)
warning("startTime in MLST not 0");
if (mlstRecord.highBoundTime != 0xFFFF)
warning("highBoundTime in MLST not 0xFFFF");
if (mlstRecord.rate != 1)
warning("mlstRecord.rate not 1");
}
delete mlstStream;
}
MLSTRecord RivenCard::getMovie(uint16 index) const {
for (uint16 i = 0; i < _movieList.size(); i++) {
if (_movieList[i].index == index) {
return _movieList[i];
}
}
error("Could not find movie %d in card %d", index, _id);
}
void RivenCard::playMovie(uint16 index, bool queue) {
if (index > 0 && index <= _movieList.size()) {
RivenScriptPtr script = _vm->_scriptMan->createScriptFromData(1, kRivenCommandActivateMLSTAndPlay, 1, index);
_vm->_scriptMan->runScript(script, queue);
}
}
RivenScriptPtr RivenCard::onKeyAction(RivenKeyAction keyAction) {
RivenHotspot *directionHotspot = nullptr;
switch (keyAction) {
case kKeyActionMoveForward:
directionHotspot = findEnabledHotspotByName(17,
"forward", "forward1", "forward2", "forward3",
"opendoor", "openhatch", "opentrap", "opengate", "opengrate",
"open", "door", "drop", "go", "enterprison", "exit",
"forwardleft", "forwardright"
);
break;
case kKeyActionMoveForwardLeft:
directionHotspot = findEnabledHotspotByName(1, "forwardleft");
break;
case kKeyActionMoveForwardRight:
directionHotspot = findEnabledHotspotByName(1, "forwardright");
break;
case kKeyActionMoveLeft:
directionHotspot = findEnabledHotspotByName(3, "left", "afl", "prevpage");
break;
case kKeyActionMoveRight:
directionHotspot = findEnabledHotspotByName(3, "right", "afr", "nextpage");
break;
case kKeyActionMoveBack:
directionHotspot = findEnabledHotspotByName(1, "back");
break;
case kKeyActionLookUp:
directionHotspot = findEnabledHotspotByName(1, "up");
break;
case kKeyActionLookDown:
directionHotspot = findEnabledHotspotByName(1, "down");
break;
default:
break;
}
if (!directionHotspot) {
return RivenScriptPtr(new RivenScript());
}
_hoveredHotspot = directionHotspot;
RivenScriptPtr clickScript = directionHotspot->getScript(kMouseDownScript);
if (!clickScript || clickScript->empty()) {
clickScript = directionHotspot->getScript(kMouseUpScript);
}
if (!clickScript || clickScript->empty()) {
clickScript = RivenScriptPtr(new RivenScript());
}
return clickScript;
}
RivenHotspot *RivenCard::findEnabledHotspotByName(uint n, ...) const {
va_list ap;
va_start(ap, n);
for (uint i = 0; i < n; i++) {
const char *name = va_arg(ap, const char *);
RivenHotspot *hotspot = getHotspotByName(name, true);
if (hotspot && hotspot->isEnabled()) {
return hotspot;
}
}
va_end(ap);
return nullptr;
}
RivenHotspot::RivenHotspot(MohawkEngine_Riven *vm, Common::ReadStream *stream) :
_vm(vm) {
loadFromStream(stream);
}
void RivenHotspot::loadFromStream(Common::ReadStream *stream) {
_flags = kFlagEnabled;
_blstID = stream->readUint16BE();
_nameResource = stream->readSint16BE();
int16 left = stream->readSint16BE();
int16 top = stream->readSint16BE();
int16 right = stream->readSint16BE();
int16 bottom = stream->readSint16BE();
// Riven has some invalid rects, disable them here
// Known weird hotspots:
// - tspit 371 (DVD: 377), hotspot 4
if (left >= right || top >= bottom) {
warning("Invalid hotspot: (%d, %d, %d, %d)", left, top, right, bottom);
left = top = right = bottom = 0;
enable(false);
}
_rect = Common::Rect(left, top, right, bottom);
_u0 = stream->readUint16BE();
_mouseCursor = stream->readUint16BE();
_index = stream->readUint16BE();
_transitionOffset = stream->readSint16BE();
_flags |= stream->readUint16BE();
// Read in the scripts now
_scripts = _vm->_scriptMan->readScripts(stream);
}
RivenScriptPtr RivenHotspot::getScript(uint16 scriptType) const {
for (uint16 i = 0; i < _scripts.size(); i++)
if (_scripts[i].type == scriptType) {
return _scripts[i].script;
}
return RivenScriptPtr();
}
void RivenHotspot::applyPropertiesPatches(uint32 cardGlobalId) {
// In Jungle island, one of the bridge hotspots does not have a name
// This breaks keyboard navigation. Set the proper name.
if (cardGlobalId == 0x214a0 && _blstID == 9) {
_nameResource = _vm->getStack()->getIdFromName(kHotspotNames, "forward");
debugC(kRivenDebugPatches, "Applied missing hotspot name patch to card %x", cardGlobalId);
}
// In the lab in Book Making island the card showing one of the doors has
// two "forward" hotspots. One of them goes backwards. Disable it, and make sure
// it cannot be found by the keyboard navigation code.
if (cardGlobalId == 0x1fa79 && _blstID == 3) {
enable(false);
_nameResource = -1;
debugC(kRivenDebugPatches, "Applied disable buggy forward hotspot to card %x", cardGlobalId);
}
// On Temple Island, in front of the back door to the rotating room,
// change the name of the hotspot to look at the bottom of the door to
// "down" instead of "forwardleft". That way the keyboard navigation
// does not spoil that you can go below the door.
if (cardGlobalId == 0x87ac && _blstID == 10) {
_nameResource = _vm->getStack()->getIdFromName(kHotspotNames, "down");
debugC(kRivenDebugPatches, "Applied change hotspot name to 'down' patch to card %x", cardGlobalId);
}
}
void RivenHotspot::applyScriptPatches(uint32 cardGlobalId) {
for (uint16 i = 0; i < _scripts.size(); i++) {
_scripts[i].script->applyCardPatches(_vm, cardGlobalId, _scripts[i].type, _blstID);
}
}
bool RivenHotspot::isEnabled() const {
return (_flags & kFlagEnabled) != 0;
}
void RivenHotspot::enable(bool e) {
if (e) {
_flags |= kFlagEnabled;
} else {
_flags &= ~kFlagEnabled;
}
}
bool RivenHotspot::isZip() const {
return (_flags & kFlagZip) != 0;
}
Common::Rect RivenHotspot::getRect() const {
return _rect;
}
bool RivenHotspot::containsPoint(const Common::Point &point) const {
return _rect.contains(point);
}
uint16 RivenHotspot::getMouseCursor() const {
return _mouseCursor;
}
Common::String RivenHotspot::getName() const {
if (_nameResource < 0)
return Common::String();
return _vm->getStack()->getName(kHotspotNames, _nameResource);
}
uint16 RivenHotspot::getIndex() const {
return _index;
}
uint16 RivenHotspot::getBlstId() const {
return _blstID;
}
void RivenHotspot::setRect(const Common::Rect &rect) {
_rect = rect;
}
int16 RivenHotspot::getNameId() const {
return _nameResource;
}
int16 RivenHotspot::getTransitionOffset() const {
return _transitionOffset;
}
void RivenHotspot::dump() const {
debug("index: %d", _index);
debug("blstId: %d", _blstID);
debug("name: %s", getName().c_str());
debug("rect: (%d, %d, %d, %d)", _rect.left, _rect.top, _rect.right, _rect.bottom);
debug("flags: %d", _flags);
debug("mouseCursor: %d", _mouseCursor);
debug("transitionOffset: %d", _transitionOffset);
debug("u0: %d", _u0);
debugN("\n");
for (uint i = 0; i < _scripts.size(); i++) {
debug("=== Hotspot script %d ===", i);
debug("type: %s", RivenScript::getTypeName(_scripts[i].type));
_scripts[i].script->dumpScript(0);
debugN("\n");
}
}
} // End of namespace Mohawk
|