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
|
/* 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.
*
* $URL$
* $Id$
*
*/
#include "mohawk/myst.h"
#include "mohawk/graphics.h"
#include "mohawk/myst_areas.h"
#include "mohawk/myst_saveload.h"
#include "mohawk/sound.h"
#include "mohawk/video.h"
#include "mohawk/myst_stacks/mechanical.h"
#include "gui/message.h"
namespace Mohawk {
MystScriptParser_Mechanical::MystScriptParser_Mechanical(MohawkEngine_Myst *vm) : MystScriptParser(vm) {
setupOpcodes();
}
MystScriptParser_Mechanical::~MystScriptParser_Mechanical() {
}
#define OPCODE(op, x) _opcodes.push_back(new MystOpcode(op, (OpcodeProcMyst) &MystScriptParser_Mechanical::x, #x))
void MystScriptParser_Mechanical::setupOpcodes() {
// "Stack-Specific" Opcodes
OPCODE(104, opcode_104);
OPCODE(105, opcode_105);
OPCODE(121, opcode_121);
OPCODE(122, opcode_122);
OPCODE(123, opcode_123);
OPCODE(124, opcode_124);
OPCODE(125, opcode_125);
OPCODE(126, opcode_126);
OPCODE(127, opcode_127);
OPCODE(128, opcode_128);
OPCODE(129, opcode_129);
OPCODE(130, opcode_130);
OPCODE(131, opcode_131);
OPCODE(132, opcode_132);
// "Init" Opcodes
OPCODE(200, opcode_200);
OPCODE(201, opcode_201);
OPCODE(202, opcode_202);
OPCODE(203, opcode_203);
OPCODE(204, opcode_204);
OPCODE(205, opcode_205);
OPCODE(206, opcode_206);
OPCODE(209, opcode_209);
// "Exit" Opcodes
OPCODE(300, opcode_300);
}
#undef OPCODE
void MystScriptParser_Mechanical::disablePersistentScripts() {
opcode_200_disable();
opcode_201_disable();
opcode_202_disable();
opcode_203_disable();
opcode_204_disable();
opcode_205_disable();
opcode_206_disable();
opcode_209_disable();
}
void MystScriptParser_Mechanical::runPersistentScripts() {
opcode_200_run();
opcode_201_run();
opcode_202_run();
opcode_203_run();
opcode_204_run();
opcode_205_run();
opcode_206_run();
opcode_209_run();
}
uint16 MystScriptParser_Mechanical::getVar(uint16 var) {
// MystVariables::Globals &globals = _vm->_saveLoad->_v->globals;
MystVariables::Mechanical &mechanical = _vm->_saveLoad->_v->mechanical;
switch(var) {
case 0: // Sirrus's Secret Panel State
return mechanical.sirrusPanelState;
case 1: // Achenar's Secret Panel State
return mechanical.achenarPanelState;
// case 3: // Sirrus's Secret Room Crate State
// return 0;
// return 1;
// case 4: // Myst Book Room Staircase State
// return 0; // Staircase Up
// return 1; // Staircase Down
// case 5: // Fortress Position
// return 0; // Island with Code Lock
// return 1; // Island with Last Two Symbols of Code
// return 2; // Island with First Two Symbols of Code
// return 3; // No Island
// case 6: // Fortress Position - Big Cog Visible Through Doorway
// return 0;
// return 1;
case 7: // Fortress Elevator Open
if (mechanical.elevatorRotation == 4)
return 1; // Open
else
return 0; // Closed
case 10: // Fortress Staircase State
return mechanical.staircaseState;
case 11: // Fortress Elevator Rotation Position
return mechanical.elevatorRotation;
// case 12: // Fortress Elevator Rotation Cog Position
// return 0;
// return 1;
// return 2;
// return 3;
// return 4;
// return 5;
// case 15: // Code Lock Execute Button State(?)
// return 0;
// return 1;
// return 2;
case 16: // Code Lock Shape #1 - Left
case 17: // Code Lock Shape #2
case 18: // Code Lock Shape #3
case 19: // Code Lock Shape #4 - Right
return mechanical.codeShape[var - 16];
// case 20: // Crystal Lit Flag - Yellow
// return 0;
// return 1;
// case 21: // Crystal Lit Flag - Green
// return 0;
// return 1;
// case 22: // Crystal Lit Flag - Red
// return 0;
// return 1;
// case 102: // Red Page Present In Age
// globals.heldPage and redPagesInBook?
// return 0; // Page Not Present
// return 1; // Page Present
// case 103: // Blue Page Present In Age
// globals.heldPage and bluePagesInBook?
// return 0; // Page Not Present
// return 1; // Page Present
default:
return MystScriptParser::getVar(var);
}
}
void MystScriptParser_Mechanical::toggleVar(uint16 var) {
// MystVariables::Globals &globals = _vm->_saveLoad->_v->globals;
MystVariables::Mechanical &mechanical = _vm->_saveLoad->_v->mechanical;
switch(var) {
// case 3: // Sirrus's Secret Room Crate State
// temp ^= 1;
// case 4: // Code Lock Puzzle Correct / Myst Book Room Staircase State
// temp ^= 1;
case 10: // Fortress Staircase State
mechanical.staircaseState ^= 1;
case 16: // Code Lock Shape #1 - Left
case 17: // Code Lock Shape #2
case 18: // Code Lock Shape #3
case 19: // Code Lock Shape #4 - Right
mechanical.codeShape[var - 16] = (mechanical.codeShape[var - 16] + 1) % 10;
break;
// case 102: // Red Page Grab/Release
// globals.heldPage?
// case 103: // Blue Page Grab/Release
// globals.heldPage?
default:
MystScriptParser::toggleVar(var);
break;
}
}
bool MystScriptParser_Mechanical::setVarValue(uint16 var, uint16 value) {
// MystVariables::Mechanical &mechanical = _vm->_saveLoad->_v->mechanical;
bool refresh = false;
switch (var) {
default:
refresh = MystScriptParser::setVarValue(var, value);
break;
}
return refresh;
}
void MystScriptParser_Mechanical::opcode_104(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used on Mechanical Card 6043 (Weapons Rack with Snake Box)
if (argc == 0) {
debugC(kDebugScript, "Opcode %d: Trigger Playing Of Snake Movie", op);
// TODO: Trigger Type 6 To Play Snake Movie.. Resource #3 on card.
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_105(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
debugC(kDebugScript, "Opcode %d: Play Stairs Movement Movie", op);
if (_vm->_varStore->getVar(10)) {
// TODO: Play Movie from 0 to 1/2 way...
_vm->_video->playMovie(_vm->wrapMovieFilename("hhstairs", kMechanicalStack), 174, 222);
} else {
// TODO: Play Movie from 1/2 way to end...
_vm->_video->playMovie(_vm->wrapMovieFilename("hhstairs", kMechanicalStack), 174, 222);
}
}
}
void MystScriptParser_Mechanical::opcode_121(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 2) {
uint16 startTime = argv[0];
uint16 endTime = argv[1];
warning("TODO: Opcode %d Movie Time Index %d to %d\n", op, startTime, endTime);
// TODO: Need version of playMovie blocking which allows selection
// of start and finish points.
_vm->_video->playMovie(_vm->wrapMovieFilename("ewindow", kMechanicalStack), 253, 0);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_122(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
if (argc == 0) {
// Used on Card 6120 (Elevator)
// Called when Exit Midde Button Pressed
// TODO: hcelev? Movie of Elevator?
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_123(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 2) {
// Used on Card 6154
uint16 start_time = argv[0];
uint16 end_time = argv[1];
warning("TODO: Opcode %d Movie Time Index %d to %d\n", op, start_time, end_time);
// TODO: Need version of playMovie blocking which allows selection
// of start and finish points.
// TODO: Not 100% sure about movie position
_vm->_video->playMovie(_vm->wrapMovieFilename("hcelev", kMechanicalStack), 205, 40);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_124(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used by Card 6156 (Fortress Rotation Controls)
// Called when Red Exit Button Pressed to raise Elevator
// TODO: Fill in Code...
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_125(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
if (argc == 0) {
// Used on Card 6267 (Code Lock)
// Called by Red Execute Button...
debugC(kDebugScript, "Opcode %d: Code Lock Execute...", op);
// TODO: Fill in Logic For Code Lock...
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_126(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used by Card 6120 (Fortress Elevator)
// Called when Red Exit Button Pressed to raise Elevator and
// exit is clicked...
// TODO: Fill in Code...
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_127(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(20, 1);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_128(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(20, 0);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_129(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(21, 1);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_130(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(21, 0);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_131(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(22, 1);
} else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_132(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
if (argc == 0) {
// Used for Mech Card 6226 (3 Crystals)
_vm->_varStore->setVar(22, 0);
} else
unknown(op, var, argc, argv);
}
static struct {
bool enabled;
uint16 var;
} g_opcode200Parameters;
void MystScriptParser_Mechanical::opcode_200_run() {
// Used on Card 6238 (Sirrus' Throne) and Card 6027 (Achenar's Throne)
// g_opcode200Parameters.var == 0 for Achenar
// g_opcode200Parameters.var == 1 for Sirrus
// TODO: Fill in Function...
// Variable indicates that this is related to Secret Panel State
}
void MystScriptParser_Mechanical::opcode_200_disable() {
g_opcode200Parameters.enabled = false;
g_opcode200Parameters.var = 0;
}
void MystScriptParser_Mechanical::opcode_200(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
// Used on Card 6238 (Sirrus' Throne) and Card 6027 (Achenar's Throne)
if (argc == 0) {
g_opcode200Parameters.var = var;
g_opcode200Parameters.enabled = true;
} else
unknown(op, var, argc, argv);
}
static struct {
uint16 u0;
uint16 u1;
uint16 u2;
bool enabled;
} g_opcode201Parameters;
void MystScriptParser_Mechanical::opcode_201_run() {
// Used for Card 6159 (Facing Corridor to Fortress Elevator)
// g_opcode201Parameters.u0
// g_opcode201Parameters.u1
// g_opcode201Parameters.u2
// TODO: Fill in Function...
}
void MystScriptParser_Mechanical::opcode_201_disable() {
g_opcode201Parameters.enabled = false;
g_opcode201Parameters.u0 = 0;
g_opcode201Parameters.u1 = 0;
g_opcode201Parameters.u2 = 0;
}
void MystScriptParser_Mechanical::opcode_201(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6159 (Facing Corridor to Fortress Elevator)
if (argc == 3) {
g_opcode201Parameters.u0 = argv[0];
g_opcode201Parameters.u1 = argv[1];
g_opcode201Parameters.u2 = argv[2];
g_opcode201Parameters.enabled = true;
} else
unknown(op, var, argc, argv);
}
static struct {
bool enabled;
} g_opcode202Parameters;
void MystScriptParser_Mechanical::opcode_202_run() {
// Used for Card 6220 (Sirrus' Mechanical Bird)
// TODO: Fill in Function
}
void MystScriptParser_Mechanical::opcode_202_disable() {
g_opcode202Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_202(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
// Used for Card 6220 (Sirrus' Mechanical Bird)
if (argc == 0)
g_opcode202Parameters.enabled = true;
else
unknown(op, var, argc, argv);
}
static struct {
bool enabled;
} g_opcode203Parameters;
void MystScriptParser_Mechanical::opcode_203_run() {
if (g_opcode203Parameters.enabled) {
// Used for Card 6043 (Weapons Rack with Snake Box)
// TODO: Fill in Logic for Snake Box...
}
}
void MystScriptParser_Mechanical::opcode_203_disable() {
g_opcode203Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_203(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6043 (Weapons Rack with Snake Box)
if (argc == 0)
g_opcode203Parameters.enabled = true;
else
unknown(op, var, argc, argv);
}
static struct {
bool enabled;
uint16 soundId;
} g_opcode204Parameters;
void MystScriptParser_Mechanical::opcode_204_run() {
if (g_opcode204Parameters.enabled) {
// TODO: Fill in Logic.
// Var 12 holds Large Cog Position in range 0 to 5
// - For animation
// Var 11 holds C position in range 0 to 9
// - 4 for Correct Answer
// C Movement Sound
//_vm->_sound->playSound(g_opcode204Parameters.soundId);
}
}
void MystScriptParser_Mechanical::opcode_204_disable() {
g_opcode204Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_204(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6180 (Lower Elevator Puzzle)
if (argc == 1) {
g_opcode204Parameters.soundId = argv[0];
g_opcode204Parameters.enabled = true;
} else
unknown(op, var, argc, argv);
}
static struct {
uint16 soundIdPosition[4];
bool enabled;
} g_opcode205Parameters;
void MystScriptParser_Mechanical::opcode_205_run() {
// Used for Card 6156 (Fortress Rotation Controls)
// TODO: Fill in function...
// g_opcode205Parameters.soundIdPosition[4]
}
void MystScriptParser_Mechanical::opcode_205_disable() {
g_opcode205Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_205(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6156 (Fortress Rotation Controls)
if (argc == 4) {
g_opcode205Parameters.soundIdPosition[0] = argv[0];
g_opcode205Parameters.soundIdPosition[1] = argv[1];
g_opcode205Parameters.soundIdPosition[2] = argv[2];
g_opcode205Parameters.soundIdPosition[3] = argv[3];
g_opcode205Parameters.enabled = true;
} else
unknown(op, var, argc, argv);
}
static struct {
uint16 soundIdStart[2];
uint16 soundIdPosition[4];
bool enabled;
} g_opcode206Parameters;
void MystScriptParser_Mechanical::opcode_206_run() {
if (g_opcode206Parameters.enabled) {
// Used for Card 6044 (Fortress Rotation Simulator)
// g_opcode206Parameters.soundIdStart[2]
// g_opcode206Parameters.soundIdPosition[4]
// TODO: Fill in function...
}
}
void MystScriptParser_Mechanical::opcode_206_disable() {
g_opcode206Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_206(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6044 (Fortress Rotation Simulator)
if (argc == 6) {
g_opcode206Parameters.soundIdStart[0] = argv[0];
g_opcode206Parameters.soundIdStart[1] = argv[1];
g_opcode206Parameters.soundIdPosition[0] = argv[2];
g_opcode206Parameters.soundIdPosition[1] = argv[3];
g_opcode206Parameters.soundIdPosition[2] = argv[4];
g_opcode206Parameters.soundIdPosition[3] = argv[5];
g_opcode206Parameters.enabled = true;
} else
unknown(op, var, argc, argv);
}
static struct {
bool enabled;
} g_opcode209Parameters;
void MystScriptParser_Mechanical::opcode_209_run() {
// Used for Card 6044 (Fortress Rotation Simulator)
// TODO: Implement Function For Secret Panel State as
// per Opcode 200 function (Mechanical)
}
void MystScriptParser_Mechanical::opcode_209_disable() {
g_opcode209Parameters.enabled = false;
}
void MystScriptParser_Mechanical::opcode_209(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
varUnusedCheck(op, var);
// Used for Card 6044 (Fortress Rotation Simulator)
if (argc == 0)
g_opcode209Parameters.enabled = true;
else
unknown(op, var, argc, argv);
}
void MystScriptParser_Mechanical::opcode_300(uint16 op, uint16 var, uint16 argc, uint16 *argv) {
// Used in Card 6156 (Fortress Elevator View)
varUnusedCheck(op, var);
// TODO: Fill in Logic. Clearing Variable for View?
}
} // End of namespace Mohawk
|