forked from Warzone2100/warzone2100
-
Notifications
You must be signed in to change notification settings - Fork 0
/
qtscriptfuncs.cpp
4659 lines (4437 loc) · 197 KB
/
qtscriptfuncs.cpp
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
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
This file is part of Warzone 2100.
Copyright (C) 2013 Warzone 2100 Project
Warzone 2100 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.
Warzone 2100 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 Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file qtscriptfuncs.cpp
*
* New scripting system -- script functions
*/
#include "lib/framework/wzapp.h"
#include "lib/framework/wzconfig.h"
#include "lib/sound/audio.h"
#include "lib/netplay/netplay.h"
#include "qtscriptfuncs.h"
#include "lib/ivis_opengl/tex.h"
#include <QtScript/QScriptValue>
#include <QtCore/QStringList>
#include <QtGui/QStandardItemModel>
#include "action.h"
#include "combat.h"
#include "console.h"
#include "design.h"
#include "display3d.h"
#include "map.h"
#include "mission.h"
#include "transporter.h"
#include "message.h"
#include "display3d.h"
#include "intelmap.h"
#include "hci.h"
#include "wrappers.h"
#include "challenge.h"
#include "research.h"
#include "multilimit.h"
#include "multigifts.h"
#include "template.h"
#include "lighting.h"
#include "radar.h"
#include "random.h"
#include "frontend.h"
#include "loop.h"
#include "scriptextern.h"
#include "gateway.h"
#include "mapgrid.h"
#include "lighting.h"
#include "atmos.h"
#include "warcam.h"
#include "projectile.h"
#define FAKE_REF_LASSAT 999
#define ALL_PLAYERS -1
#define ALLIES -2
#define ENEMIES -3
#define SCRCB_RES (COMP_NUMCOMPONENTS + 0)
#define SCRCB_REP (COMP_NUMCOMPONENTS + 1)
#define SCRCB_POW (COMP_NUMCOMPONENTS + 2)
#define SCRCB_CON (COMP_NUMCOMPONENTS + 3)
#define SCRCB_REA (COMP_NUMCOMPONENTS + 4)
#define SCRCB_ARM (COMP_NUMCOMPONENTS + 5)
#define SCRCB_HEA (COMP_NUMCOMPONENTS + 6)
#define SCRCB_ELW (COMP_NUMCOMPONENTS + 7)
#define SCRCB_HIT (COMP_NUMCOMPONENTS + 8)
// TODO, move this stuff into a script common subsystem
#include "scriptfuncs.h"
extern bool structDoubleCheck(BASE_STATS *psStat,UDWORD xx,UDWORD yy, SDWORD maxBlockingTiles);
extern Vector2i positions[MAX_PLAYERS];
extern std::vector<Vector2i> derricks;
// private qtscript bureaucracy
typedef QMap<BASE_OBJECT *, int> GROUPMAP;
typedef QMap<QScriptEngine *, GROUPMAP *> ENGINEMAP;
static ENGINEMAP groups;
struct labeltype
{
Vector2i p1, p2;
int id;
int type;
int player;
QList<int> idlist;
bool operator==(const labeltype &o) const { return id == o.id && type == o.type && player == o.player; }
};
typedef QMap<QString, labeltype> LABELMAP;
static LABELMAP labels;
static QStandardItemModel *labelModel = NULL;
#define SCRIPT_ASSERT_PLAYER(_context, _player) \
SCRIPT_ASSERT(_context, _player >= 0 && _player < MAX_PLAYERS, "Invalid player index %d", _player);
// ----------------------------------------------------------------------------------------
// Utility functions -- not called directly from scripts
static void updateLabelModel()
{
if (!labelModel)
{
return;
}
labelModel->setRowCount(0);
labelModel->setRowCount(labels.size());
int nextRow = 0;
for (LABELMAP::iterator i = labels.begin(); i != labels.end(); i++)
{
labeltype &l = (*i);
labelModel->setItem(nextRow, 0, new QStandardItem(i.key()));
const char *c = "?";
switch (l.type)
{
case OBJ_DROID: c = "DROID"; break;
case OBJ_FEATURE: c = "FEATURE"; break;
case OBJ_STRUCTURE: c = "STRUCTURE"; break;
case SCRIPT_POSITION: c = "POSITION"; break;
case SCRIPT_AREA: c = "AREA"; break;
case SCRIPT_GROUP: c = "GROUP"; break;
case SCRIPT_PLAYER:
case SCRIPT_RESEARCH:
case OBJ_PROJECTILE:
case OBJ_TARGET:
case SCRIPT_COUNT: c = "ERROR"; break;
}
labelModel->setItem(nextRow, 1, new QStandardItem(QString(c)));
nextRow++;
}
}
QStandardItemModel *createLabelModel()
{
labelModel = new QStandardItemModel(0, 2);
labelModel->setHeaderData(0, Qt::Horizontal, QString("Label"));
labelModel->setHeaderData(1, Qt::Horizontal, QString("Type"));
updateLabelModel();
return labelModel;
}
static void clearMarks()
{
for (int x = 0; x < mapWidth; x++) // clear old marks
{
for (int y = 0; y < mapHeight; y++)
{
MAPTILE *psTile = mapTile(x, y);
psTile->tileInfoBits &= ~BITS_MARKED;
}
}
}
void showLabel(const QString &key)
{
if (!labels.contains(key))
{
debug(LOG_ERROR, "label %s not found", key.toUtf8().constData());
return;
}
labeltype &l = labels[key];
if (l.type == SCRIPT_AREA || l.type == SCRIPT_POSITION)
{
setViewPos(map_coord(l.p1.x), map_coord(l.p1.y), false); // move camera position
clearMarks();
int maxx = map_coord(l.p2.x);
int maxy = map_coord(l.p2.y);
if (l.type == SCRIPT_POSITION)
{
maxx = MIN(mapWidth, maxx + 1);
maxy = MIN(mapHeight, maxy + 1);
}
for (int x = map_coord(l.p1.x); x < maxx; x++) // make new ones
{
for (int y = map_coord(l.p1.y); y < maxy; y++)
{
MAPTILE *psTile = mapTile(x, y);
psTile->tileInfoBits |= BITS_MARKED;
}
}
}
else if (l.type == OBJ_DROID || l.type == OBJ_FEATURE || l.type == OBJ_STRUCTURE)
{
clearMarks();
BASE_OBJECT *psObj = IdToObject((OBJECT_TYPE)l.type, l.id, l.player);
if (psObj)
{
setViewPos(map_coord(psObj->pos.x), map_coord(psObj->pos.y), false); // move camera position
MAPTILE *psTile = mapTile(map_coord(psObj->pos.x), map_coord(psObj->pos.y));
psTile->tileInfoBits |= BITS_MARKED;
}
}
else if (l.type == SCRIPT_GROUP)
{
bool cameraMoved = false;
clearMarks();
for (ENGINEMAP::iterator i = groups.begin(); i != groups.end(); ++i)
{
for (GROUPMAP::const_iterator iter = i.value()->constBegin(); iter != i.value()->constEnd(); ++iter)
{
if (iter.value() == l.id)
{
BASE_OBJECT *psObj = iter.key();
if (!cameraMoved)
{
setViewPos(map_coord(psObj->pos.x), map_coord(psObj->pos.y), false); // move camera position
cameraMoved = true;
}
MAPTILE *psTile = mapTile(map_coord(psObj->pos.x), map_coord(psObj->pos.y));
psTile->tileInfoBits |= BITS_MARKED;
}
}
}
}
}
bool areaLabelCheck(DROID *psDroid)
{
int x = psDroid->pos.x;
int y = psDroid->pos.y;
for (LABELMAP::iterator i = labels.begin(); i != labels.end(); i++)
{
labeltype &l = (*i);
if (l.id == -1 && l.p1.x < x && l.p1.y < y && l.p2.x > x && l.p2.y > y
&& (l.player == ALL_PLAYERS || l.player == psDroid->player)
&& l.type == SCRIPT_AREA)
{
// We're inside an untriggered area
l.id = 1; // deactivate it
triggerEventArea(i.key(), psDroid);
return true;
}
}
return false;
}
static void removeFromGroup(QScriptEngine *engine, GROUPMAP *psMap, BASE_OBJECT *psObj)
{
if (psMap->contains(psObj))
{
int groupId = psMap->take(psObj); // take and remove item
QScriptValue groupMembers = engine->globalObject().property("groupSizes");
const int newValue = groupMembers.property(groupId).toInt32() - 1;
ASSERT(newValue >= 0, "Bad group count in group %d (was %d)", groupId, newValue + 1);
groupMembers.setProperty(groupId, newValue, QScriptValue::ReadOnly);
triggerEventGroupLoss(psObj, groupId, newValue, engine);
}
}
void groupRemoveObject(BASE_OBJECT *psObj)
{
for (ENGINEMAP::iterator i = groups.begin(); i != groups.end(); ++i)
{
removeFromGroup(i.key(), i.value(), psObj);
}
}
static bool groupAddObject(BASE_OBJECT *psObj, int groupId, QScriptEngine *engine)
{
ASSERT_OR_RETURN(false, psObj && engine, "Bad parameter");
GROUPMAP *psMap = groups.value(engine);
removeFromGroup(engine, psMap, psObj);
QScriptValue groupMembers = engine->globalObject().property("groupSizes");
int prev = groupMembers.property(QString::number(groupId)).toInt32();
groupMembers.setProperty(QString::number(groupId), prev + 1, QScriptValue::ReadOnly);
psMap->insert(psObj, groupId);
return true; // inserted
}
//;; \subsection{Research}
//;; Describes a research item. The following properties are defined:
//;; \begin{description}
//;; \item[power] Number of power points needed for starting the research.
//;; \item[points] Number of resarch points needed to complete the research.
//;; \item[started] A boolean saying whether or not this research has been started by current player or any of its allies.
//;; \item[done] A boolean saying whether or not this research has been completed.
//;; \item[name] A string containing the full name of the research.
//;; \item[id] A string containing the index name of the research.
//;; \item[type] The type will always be RESEARCH_DATA.
//;; \end{description}
QScriptValue convResearch(RESEARCH *psResearch, QScriptEngine *engine, int player)
{
QScriptValue value = engine->newObject();
value.setProperty("power", (int)psResearch->researchPower);
value.setProperty("points", (int)psResearch->researchPoints);
bool started = false;
for (int i = 0; i < game.maxPlayers; i++)
{
if (aiCheckAlliances(player, i) || player == i)
{
int bits = asPlayerResList[i][psResearch->index].ResearchStatus;
started = started || (bits & STARTED_RESEARCH) || (bits & STARTED_RESEARCH_PENDING) || (bits & RESBITS_PENDING_ONLY);
}
}
value.setProperty("started", started); // including whether an ally has started it
value.setProperty("done", IsResearchCompleted(&asPlayerResList[player][psResearch->index]));
value.setProperty("fullname", getName(psResearch->pName)); // temporary
value.setProperty("name", psResearch->pName); // will be changed to contain fullname
value.setProperty("id", psResearch->pName);
value.setProperty("type", SCRIPT_RESEARCH);
QScriptValue results = engine->newArray(psResearch->resultStrings.size());
for (int i = 0; i < psResearch->resultStrings.size(); i++)
{
results.setProperty(i, psResearch->resultStrings[i]);
}
value.setProperty("results", results);
return value;
}
//;; \subsection{Structure\label{objects:structure}}
//;; Describes a structure (building). It inherits all the properties of the base object (see below).
//;; In addition, the following properties are defined:
//;; \begin{description}
//;; \item[status] The completeness status of the structure. It will be one of BEING_BUILT and BUILT.
//;; \item[type] The type will always be STRUCTURE.
//;; \item[cost] What it would cost to build this structure. (3.2+ only)
//;; \item[stattype] The stattype defines the type of structure. It will be one of HQ, FACTORY, POWER_GEN, RESOURCE_EXTRACTOR,
//;; LASSAT, DEFENSE, WALL, RESEARCH_LAB, REPAIR_FACILITY, CYBORG_FACTORY, VTOL_FACTORY, REARM_PAD, SAT_UPLINK, GATE
//;; and COMMAND_CONTROL.
//;; \item[modules] If the stattype is set to one of the factories, POWER_GEN or RESEARCH_LAB, then this property is set to the
//;; number of module upgrades it has.
//;; \item[canHitAir] True if the structure has anti-air capabilities. (3.2+ only)
//;; \item[canHitGround] True if the structure has anti-ground capabilities. (3.2+ only)
//;; \item[isSensor] True if the structure has sensor ability. (3.2+ only)
//;; \item[isCB] True if the structure has counter-battery ability. (3.2+ only)
//;; \item[isRadarDetector] True if the structure has radar detector ability. (3.2+ only)
//;; \item[range] Maximum range of its weapons. (3.2+ only)
//;; \item[hasIndirect] One or more of the structure's weapons are indirect. (3.2+ only)
//;; \end{description}
QScriptValue convStructure(STRUCTURE *psStruct, QScriptEngine *engine)
{
bool aa = false;
bool ga = false;
bool indirect = false;
int range = -1;
for (int i = 0; i < psStruct->numWeaps; i++)
{
if (psStruct->asWeaps[i].nStat)
{
WEAPON_STATS *psWeap = &asWeaponStats[psStruct->asWeaps[i].nStat];
aa = aa || psWeap->surfaceToAir & SHOOT_IN_AIR;
ga = ga || psWeap->surfaceToAir & SHOOT_ON_GROUND;
indirect = indirect || psWeap->movementModel == MM_INDIRECT || psWeap->movementModel == MM_HOMINGINDIRECT;
range = MAX((int)psWeap->upgrade[psStruct->player].maxRange, range);
}
}
QScriptValue value = convObj(psStruct, engine);
value.setProperty("isCB", structCBSensor(psStruct), QScriptValue::ReadOnly);
value.setProperty("isSensor", structStandardSensor(psStruct), QScriptValue::ReadOnly);
value.setProperty("canHitAir", aa, QScriptValue::ReadOnly);
value.setProperty("canHitGround", ga, QScriptValue::ReadOnly);
value.setProperty("hasIndirect", indirect, QScriptValue::ReadOnly);
value.setProperty("isRadarDetector", objRadarDetector(psStruct), QScriptValue::ReadOnly);
value.setProperty("range", range, QScriptValue::ReadOnly);
value.setProperty("status", (int)psStruct->status, QScriptValue::ReadOnly);
value.setProperty("health", 100 * psStruct->body / MAX(1, structureBody(psStruct)), QScriptValue::ReadOnly);
value.setProperty("cost", psStruct->pStructureType->powerToBuild, QScriptValue::ReadOnly);
switch (psStruct->pStructureType->type) // don't bleed our source insanities into the scripting world
{
case REF_WALL:
case REF_WALLCORNER:
case REF_GATE:
value.setProperty("stattype", (int)REF_WALL, QScriptValue::ReadOnly);
break;
case REF_BLASTDOOR:
case REF_DEFENSE:
if (isLasSat(psStruct->pStructureType))
{
value.setProperty("stattype", (int)FAKE_REF_LASSAT, QScriptValue::ReadOnly);
break;
}
value.setProperty("stattype", (int)REF_DEFENSE, QScriptValue::ReadOnly);
break;
default:
value.setProperty("stattype", (int)psStruct->pStructureType->type, QScriptValue::ReadOnly);
break;
}
if (psStruct->pStructureType->type == REF_FACTORY || psStruct->pStructureType->type == REF_CYBORG_FACTORY
|| psStruct->pStructureType->type == REF_VTOL_FACTORY
|| psStruct->pStructureType->type == REF_RESEARCH
|| psStruct->pStructureType->type == REF_POWER_GEN)
{
value.setProperty("modules", psStruct->capacity, QScriptValue::ReadOnly);
}
else
{
value.setProperty("modules", QScriptValue::NullValue);
}
QScriptValue weaponlist = engine->newArray(psStruct->numWeaps);
for (int j = 0; j < psStruct->numWeaps; j++)
{
QScriptValue weapon = engine->newObject();
const WEAPON_STATS *psStats = asWeaponStats + psStruct->asWeaps[j].nStat;
weapon.setProperty("name", psStats->pName, QScriptValue::ReadOnly);
weapon.setProperty("lastFired", psStruct->asWeaps[j].lastFired, QScriptValue::ReadOnly);
weaponlist.setProperty(j, weapon, QScriptValue::ReadOnly);
}
value.setProperty("weapons", weaponlist, QScriptValue::ReadOnly);
return value;
}
//;; \subsection{Feature}
//;; Describes a feature (a \emph{game object} not owned by any player). It inherits all the properties of the base object (see below).
//;; In addition, the following properties are defined:
//;; \begin{description}
//;; \item[type] It will always be FEATURE.
//;; \item[stattype] The type of feature. Defined types are OIL_RESOURCE, OIL_DRUM and ARTIFACT.
//;; \item[damageable] Can this feature be damaged?
//;; \end{description}
QScriptValue convFeature(FEATURE *psFeature, QScriptEngine *engine)
{
QScriptValue value = convObj(psFeature, engine);
value.setProperty("health", 100 * psFeature->psStats->body / MAX(1, psFeature->body), QScriptValue::ReadOnly);
value.setProperty("damageable", psFeature->psStats->damageable, QScriptValue::ReadOnly);
value.setProperty("stattype", psFeature->psStats->subType, QScriptValue::ReadOnly);
return value;
}
//;; \subsection{Droid}
//;; Describes a droid. It inherits all the properties of the base object (see below).
//;; In addition, the following properties are defined:
//;; \begin{description}
//;; \item[type] It will always be DROID.
//;; \item[order] The current order of the droid. This is its plan. The following orders are defined:
//;; \begin{description}
//;; \item[DORDER_ATTACK] Order a droid to attack something.
//;; \item[DORDER_MOVE] Order a droid to move somewhere.
//;; \item[DORDER_SCOUT] Order a droid to move somewhere and stop to attack anything on the way.
//;; \item[DORDER_BUILD] Order a droid to build something.
//;; \item[DORDER_HELPBUILD] Order a droid to help build something.
//;; \item[DORDER_LINEBUILD] Order a droid to build something repeatedly in a line.
//;; \item[DORDER_REPAIR] Order a droid to repair something.
//;; \item[DORDER_RETREAT] Order a droid to retreat back to HQ.
//;; \item[DORDER_PATROL] Order a droid to patrol.
//;; \item[DORDER_DEMOLISH] Order a droid to demolish something.
//;; \item[DORDER_EMBARK] Order a droid to embark on a transport.
//;; \item[DORDER_DISEMBARK] Order a transport to disembark its units at the given position.
//;; \item[DORDER_FIRESUPPORT] Order a droid to fire at whatever the target sensor is targeting. (3.2+ only)
//;; \item[DORDER_STOP] Order a droid to stop whatever it is doing. (3.2+ only)
//;; \item[DORDER_RTR] Order a droid to return for repairs. (3.2+ only)
//;; \item[DORDER_RTB] Order a droid to return to base. (3.2+ only)
//;; \item[DORDER_HOLD] Order a droid to hold its position. (3.2+ only)
//;; \item[DORDER_REARM] Order a VTOL droid to rearm. If given a target, will go to specified rearm pad. If not, will go to nearest rearm pad. (3.2+ only)
//;; \item[DORDER_OBSERVE] Order a droid to keep a target in sensor view. (3.2+ only)
//;; \item[DORDER_RECOVER] Order a droid to pick up something. (3.2+ only)
//;; \item[DORDER_RECYCLE] Order a droid to factory for recycling. (3.2+ only)
//;; \end{description}
//;; \item[action] The current action of the droid. This is how it intends to carry out its plan. The
//;; C++ code may change the action frequently as it tries to carry out its order. You never want to set
//;; the action directly, but it may be interesting to look at what it currently is.
//;; \item[droidType] The droid's type. The following types are defined:
//;; \begin{description}
//;; \item[DROID_CONSTRUCT] Trucks and cyborg constructors.
//;; \item[DROID_WEAPON] Droids with weapon turrets, except cyborgs.
//;; \item[DROID_PERSON] Non-cyborg two-legged units, like scavengers.
//;; \item[DROID_REPAIR] Units with repair turret, including repair cyborgs.
//;; \item[DROID_SENSOR] Units with sensor turret.
//;; \item[DROID_ECM] Unit with ECM jammer turret.
//;; \item[DROID_CYBORG] Cyborgs with weapons.
//;; \item[DROID_TRANSPORTER] Cyborg transporter.
//;; \item[DROID_SUPERTRANSPORTER] Droid transporter.
//;; \item[DROID_COMMAND] Commanders.
//;; \end{description}
//;; \item[group] The group this droid is member of. This is a numerical ID. If not a member of any group, will be set to \emph{null}.
//;; \item[armed] The percentage of weapon capability that is fully armed. Will be \emph{null} for droids other than VTOLs.
//;; \item[experience] Amount of experience this droid has, based on damage it has dealt to enemies.
//;; \item[cost] What it would cost to build the droid. (3.2+ only)
//;; \item[isVTOL] True if the droid is VTOL. (3.2+ only)
//;; \item[canHitAir] True if the droid has anti-air capabilities. (3.2+ only)
//;; \item[canHitGround] True if the droid has anti-ground capabilities. (3.2+ only)
//;; \item[isSensor] True if the droid has sensor ability. (3.2+ only)
//;; \item[isCB] True if the droid has counter-battery ability. (3.2+ only)
//;; \item[isRadarDetector] True if the droid has radar detector ability. (3.2+ only)
//;; \item[hasIndirect] One or more of the droid's weapons are indirect. (3.2+ only)
//;; \item[range] Maximum range of its weapons. (3.2+ only)
//;; \item[body] The body component of the droid. (3.2+ only)
//;; \item[propulsion] The propulsion component of the droid. (3.2+ only)
//;; \item[weapons] The weapon components of the droid, as an array. Contains 'name', 'id', 'armed' percentage and 'lastFired' properties. (3.2+ only)
//;; \item[cargoCapacity] Defined for transporters only: Total cargo capacity (number of items that will fit may depend on their size). (3.2+ only)
//;; \item[cargoSpace] Defined for transporters only: Cargo capacity left. (3.2+ only)
//;; \item[cargoCount] Defined for transporters only: Number of individual \emph{items} in the cargo hold. (3.2+ only)
//;; \item[cargoSize] The amount of cargo space the droid will take inside a transport. (3.2+ only)
//;; \end{description}
QScriptValue convDroid(DROID *psDroid, QScriptEngine *engine)
{
bool aa = false;
bool ga = false;
bool indirect = false;
int range = -1;
const BODY_STATS *psBodyStats = &asBodyStats[psDroid->asBits[COMP_BODY].nStat];
for (int i = 0; i < psDroid->numWeaps; i++)
{
if (psDroid->asWeaps[i].nStat)
{
WEAPON_STATS *psWeap = &asWeaponStats[psDroid->asWeaps[i].nStat];
aa = aa || psWeap->surfaceToAir & SHOOT_IN_AIR;
ga = ga || psWeap->surfaceToAir & SHOOT_ON_GROUND;
indirect = indirect || psWeap->movementModel == MM_INDIRECT || psWeap->movementModel == MM_HOMINGINDIRECT;
range = MAX((int)psWeap->upgrade[psDroid->player].maxRange, range);
}
}
DROID_TYPE type = psDroid->droidType;
QScriptValue value = convObj(psDroid, engine);
value.setProperty("action", (int)psDroid->action, QScriptValue::ReadOnly);
if (range >= 0)
{
value.setProperty("range", range, QScriptValue::ReadOnly);
}
else
{
value.setProperty("range", QScriptValue::NullValue);
}
value.setProperty("order", (int)psDroid->order.type, QScriptValue::ReadOnly);
value.setProperty("cost", calcDroidPower(psDroid), QScriptValue::ReadOnly);
value.setProperty("hasIndirect", indirect, QScriptValue::ReadOnly);
switch (psDroid->droidType) // hide some engine craziness
{
case DROID_CYBORG_CONSTRUCT:
type = DROID_CONSTRUCT; break;
case DROID_CYBORG_SUPER:
type = DROID_CYBORG; break;
case DROID_DEFAULT:
type = DROID_WEAPON; break;
case DROID_CYBORG_REPAIR:
type = DROID_REPAIR; break;
default:
break;
}
value.setProperty("bodySize", psBodyStats->size, QScriptValue::ReadOnly);
if (psDroid->droidType == DROID_TRANSPORTER || psDroid->droidType == DROID_SUPERTRANSPORTER)
{
value.setProperty("cargoCapacity", TRANSPORTER_CAPACITY, QScriptValue::ReadOnly);
value.setProperty("cargoLeft", calcRemainingCapacity(psDroid), QScriptValue::ReadOnly);
value.setProperty("cargoCount", psDroid->psGroup->getNumMembers(), QScriptValue::ReadOnly);
}
value.setProperty("isRadarDetector", objRadarDetector(psDroid), QScriptValue::ReadOnly);
value.setProperty("isCB", cbSensorDroid(psDroid), QScriptValue::ReadOnly);
value.setProperty("isSensor", standardSensorDroid(psDroid), QScriptValue::ReadOnly);
value.setProperty("canHitAir", aa, QScriptValue::ReadOnly);
value.setProperty("canHitGround", ga, QScriptValue::ReadOnly);
value.setProperty("isVTOL", isVtolDroid(psDroid), QScriptValue::ReadOnly);
value.setProperty("droidType", (int)type, QScriptValue::ReadOnly);
value.setProperty("experience", (double)psDroid->experience / 65536.0, QScriptValue::ReadOnly);
value.setProperty("health", 100.0 / (double)psDroid->originalBody * (double)psDroid->body, QScriptValue::ReadOnly);
value.setProperty("body", asBodyStats[psDroid->asBits[COMP_BODY].nStat].pName, QScriptValue::ReadOnly);
value.setProperty("propulsion", asPropulsionStats[psDroid->asBits[COMP_PROPULSION].nStat].pName, QScriptValue::ReadOnly);
value.setProperty("armed", 0.0, QScriptValue::ReadOnly); // deprecated!
QScriptValue weaponlist = engine->newArray(psDroid->numWeaps);
for (int j = 0; j < psDroid->numWeaps; j++)
{
int armed = droidReloadBar(psDroid, &psDroid->asWeaps[j], j);
QScriptValue weapon = engine->newObject();
const WEAPON_STATS *psStats = asWeaponStats + psDroid->asWeaps[j].nStat;
weapon.setProperty("name", psStats->pName, QScriptValue::ReadOnly);
weapon.setProperty("lastFired", psDroid->asWeaps[j].lastFired, QScriptValue::ReadOnly);
weapon.setProperty("armed", armed, QScriptValue::ReadOnly);
weaponlist.setProperty(j, weapon, QScriptValue::ReadOnly);
}
value.setProperty("weapons", weaponlist, QScriptValue::ReadOnly);
value.setProperty("cargoSize", transporterSpaceRequired(psDroid), QScriptValue::ReadOnly);
return value;
}
//;; \subsection{Base Object}
//;; Describes a basic object. It will always be a droid, structure or feature, but sometimes
//;; the difference does not matter, and you can treat any of them simply as a basic object.
//;; The following properties are defined:
//;; \begin{description}
//;; \item[type] It will be one of DROID, STRUCTURE or FEATURE.
//;; \item[id] The unique ID of this object.
//;; \item[x] X position of the object in tiles.
//;; \item[y] Y position of the object in tiles.
//;; \item[z] Z (height) position of the object in tiles.
//;; \item[player] The player owning this object.
//;; \item[selected] A boolean saying whether 'selectedPlayer' has selected this object.
//;; \item[name] A user-friendly name for this object.
//;; \item[health] Percentage that this object is damaged (where 100% means not damaged at all).
//;; \item[armour] Amount of armour points that protect against kinetic weapons.
//;; \item[thermal] Amount of thermal protection that protect against heat based weapons.
//;; \item[born] The game time at which this object was produced or came into the world. (3.2+ only)
//;; \end{description}
QScriptValue convObj(BASE_OBJECT *psObj, QScriptEngine *engine)
{
QScriptValue value = engine->newObject();
ASSERT_OR_RETURN(value, psObj, "No object for conversion");
value.setProperty("id", psObj->id, QScriptValue::ReadOnly);
value.setProperty("x", map_coord(psObj->pos.x), QScriptValue::ReadOnly);
value.setProperty("y", map_coord(psObj->pos.y), QScriptValue::ReadOnly);
value.setProperty("z", map_coord(psObj->pos.z), QScriptValue::ReadOnly);
value.setProperty("player", psObj->player, QScriptValue::ReadOnly);
value.setProperty("armour", objArmour(psObj, WC_KINETIC), QScriptValue::ReadOnly);
value.setProperty("thermal", objArmour(psObj, WC_HEAT), QScriptValue::ReadOnly);
value.setProperty("type", psObj->type, QScriptValue::ReadOnly);
value.setProperty("selected", psObj->selected, QScriptValue::ReadOnly);
value.setProperty("name", objInfo(psObj), QScriptValue::ReadOnly);
value.setProperty("born", psObj->born, QScriptValue::ReadOnly);
GROUPMAP *psMap = groups.value(engine);
if (psMap->contains(psObj))
{
int group = psMap->value(psObj);
value.setProperty("group", group, QScriptValue::ReadOnly);
}
else
{
value.setProperty("group", QScriptValue::NullValue);
}
return value;
}
//;; \subsection{Template}
//;; Describes a template type. Templates are droid designs that a player has created. This type is experimental
//;; and subject to change.
//;; The following properties are defined:
//;; \begin{description}
//;; \item[id] The unique ID of this object.
//;; \item[name] Name of the template.
//;; \item[cost] The power cost of the template if put into production.
//;; \item[droidType] The type of droid that would be created.
//;; \item[body] The name of the body type.
//;; \item[propulsion] The name of the propulsion type.
//;; \item[brain] The name of the brain type.
//;; \item[repair] The name of the repair type.
//;; \item[ecm] The name of the ECM (electronic counter-measure) type.
//;; \item[construct] The name of the construction type.
//;; \item[weapons] An array of weapon names attached to this template.
//;; \end{description}
QScriptValue convTemplate(DROID_TEMPLATE *psTempl, QScriptEngine *engine)
{
QScriptValue value = engine->newObject();
ASSERT_OR_RETURN(value, psTempl, "No object for conversion");
value.setProperty("id", psTempl->multiPlayerID, QScriptValue::ReadOnly);
value.setProperty("name", psTempl->pName, QScriptValue::ReadOnly);
value.setProperty("points", psTempl->buildPoints, QScriptValue::ReadOnly);
value.setProperty("power", psTempl->powerPoints, QScriptValue::ReadOnly); // deprecated
value.setProperty("cost", psTempl->powerPoints, QScriptValue::ReadOnly);
value.setProperty("droidType", psTempl->droidType, QScriptValue::ReadOnly);
value.setProperty("body", (asBodyStats + psTempl->asParts[COMP_BODY])->pName, QScriptValue::ReadOnly);
value.setProperty("propulsion", (asPropulsionStats + psTempl->asParts[COMP_PROPULSION])->pName, QScriptValue::ReadOnly);
value.setProperty("brain", (asBrainStats + psTempl->asParts[COMP_BRAIN])->pName, QScriptValue::ReadOnly);
value.setProperty("repair", (asRepairStats + psTempl->asParts[COMP_REPAIRUNIT])->pName, QScriptValue::ReadOnly);
value.setProperty("ecm", (asECMStats + psTempl->asParts[COMP_ECM])->pName, QScriptValue::ReadOnly);
value.setProperty("sensor", (asSensorStats + psTempl->asParts[COMP_SENSOR])->pName, QScriptValue::ReadOnly);
value.setProperty("construct", (asConstructStats + psTempl->asParts[COMP_CONSTRUCT])->pName, QScriptValue::ReadOnly);
QScriptValue weaponlist = engine->newArray(psTempl->numWeaps);
for (int j = 0; j < psTempl->numWeaps; j++)
{
weaponlist.setProperty(j, QScriptValue((asWeaponStats + psTempl->asWeaps[j])->pName), QScriptValue::ReadOnly);
}
value.setProperty("weapons", weaponlist);
return value;
}
QScriptValue convMax(BASE_OBJECT *psObj, QScriptEngine *engine)
{
if (!psObj)
{
return QScriptValue::NullValue;
}
switch (psObj->type)
{
case OBJ_DROID: return convDroid((DROID *)psObj, engine);
case OBJ_STRUCTURE: return convStructure((STRUCTURE *)psObj, engine);
case OBJ_FEATURE: return convFeature((FEATURE *)psObj, engine);
default: ASSERT(false, "No such supported object type"); return convObj(psObj, engine);
}
}
BASE_OBJECT *IdToObject(OBJECT_TYPE type, int id, int player)
{
switch (type)
{
case OBJ_DROID: return IdToDroid(id, player);
case OBJ_FEATURE: return IdToFeature(id, player);
case OBJ_STRUCTURE: return IdToStruct(id, player);
default: return NULL;
}
}
// ----------------------------------------------------------------------------------------
// Group system
//
bool loadGroup(QScriptEngine *engine, int groupId, int objId)
{
BASE_OBJECT *psObj = IdToPointer(objId, ANYPLAYER);
return groupAddObject(psObj, groupId, engine);
}
bool saveGroups(WzConfig &ini, QScriptEngine *engine)
{
// Save group info as a list of group memberships for each droid
GROUPMAP *psMap = groups.value(engine);
for (GROUPMAP::const_iterator i = psMap->constBegin(); i != psMap->constEnd(); ++i)
{
QStringList value;
BASE_OBJECT *psObj = i.key();
if (ini.contains(QString::number(psObj->id)))
{
value.push_back(ini.value(QString::number(psObj->id)).toString());
}
value.push_back(QString::number(i.value()));
ini.setValue(QString::number(psObj->id), value);
}
return true;
}
// ----------------------------------------------------------------------------------------
// Label system (function defined in qtscript.h header)
//
// Load labels
bool loadLabels(const char *filename)
{
int groupidx = -1;
if (!PHYSFS_exists(filename))
{
debug(LOG_SAVE, "No %s found -- not adding any labels", filename);
return false;
}
WzConfig ini(filename, WzConfig::ReadOnly);
labels.clear();
QStringList list = ini.childGroups();
debug(LOG_SAVE, "Loading %d labels...", list.size());
for (int i = 0; i < list.size(); ++i)
{
ini.beginGroup(list[i]);
labeltype p;
QString label(ini.value("label").toString());
if (labels.contains(label))
{
debug(LOG_ERROR, "Duplicate label found");
}
else if (list[i].startsWith("position"))
{
p.p1 = ini.vector2i("pos");
p.p2 = p.p1;
p.type = SCRIPT_POSITION;
p.player = ALL_PLAYERS;
p.id = -1;
labels.insert(label, p);
}
else if (list[i].startsWith("area"))
{
p.p1 = ini.vector2i("pos1");
p.p2 = ini.vector2i("pos2");
p.type = SCRIPT_AREA;
p.player = ini.value("player", ALL_PLAYERS).toInt();
p.id = ini.value("triggered", -1).toInt();
labels.insert(label, p);
}
else if (list[i].startsWith("object"))
{
p.id = ini.value("id").toInt();
p.type = ini.value("type").toInt();
p.player = ini.value("player").toInt();
labels.insert(label, p);
}
else if (list[i].startsWith("group"))
{
p.id = groupidx--;
p.type = SCRIPT_GROUP;
p.player = ini.value("player").toInt();
QStringList list = ini.value("members").toStringList();
for (QStringList::iterator j = list.begin(); j != list.end(); j++)
{
int id = (*j).toInt();
BASE_OBJECT *psObj = IdToPointer(id, p.player);
ASSERT(psObj, "Unit %d belonging to player %d not found from label %s",
id, p.player, list[i].toUtf8().constData());
p.idlist += id;
}
labels.insert(label, p);
}
else
{
debug(LOG_ERROR, "Misnamed group in %s", filename);
}
ini.endGroup();
}
return true;
}
bool writeLabels(const char *filename)
{
int c[4]; // make unique, incremental section names
memset(c, 0, sizeof(c));
WzConfig ini(filename);
for (LABELMAP::const_iterator i = labels.constBegin(); i != labels.constEnd(); i++)
{
QString key = i.key();
labeltype l = i.value();
if (l.type == SCRIPT_POSITION)
{
ini.beginGroup("position_" + QString::number(c[0]++));
ini.setVector2i("pos", l.p1);
ini.setValue("label", key);
ini.endGroup();
}
else if (l.type == SCRIPT_AREA)
{
ini.beginGroup("area_" + QString::number(c[1]++));
ini.setVector2i("pos1", l.p1);
ini.setVector2i("pos2", l.p2);
ini.setValue("label", key);
ini.setValue("player", l.player);
ini.setValue("triggered", l.id);
ini.endGroup();
}
else if (l.type == SCRIPT_GROUP)
{
ini.beginGroup("group_" + QString::number(c[2]++));
ini.setValue("player", l.player);
QStringList list;
for (int i = 0; i < l.idlist.size(); i++)
{
list += QString::number(l.idlist[i]);
}
ini.setValue("members", list);
ini.setValue("label", key);
ini.endGroup();
}
else
{
ini.beginGroup("object_" + QString::number(c[3]++));
ini.setValue("id", l.id);
ini.setValue("player", l.player);
ini.setValue("type", l.type);
ini.setValue("label", key);
ini.endGroup();
}
}
return true;
}
// ----------------------------------------------------------------------------------------
// Script functions
//
// All script functions should be prefixed with "js_" then followed by same name as in script.
//-- \subsection{getWeaponInfo(weapon id)}
//-- Return information about a particular weapon type. DEPRECATED - query the Stats object instead.
static QScriptValue js_getWeaponInfo(QScriptContext *context, QScriptEngine *engine)
{
QString id = context->argument(0).toString();
int idx = getCompFromName(COMP_WEAPON, id.toUtf8().constData());
SCRIPT_ASSERT(context, idx >= 0, "No such weapon: %s", id.toUtf8().constData());
WEAPON_STATS *psStats = asWeaponStats + idx;
QScriptValue info = engine->newObject();
info.setProperty("id", id);
info.setProperty("name", getStatName(psStats));
info.setProperty("impactClass", psStats->weaponClass == WC_KINETIC ? "KINETIC" : "HEAT");
info.setProperty("damage", psStats->base.damage);
info.setProperty("firePause", psStats->base.firePause);
info.setProperty("fireOnMove", psStats->fireOnMove);
return QScriptValue(info);
}
//-- \subsection{resetArea(label[, filter])}
//-- Reset the trigger on an area. Next time a unit enters the area, it will trigger
//-- an area event. Optionally add a filter on it in the second parameter, which can
//-- be a specific player to watch for, or ALL_PLAYERS by default.
//-- This is a fast operation of O(log n) algorithmic complexity.
static QScriptValue js_resetArea(QScriptContext *context, QScriptEngine *)
{
QString labelName = context->argument(0).toString();
SCRIPT_ASSERT(context, labels.contains(labelName), "Label %s not found", labelName.toUtf8().constData());
labeltype &l = labels[labelName];
l.id = -1; // make active again
if (context->argumentCount() > 1)
{
l.player = context->argument(1).toInt32();
}
return QScriptValue();
}
//-- \subsection{enumLabels([filter])}
//-- Returns a string list of labels that exist for this map. The optional filter
//-- parameter can be used to only return labels of one specific type. (3.2+ only)
static QScriptValue js_enumLabels(QScriptContext *context, QScriptEngine *engine)
{
QStringList matches;
if (context->argumentCount() > 0) // filter
{
SCRIPT_TYPE type = (SCRIPT_TYPE)context->argument(0).toInt32();
for (LABELMAP::iterator i = labels.begin(); i != labels.end(); i++)
{
labeltype &l = (*i);
if (l.type == type)
{
matches += i.key();
}
}
}
else // fast path, give all
{
matches = labels.keys();
}
QScriptValue result = engine->newArray(matches.size());
for (int i = 0; i < matches.size(); i++)
{
result.setProperty(i, QScriptValue(matches[i]), QScriptValue::ReadOnly);
}
return result;
}
//-- \subsection{addLabel(object, label)}
//-- Add a label to a game object. If there already is a label by that name, it is overwritten.
//-- This is a fast operation of O(log n) algorithmic complexity.
static QScriptValue js_addLabel(QScriptContext *context, QScriptEngine *engine)
{
struct labeltype value;
QScriptValue qval = context->argument(0);
value.type = qval.property("type").toInt32();
value.id = qval.property("id").toInt32();
value.player = qval.property("player").toInt32();
value.p1.x = world_coord(qval.property("x").toInt32());
value.p1.y = world_coord(qval.property("y").toInt32());
value.p2.x = world_coord(qval.property("x2").toInt32());
value.p2.y = world_coord(qval.property("y2").toInt32());
if (value.type == OBJ_DROID || value.type == OBJ_STRUCTURE || value.type == OBJ_FEATURE)
{
BASE_OBJECT *psObj = IdToObject((OBJECT_TYPE)value.type, value.id, value.player);
SCRIPT_ASSERT(context, psObj, "Object id %d not found belonging to player %d", value.id, value.player);
}
QString key = context->argument(1).toString();
labels.insert(key, value);
updateLabelModel();
return QScriptValue();
}
//-- \subsection{removeLabel(label)}
//-- Remove a label from the game. Returns the number of labels removed, which should normally be
//-- either 1 (label found) or 0 (label not found).
static QScriptValue js_removeLabel(QScriptContext *context, QScriptEngine *engine)
{
QString key = context->argument(0).toString();
int result = labels.remove(key);
updateLabelModel();
return QScriptValue(result);
}
//-- \subsection{getLabel(object)}
//-- Get a label string belonging to a game object. If the object has multiple labels, only the first
//-- label found will be returned. If the object has no labels, null is returned.
//-- This is a relatively slow operation of O(n) algorithmic complexity.
static QScriptValue js_getLabel(QScriptContext *context, QScriptEngine *engine)
{
struct labeltype value;
QScriptValue objparam = context->argument(0);
value.id = objparam.property("id").toInt32();
value.player = objparam.property("player").toInt32();
value.type = (OBJECT_TYPE)objparam.property("type").toInt32();
QString label = labels.key(value, QString());
if (!label.isEmpty())
{
return QScriptValue(label);
}
return QScriptValue::NullValue;
}
//-- \subsection{getObject(label | x, y | type, player, id)}
//-- Fetch something denoted by a label, a map position or its object ID. A label refers to an area,
//-- a position or a \emph{game object} on the map defined using the map editor and stored
//-- together with the map. In this case, the only argument is a text label. The function
//-- returns an object that has a type variable defining what it is (in case this is
//-- unclear). This type will be one of DROID, STRUCTURE, FEATURE, AREA, GROUP or POSITION.
//-- The AREA has defined 'x', 'y', 'x2', and 'y2', while POSITION has only defined 'x' and 'y'.
//-- The GROUP type has defined 'type' and 'id' of the group, which can be passed to enumGroup().
//-- This is a fast operation of O(log n) algorithmic complexity. If the label is not found, an
//-- undefined value is returned. If whatever object the label should point at no longer exists,
//-- a null value is returned.
//-- You can also fetch a STRUCTURE or FEATURE type game object from a given map position (if any).
//-- This is a very fast operation of O(1) algorithmic complexity. Droids cannot be fetched in this
//-- manner, since they do not a unique placement on map tiles. Finally, you can fetch an object using
//-- its ID, in which case you need to pass its type, owner and unique object ID. This is an
//-- operation of O(n) algorithmic complexity.
static QScriptValue js_getObject(QScriptContext *context, QScriptEngine *engine)
{
if (context->argumentCount() == 2) // get at position case
{
int x = context->argument(0).toInt32();
int y = context->argument(1).toInt32();
SCRIPT_ASSERT(context, tileOnMap(x, y), "Map position (%d, %d) not on the map!", x, y);
const MAPTILE *psTile = mapTile(x, y);
return QScriptValue(convMax(psTile->psObject, engine));