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
|
/* 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$
*
*/
#ifndef LASTEXPRESS_ENTITY_H
#define LASTEXPRESS_ENTITY_H
#include "lastexpress/shared.h"
#include "lastexpress/game/sound.h"
#include "common/array.h"
#include "common/func.h"
#include "common/serializer.h"
namespace LastExpress {
class LastExpressEngine;
class Sequence;
class SequenceFrame;
struct SavePoint;
class EntityData : Common::Serializable {
public:
struct EntityParameters {
virtual ~EntityParameters() {}
virtual Common::String toString() = 0;
virtual void update(uint32 index) = 0;
};
struct EntityParametersIIII : EntityParameters {
uint param1;
uint param2;
uint param3;
uint param4;
uint param5;
uint param6;
uint param7;
uint param8;
EntityParametersIIII() {
param1 = 0;
param2 = 0;
param3 = 0;
param4 = 0;
param5 = 0;
param6 = 0;
param7 = 0;
param8 = 0;
}
bool hasNonNullParameter() {
return param1 || param2 || param3 || param4 || param5 || param6 || param7 || param8;
}
Common::String toString() {
return Common::String::printf("IIII: %d %d %d %d %d %d %d %d\n", param1, param2, param3, param4, param5, param6, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersIIII::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 1: param2 = 1; break;
case 2: param3 = 1; break;
case 3: param4 = 1; break;
case 4: param5 = 1; break;
case 5: param6 = 1; break;
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersSIII : EntityParameters {
char seq[12];
uint param4;
uint param5;
uint param6;
uint param7;
uint param8;
EntityParametersSIII() {
memset(&seq, 0, 12);
param4 = 0;
param5 = 0;
param6 = 0;
param7 = 0;
param8 = 0;
}
Common::String toString() {
return Common::String::printf("SIII: %s %d %d %d %d %d\n", seq, param4, param5, param6, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersSIII::update: invalid index (was: %d)", index);
case 3: param4 = 1; break;
case 4: param5 = 1; break;
case 5: param6 = 1; break;
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersSIIS : EntityParameters {
char seq1[12];
uint param4;
uint param5;
char seq2[12];
EntityParametersSIIS() {
memset(&seq1, 0, 12);
param4 = 0;
param5 = 0;
memset(&seq2, 0, 12);
}
Common::String toString() {
return Common::String::printf("SIIS: %s %d %d %s\n", seq1, param4, param5, seq2);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersSIIS::update: invalid index (was: %d)", index);
case 3: param4 = 1; break;
case 4: param5 = 1; break;
}
}
};
struct EntityParametersISSI : EntityParameters {
uint param1;
char seq1[12];
char seq2[12];
uint param8;
EntityParametersISSI() {
param1 = 0;
memset(&seq1, 0, 12);
memset(&seq2, 0, 12);
param8 = 0;
}
Common::String toString() {
return Common::String::printf("ISSI: %d %s %s %d\n", param1, seq1, seq2, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersISSI::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersISII : EntityParameters {
uint param1;
char seq[12];
uint param5;
uint param6;
uint param7;
uint param8;
EntityParametersISII() {
param1 = 0;
memset(&seq, 0, 12);
param5 = 0;
param6 = 0;
param7 = 0;
param8 = 0;
}
Common::String toString() {
return Common::String::printf("ISII: %d %s %d %d %d %d\n", param1, seq, param5, param6, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersISII::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 4: param5 = 1; break;
case 5: param6 = 1; break;
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersSSII : EntityParameters {
char seq1[12];
char seq2[12];
uint param7;
uint param8;
EntityParametersSSII() {
memset(&seq1, 0, 12);
memset(&seq2, 0, 12);
param7 = 0;
param8 = 0;
}
Common::String toString() {
return Common::String::printf("SSII: %s %s %d %d\n", seq1, seq2, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersSSII::update: invalid index (was: %d)", index);
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersIISS : EntityParameters {
uint param1;
uint param2;
char seq1[12];
char seq2[12];
EntityParametersIISS() {
param1 = 0;
param2 = 0;
memset(&seq1, 0, 12);
memset(&seq2, 0, 12);
}
Common::String toString() {
return Common::String::printf("IISS: %d %d %s %s\n", param1, param2, seq1, seq2);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersIISS::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 1: param2 = 1; break;
}
}
};
struct EntityParametersIISI : EntityParameters {
uint param1;
uint param2;
char seq[12];
uint param6;
uint param7;
uint param8;
EntityParametersIISI() {
param1 = 0;
param2 = 0;
memset(&seq, 0, 12);
param6 = 0;
param7 = 0;
param8 = 0;
}
Common::String toString() {
return Common::String::printf("IISI: %d %d %s %d %d %d\n", param1, param2, seq, param6, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersIISI::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 1: param2 = 1; break;
case 5: param6 = 1; break;
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersIIIS : EntityParameters {
uint param1;
uint param2;
uint param3;
char seq[12];
uint param7;
uint param8;
EntityParametersIIIS() {
param1 = 0;
param2 = 0;
param3 = 0;
memset(&seq, 0, 12);
param7 = 0;
param8 = 0;
}
Common::String toString() {
return Common::String::printf("IIIS: %d %d %d %s %d %d\n", param1, param2, param3, seq, param7, param8);
}
void update(uint32 index) {
switch (index) {
default:
error("EntityParametersIIIS::update: invalid index (was: %d)", index);
case 0: param1 = 1; break;
case 1: param2 = 1; break;
case 2: param3 = 1; break;
case 6: param7 = 1; break;
case 7: param8 = 1; break;
}
}
};
struct EntityParametersI5S : EntityParameters {
uint param1;
uint param2;
uint param3;
uint param4;
uint param5;
char seq[12];
EntityParametersI5S() {
param1 = 0;
param2 = 0;
param3 = 0;
param4 = 0;
param5 = 0;
memset(&seq, 0, 12);
}
};
struct EntityCallParameters {
EntityParameters *parameters[4];
EntityCallParameters() {
// We default to int parameters
create<EntityParametersIIII>();
}
~EntityCallParameters() {
clear();
}
template<class T>
void create() {
for (int i = 0; i < 4; i++)
parameters[i] = new T();
}
void clear() {
for (int i = 0; i < 4; i++) {
if (parameters[i])
delete parameters[i];
parameters[i] = NULL;
}
}
};
struct EntityCallData {
byte callbacks[16];
byte currentCall;
EntityPosition entityPosition; // word
Location location; // word
CarIndex car; // word
byte field_497;
EntityIndex entity; // byte
InventoryItem inventoryItem; // byte
EntityDirection direction; // byte
int16 field_49B;
int16 currentFrame;
int16 currentFrame2;
int16 field_4A1;
int16 field_4A3;
ClothesIndex clothes; // byte
Position position;
CarIndex car2; // byte
bool doProcessEntity; // byte
bool field_4A9; // byte
bool field_4AA; // byte
EntityDirection directionSwitch;
Common::String sequenceName; // char[13]
Common::String sequenceName2; // char[13]
Common::String sequenceNamePrefix; // char[7]
Common::String sequenceNameCopy; // char[13]
SequenceFrame *frame;
SequenceFrame *frame1;
Sequence *sequence;
Sequence *sequence2;
Sequence *sequence3;
/**
* Default constructor.
*/
EntityCallData() {
memset(&callbacks, 0, 16 * sizeof(byte));
currentCall = 0;
entityPosition = kPositionNone;
location = kLocationOutsideCompartment;
car = kCarNone;
field_497 = 0;
entity = kEntityPlayer;
inventoryItem = kItemNone;
direction = kDirectionNone;
field_49B = 0;
currentFrame = 0;
currentFrame2 = 0;
field_4A1 = 0;
field_4A3 = 30;
clothes = kClothesDefault;
position = 0;
car2 = kCarNone;
doProcessEntity = false;
field_4A9 = false;
field_4AA = false;
directionSwitch = kDirectionNone;
frame = NULL;
frame1 = NULL;
sequence = NULL;
sequence2 = NULL;
sequence3 = NULL;
}
/**
* Convert this object into a string representation.
*
* @return A string representation of this object.
*/
Common::String toString() {
Common::String str = "";
str += Common::String::printf("Entity position: %d - Location: %d - Car: %d\n", entityPosition, location, car);
str += Common::String::printf("Entity: %d - Item: %d - Direction: %d\n", entity, inventoryItem, direction);
str += Common::String::printf("Clothes: %d - Position: %d - Direction switch: %d\n", clothes, position, directionSwitch);
str += "\n";
str += Common::String::printf("field_497: %02d - field_49B: %i - field_4A1: %i\n", field_497, field_49B, field_4A1);
str += Common::String::printf("field_4A9: %02d - field_4AA: %i - Car 2: %d\n", field_4A9, field_4AA, car2);
str += "\n";
str += "Sequence: " + sequenceName + " - Sequence 2: " + sequenceName2 + "\n";
str += "Sequence prefix: " + sequenceNamePrefix + " - Sequence copy: " + sequenceNameCopy + "\n";
str += Common::String::printf("Current frame: %i - Current frame 2: %i - Process entity: %d\n", currentFrame, currentFrame2, doProcessEntity);
str += "\n";
str += Common::String::printf("Current call: %d\n", currentCall);
str += Common::String::printf("Functions: %d %d %d %d %d %d %d %d\n", callbacks[0], callbacks[1], callbacks[2], callbacks[3], callbacks[4], callbacks[5], callbacks[6], callbacks[7]);
str += Common::String::printf("Callbacks: %d %d %d %d %d %d %d %d\n", callbacks[8], callbacks[9], callbacks[10], callbacks[11], callbacks[12], callbacks[13], callbacks[14], callbacks[15]);
return str;
}
};
EntityData() {}
template<class T>
void resetCurrentParameters() {
EntityCallParameters *params = &_parameters[_data.currentCall];
params->clear();
params->create<T>();
}
EntityCallData *getCallData() { return &_data; }
EntityParameters *getParameters(uint callback, byte index) const;
EntityParameters *getCurrentParameters(byte index = 0) { return getParameters(_data.currentCall, index); }
int getCallback(uint callback) const;
int getCurrentCallback() { return getCallback(_data.currentCall); }
void setCallback(uint callback, byte index);
void setCurrentCallback(uint index) { setCallback(_data.currentCall, index); }
void updateParameters(uint32 index) const;
// Serializable
void saveLoadWithSerializer(Common::Serializer &ser);
private:
EntityCallData _data;
EntityCallParameters _parameters[9];
};
class Entity : Common::Serializable {
public:
typedef Common::Functor1<const SavePoint&, void> Callback;
Entity(LastExpressEngine *engine, EntityIndex index);
virtual ~Entity();
// Accessors
EntityData *getParamData() { return _data; }
EntityData::EntityCallData *getData() { return _data->getCallData(); }
// Callbacks
int getCallback() { return _data->getCallback(_data->getCallData()->currentCall + 8); }
void setCallback(byte index) { _data->setCallback(_data->getCallData()->currentCall + 8, index); getData()->currentCall++; }
// Setup
void setup(ChapterIndex index);
virtual void setup_chapter1() = 0;
virtual void setup_chapter2() = 0;
virtual void setup_chapter3() = 0;
virtual void setup_chapter4() = 0;
virtual void setup_chapter5() = 0;
// Serializable
void saveLoadWithSerializer(Common::Serializer &ser) { _data->saveLoadWithSerializer(ser); }
void nullfunction(const SavePoint &savepoint) {}
protected:
LastExpressEngine *_engine;
EntityIndex _entityIndex;
EntityData *_data;
Common::Array<Callback *> _callbacks;
/**
* Saves the game
*
* @param savepoint The savepoint
* - SavegameType
* - EventIndex
*/
void savegame(const SavePoint &savepoint);
/**
* Play sound
*
* @param savepoint The savepoint
* - Sound filename
* @param resetItem true to reset item.
* @param flag sound flag
*/
void playSound(const SavePoint &savepoint, bool resetItem = false, SoundManager::FlagType flag = SoundManager::kFlagInvalid);
/**
* Draws the entity
*
* @param savepoint The savepoint
* - Sequence
* - ExcuseMe flag
* @param handleExcuseMe true to handle excuseMeCath action
*/
void draw(const SavePoint &savepoint, bool handleExcuseMe = false);
/**
* Draws the entity along with another one
*
* @param savepoint The savepoint.
* - Sequence 1
* - Sequence 2
* - EntityIndex
*/
void draw2(const SavePoint &savepoint);
/**
* Updates parameter 2 using ticks value
*
* @param savepoint The savepoint
* - Number of ticks to add
*/
void updateFromTicks(const SavePoint &savepoint);
/**
* Updates parameter 2 using time value
*
* @param savepoint The savepoint.
* - Time to add
*/
void updateFromTime(const SavePoint &savepoint);
/**
* Resets an entity
*
* @param savepoint The savepoint.
* @param resetClothes true to reset clothes.
* @param resetItem true to reset inventoryItem to kItemInvalid
*/
void reset(const SavePoint &savepoint, bool resetClothes = false, bool resetItem = false);
/**
* Process callback action when the entity direction is not kDirectionRight
*
* @param savepoint The savepoint.
*/
void callbackActionOnDirection(const SavePoint &savepoint);
/**
* Process callback action when somebody is standing in the restaurant or salon.
*
* @param savepoint The savepoint.
*/
void callbackActionRestaurantOrSalon(const SavePoint &savepoint);
/**
* Updates the entity
*
* @param savepoint The savepoint.
* - CarIndex
* - EntityPosition
* @param handleExcuseMe true to handle the kActionExcuseMe/kActionExcuseMeCath actions.
*/
void updateEntity(const SavePoint &savepoint, bool handleExcuseMe = false);
/**
* Call a specific savepoint (or draw sequence in default case)
*
* @param savepoint The savepoint.
* - Sequence to draw in default case
* - EntityIndex
* - ActionIndex
* - Sequence for the savepoint
* @param handleExcuseMe true to handle excuse me.
*/
void callSavepoint(const SavePoint &savepoint, bool handleExcuseMe = false);
/**
* Handles entering/exiting a compartment.
*
* @param savepoint The savepoint.
* @param position1 The first position.
* @param position2 The second position.
* @param car The car.
* @param compartment The compartment.
* @param alternate true to use the alternate version of SceneManager::loadSceneFromObject()
*/
void enterExitCompartment(const SavePoint &savepoint, EntityPosition position1 = kPositionNone, EntityPosition position2 = kPositionNone, CarIndex car = kCarNone, ObjectIndex compartment = kObjectNone, bool alternate = false, bool updateLocation = false);
/**
* Updates the position
*
* @param savepoint The savepoint
* - Sequence name
* - CarIndex
* - Position
* @param handleExcuseMe true to handle excuseMe actions
*/
void updatePosition(const SavePoint &savepoint, bool handleExcuseMe = false);
};
} // End of namespace LastExpress
#endif // LASTEXPRESS_ENTITY_H
|