forked from Warzone2100/warzone2100
-
Notifications
You must be signed in to change notification settings - Fork 0
/
research.cpp
1397 lines (1247 loc) · 38.2 KB
/
research.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) 1999-2004 Eidos Interactive
Copyright (C) 2005-2019 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
*/
/*
* Research.c
*
* Research tree and functions!
*
*/
#include <string.h>
#include <map>
#include "lib/framework/frame.h"
#include "lib/netplay/netplay.h"
#include "lib/ivis_opengl/imd.h"
#include "objects.h"
#include "lib/gamelib/gtime.h"
#include "research.h"
#include "message.h"
#include "lib/sound/audio.h"
#include "lib/sound/audio_id.h"
#include "lib/script/script.h"
#include "hci.h"
#include "console.h"
#include "cmddroid.h"
#include "power.h"
#include "mission.h"
#include "frend.h" // frontend ids.
#include "intimage.h"
#include "multiplay.h"
#include "template.h"
#include "qtscript.h"
#include "stats.h"
// The stores for the research stats
std::vector<RESEARCH> asResearch;
//used for Callbacks to say which topic was last researched
RESEARCH *psCBLastResearch;
STRUCTURE *psCBLastResStructure;
SDWORD CBResFacilityOwner;
//List of pointers to arrays of PLAYER_RESEARCH[numResearch] for each player
std::vector<PLAYER_RESEARCH> asPlayerResList[MAX_PLAYERS];
/* Default level of sensor, Repair and ECM */
UDWORD aDefaultSensor[MAX_PLAYERS];
UDWORD aDefaultECM[MAX_PLAYERS];
UDWORD aDefaultRepair[MAX_PLAYERS];
//set the iconID based on the name read in in the stats
static UWORD setIconID(const char *pIconName, const char *pName);
static void replaceComponent(COMPONENT_STATS *pNewComponent, COMPONENT_STATS *pOldComponent,
UBYTE player);
static bool checkResearchName(RESEARCH *psRes, UDWORD numStats);
//flag that indicates whether the player can self repair
static UBYTE bSelfRepair[MAX_PLAYERS];
static void replaceDroidComponent(DROID *pList, UDWORD oldType, UDWORD oldCompInc,
UDWORD newCompInc);
static void replaceStructureComponent(STRUCTURE *pList, UDWORD oldType, UDWORD oldCompInc,
UDWORD newCompInc, UBYTE player);
static void switchComponent(DROID *psDroid, UDWORD oldType, UDWORD oldCompInc,
UDWORD newCompInc);
static void replaceTransDroidComponents(DROID *psTransporter, UDWORD oldType,
UDWORD oldCompInc, UDWORD newCompInc);
bool researchInitVars()
{
psCBLastResearch = nullptr;
psCBLastResStructure = nullptr;
CBResFacilityOwner = -1;
asResearch.clear();
for (int i = 0; i < MAX_PLAYERS; i++)
{
bSelfRepair[i] = false;
aDefaultSensor[i] = 0;
aDefaultECM[i] = 0;
aDefaultRepair[i] = 0;
}
return true;
}
/** Load the research stats */
bool loadResearch(WzConfig &ini)
{
ASSERT(ini.isAtDocumentRoot(), "WzConfig instance is in the middle of traversal");
std::vector<WzString> list = ini.childGroups();
PLAYER_RESEARCH dummy;
memset(&dummy, 0, sizeof(dummy));
std::vector<std::vector<WzString>> preResearch;
preResearch.resize(list.size());
for (size_t inc = 0; inc < list.size(); ++inc)
{
// HACK FIXME: the code assumes we have empty PLAYER_RESEARCH entries to throw around
for (auto &j : asPlayerResList)
{
j.push_back(dummy);
}
ini.beginGroup(list[inc]);
RESEARCH research;
research.index = inc;
research.name = ini.string("name");
research.id = list[inc];
//check the name hasn't been used already
ASSERT_OR_RETURN(false, checkResearchName(&research, inc), "Research name '%s' used already", getName(&research));
research.ref = REF_RESEARCH_START + inc;
research.results = ini.json("results", nlohmann::json::array());
//set subGroup icon
WzString subGroup = ini.value("subgroupIconID", "").toWzString();
if (subGroup.compare("") != 0)
{
research.subGroup = setIconID(subGroup.toUtf8().c_str(), getName(&research));
}
else
{
research.subGroup = NO_RESEARCH_ICON;
}
//set key topic
unsigned int keyTopic = ini.value("keyTopic", 0).toUInt();
ASSERT(keyTopic <= 1, "Invalid keyTopic for research topic - '%s' ", getName(&research));
if (keyTopic <= 1)
{
research.keyTopic = ini.value("keyTopic", 0).toUInt();
}
else
{
research.keyTopic = 0;
}
//set tech code
UBYTE techCode = ini.value("techCode", 0).toUInt();
ASSERT(techCode <= 1, "Invalid tech code for research topic - '%s' ", getName(&research));
if (techCode == 0)
{
research.techCode = TC_MAJOR;
}
else
{
research.techCode = TC_MINOR;
}
//set the iconID
WzString iconID = ini.value("iconID", "").toWzString();
if (iconID.compare("") != 0)
{
research.iconID = setIconID(iconID.toUtf8().c_str(), getName(&research));
}
else
{
research.iconID = NO_RESEARCH_ICON;
}
//get the IMDs used in the interface
WzString statID = ini.value("statID", "").toWzString();
research.psStat = nullptr;
if (statID.compare("") != 0)
{
//try find the structure stat with given name
research.psStat = getCompStatsFromName(statID);
ASSERT_OR_RETURN(false, research.psStat, "Could not find stats for %s research %s", statID.toUtf8().c_str(), getName(&research));
}
WzString imdName = ini.value("imdName", "").toWzString();
if (imdName.compare("") != 0)
{
research.pIMD = modelGet(imdName);
ASSERT(research.pIMD != nullptr, "Cannot find the research PIE '%s' for record '%s'", imdName.toUtf8().data(), getName(&research));
}
WzString imdName2 = ini.value("imdName2", "").toWzString();
if (imdName2.compare("") != 0)
{
research.pIMD2 = modelGet(imdName2);
ASSERT(research.pIMD2 != nullptr, "Cannot find the 2nd research '%s' PIE for record '%s'", imdName2.toUtf8().data(), getName(&research));
}
WzString msgName = ini.value("msgName", "").toWzString();
if (msgName.compare("") != 0)
{
//check its a major tech code
ASSERT(research.techCode == TC_MAJOR, "This research should not have a message associated with it, '%s' the message will be ignored!", getName(&research));
if (research.techCode == TC_MAJOR)
{
research.pViewData = getViewData(msgName);
}
}
//set the researchPoints
unsigned int resPoints = ini.value("researchPoints", 0).toUInt();
ASSERT_OR_RETURN(false, resPoints <= UWORD_MAX, "Research Points too high for research topic - '%s' ", getName(&research));
research.researchPoints = resPoints;
//set the research power
unsigned int resPower = ini.value("researchPower", 0).toUInt();
ASSERT_OR_RETURN(false, resPower <= UWORD_MAX, "Research Power too high for research topic - '%s' ", getName(&research));
research.researchPower = resPower;
//remember research pre-requisites for futher checking
preResearch[inc] = ini.value("requiredResearch").toWzStringList();
//set components results
std::vector<WzString> compResults = ini.value("resultComponents").toWzStringList();
for (size_t j = 0; j < compResults.size(); j++)
{
WzString compID = compResults[j].trimmed();
COMPONENT_STATS *pComp = getCompStatsFromName(compID);
if (pComp != nullptr)
{
research.componentResults.push_back(pComp);
}
else
{
ASSERT(false, "Invalid item '%s' in list of result components of research '%s' ", compID.toUtf8().c_str(), getName(&research));
}
}
//set replaced components
std::vector<WzString> replacedComp = ini.value("replacedComponents").toWzStringList();
for (size_t j = 0; j < replacedComp.size(); j++)
{
//read pair of components oldComponent:newComponent
std::vector<WzString> pair = replacedComp[j].split(":");
ASSERT(pair.size() == 2, "Invalid item '%s' in list of replaced components of research '%s'. Required format: 'oldItem:newItem, item1:item2'", replacedComp[j].toUtf8().c_str(), getName(&research));
if (pair.size() != 2)
{
continue; //skip invalid entries
}
WzString oldCompID = pair[0].trimmed();
WzString newCompID = pair[1].trimmed();
COMPONENT_STATS *oldComp = getCompStatsFromName(oldCompID);
if (oldComp == nullptr)
{
ASSERT(false, "Invalid item '%s' in list of replaced components of research '%s'. Wrong component code.", oldCompID.toUtf8().c_str(), getName(&research));
continue;
}
COMPONENT_STATS *newComp = getCompStatsFromName(newCompID);
if (newComp == nullptr)
{
ASSERT(false, "Invalid item '%s' in list of replaced components of research '%s'. Wrong component code.", newCompID.toUtf8().c_str(), getName(&research));
continue;
}
RES_COMP_REPLACEMENT replItem;
replItem.pOldComponent = oldComp;
replItem.pNewComponent = newComp;
research.componentReplacement.push_back(replItem);
}
//set redundant components
std::vector<WzString> redComp = ini.value("redComponents").toWzStringList();
for (size_t j = 0; j < redComp.size(); j++)
{
WzString compID = redComp[j].trimmed();
COMPONENT_STATS *pComp = getCompStatsFromName(compID);
if (pComp == nullptr)
{
ASSERT(false, "Invalid item '%s' in list of redundant components of research '%s' ", compID.toUtf8().c_str(), getName(&research));
}
else
{
research.pRedArtefacts.push_back(pComp);
}
}
//set result structures
std::vector<WzString> resStruct = ini.value("resultStructures").toWzStringList();
for (size_t j = 0; j < resStruct.size(); j++)
{
WzString strucID = resStruct[j].trimmed();
int structIndex = getStructStatFromName(strucID);
ASSERT(structIndex >= 0, "Invalid item '%s' in list of result structures of research '%s' ", strucID.toUtf8().c_str(), getName(&research));
if (structIndex >= 0)
{
research.pStructureResults.push_back(structIndex);
}
}
//set required structures
std::vector<WzString> reqStruct = ini.value("requiredStructures").toWzStringList();
for (size_t j = 0; j < reqStruct.size(); j++)
{
WzString strucID = reqStruct[j].trimmed();
int structIndex = getStructStatFromName(strucID.toUtf8().c_str());
ASSERT(structIndex >= 0, "Invalid item '%s' in list of required structures of research '%s' ", strucID.toUtf8().c_str(), getName(&research));
if (structIndex >= 0)
{
research.pStructList.push_back(structIndex);
}
}
//set redundant structures
std::vector<WzString> redStruct = ini.value("redStructures").toWzStringList();
for (size_t j = 0; j < redStruct.size(); j++)
{
WzString strucID = redStruct[j].trimmed();
int structIndex = getStructStatFromName(strucID.toUtf8().c_str());
ASSERT(structIndex >= 0, "Invalid item '%s' in list of redundant structures of research '%s' ", strucID.toUtf8().c_str(), getName(&research));
if (structIndex >= 0)
{
research.pRedStructs.push_back(structIndex);
}
}
asResearch.push_back(research);
ini.endGroup();
}
//Load and check research pre-requisites (need do it AFTER loading research items)
for (size_t inc = 0; inc < asResearch.size(); inc++)
{
std::vector<WzString> &preRes = preResearch[inc];
for (size_t j = 0; j < preRes.size(); j++)
{
WzString resID = preRes[j].trimmed();
RESEARCH *preResItem = getResearch(resID.toUtf8().c_str());
ASSERT(preResItem != nullptr, "Invalid item '%s' in list of pre-requisites of research '%s' ", resID.toUtf8().c_str(), getName(&asResearch[inc]));
if (preResItem != nullptr)
{
asResearch[inc].pPRList.push_back(preResItem->index);
}
}
}
return true;
}
bool researchAvailable(int inc, int playerID, QUEUE_MODE mode)
{
// Decide whether to use IsResearchCancelledPending/IsResearchStartedPending or IsResearchCancelled/IsResearchStarted.
bool (*IsResearchCancelledFunc)(PLAYER_RESEARCH const *) = IsResearchCancelledPending;
bool (*IsResearchStartedFunc)(PLAYER_RESEARCH const *) = IsResearchStartedPending;
if (mode == ModeImmediate)
{
IsResearchCancelledFunc = IsResearchCancelled;
IsResearchStartedFunc = IsResearchStarted;
}
UDWORD incPR, incS;
bool bPRFound, bStructFound;
// if its a cancelled topic - add to list
if (IsResearchCancelledFunc(&asPlayerResList[playerID][inc]))
{
return true;
}
// if the topic is possible and has not already been researched - add to list
if ((IsResearchPossible(&asPlayerResList[playerID][inc])))
{
if (!IsResearchCompleted(&asPlayerResList[playerID][inc])
&& !IsResearchStartedFunc(&asPlayerResList[playerID][inc]))
{
return true;
}
}
// if single player mode and key topic, then ignore cos can't do it!
if (!bMultiPlayer && asResearch[inc].keyTopic)
{
return false;
}
bool researchStarted = IsResearchStartedFunc(&asPlayerResList[playerID][inc]);
if (researchStarted)
{
STRUCTURE *psBuilding = findResearchingFacilityByResearchIndex(playerID, inc); // May fail to find the structure here, if the research is merely pending, not actually started.
if (psBuilding != nullptr && psBuilding->status == SS_BEING_BUILT)
{
researchStarted = false; // Although research is started, the facility is currently being upgraded or demolished, so we want to be able to research this elsewhere.
}
}
// make sure that the research is not completed or started by another researchfac
if (!IsResearchCompleted(&asPlayerResList[playerID][inc]) && !researchStarted)
{
// Research is not completed ... also it has not been started by another researchfac
// if there aren't any PR's - go to next topic
if (asResearch[inc].pPRList.empty())
{
return false;
}
// check for pre-requisites
bPRFound = true;
for (incPR = 0; incPR < asResearch[inc].pPRList.size(); incPR++)
{
if (IsResearchCompleted(&(asPlayerResList[playerID][asResearch[inc].pPRList[incPR]])) == 0)
{
// if haven't pre-requisite - quit checking rest
bPRFound = false;
break;
}
}
if (!bPRFound)
{
// if haven't pre-requisites, skip the rest of the checks
return false;
}
// check for structure effects
bStructFound = true;
for (incS = 0; incS < asResearch[inc].pStructList.size(); incS++)
{
if (!checkSpecificStructExists(asResearch[inc].pStructList[incS], playerID))
{
//if not built, quit checking
bStructFound = false;
break;
}
}
if (!bStructFound)
{
// if haven't all structs built, skip to next topic
return false;
}
return true;
}
return false;
}
/*
Function to check what can be researched for a particular player at any one
instant.
A topic can be researched if the playerRes 'possible' flag has been set (by script)
or if the research pre-req topics have been researched. A check is made for any
structures that are required to have been built for topics that do not have
the 'possible' flag set.
**NB** A topic with zero PR's can ONLY be researched once the 'possible' flag
has been set.
There can only be 'limit' number of entries
'topic' is the currently researched topic
*/
// NOTE by AJL may 99 - skirmish now has it's own version of this, skTopicAvail.
UWORD fillResearchList(UWORD *plist, UDWORD playerID, UWORD topic, UWORD limit)
{
UWORD inc, count = 0;
for (inc = 0; inc < asResearch.size(); inc++)
{
// if the inc matches the 'topic' - automatically add to the list
if (inc == topic || researchAvailable(inc, playerID, ModeQueue))
{
*plist++ = inc;
count++;
if (count == limit)
{
return count;
}
}
}
return count;
}
/* process the results of a completed research topic */
void researchResult(UDWORD researchIndex, UBYTE player, bool bDisplay, STRUCTURE *psResearchFacility, bool bTrigger)
{
RESEARCH *pResearch = &asResearch[researchIndex];
MESSAGE *pMessage;
//the message gets sent to console
char consoleMsg[MAX_RESEARCH_MSG_SIZE];
ASSERT_OR_RETURN(, researchIndex < asResearch.size(), "Invalid research index %u", researchIndex);
syncDebug("researchResult(%u, %u, …)", researchIndex, player);
MakeResearchCompleted(&asPlayerResList[player][researchIndex]);
//check for structures to be made available
for (unsigned short pStructureResult : pResearch->pStructureResults)
{
if (apStructTypeLists[player][pStructureResult] != REDUNDANT)
{
apStructTypeLists[player][pStructureResult] = AVAILABLE;
}
}
//check for structures to be made redundant
for (unsigned short pRedStruct : pResearch->pRedStructs)
{
apStructTypeLists[player][pRedStruct] = REDUNDANT;
}
//check for component replacement
if (!pResearch->componentReplacement.empty())
{
for (auto &ri : pResearch->componentReplacement)
{
COMPONENT_STATS *pOldComp = ri.pOldComponent;
replaceComponent(ri.pNewComponent, pOldComp, player);
apCompLists[player][pOldComp->compType][pOldComp->index] = REDUNDANT;
}
}
//check for artefacts to be made available
for (auto &componentResult : pResearch->componentResults)
{
//determine the type of artefact
COMPONENT_TYPE type = componentResult->compType;
//set the component state to AVAILABLE
int compInc = componentResult->index;
if (apCompLists[player][type][compInc] != REDUNDANT)
{
apCompLists[player][type][compInc] = AVAILABLE;
}
//check for default sensor
if (type == COMP_SENSOR && (asSensorStats + compInc)->location == LOC_DEFAULT)
{
aDefaultSensor[player] = compInc;
}
//check for default ECM
else if (type == COMP_ECM && (asECMStats + compInc)->location == LOC_DEFAULT)
{
aDefaultECM[player] = compInc;
}
//check for default Repair
else if (type == COMP_REPAIRUNIT && (asRepairStats + compInc)->location == LOC_DEFAULT)
{
aDefaultRepair[player] = compInc;
enableSelfRepair(player);
}
}
//check for artefacts to be made redundant
for (auto &pRedArtefact : pResearch->pRedArtefacts)
{
COMPONENT_TYPE type = pRedArtefact->compType;
apCompLists[player][type][pRedArtefact->index] = REDUNDANT;
}
//Add message to player's list if Major Topic
if ((pResearch->techCode == TC_MAJOR) && bDisplay)
{
//only play sound if major topic
if (player == selectedPlayer)
{
audio_QueueTrack(ID_SOUND_MAJOR_RESEARCH);
}
//check there is viewdata for the research topic - just don't add message if not!
if (pResearch->pViewData != nullptr)
{
pMessage = addMessage(MSG_RESEARCH, false, player);
if (pMessage != nullptr)
{
pMessage->pViewData = pResearch->pViewData;
jsDebugMessageUpdate();
}
}
}
else if (player == selectedPlayer && bDisplay)
{
audio_QueueTrack(ID_SOUND_RESEARCH_COMPLETED);
}
if (player == selectedPlayer && bDisplay)
{
//add console text message
if (pResearch->pViewData != nullptr)
{
snprintf(consoleMsg, MAX_RESEARCH_MSG_SIZE, _("Research completed: %s"), _(pResearch->pViewData->textMsg[0].toUtf8().c_str()));
addConsoleMessage(consoleMsg, LEFT_JUSTIFY, SYSTEM_MESSAGE);
}
else
{
addConsoleMessage(_("Research Completed"), LEFT_JUSTIFY, SYSTEM_MESSAGE);
}
}
if (psResearchFacility)
{
psResearchFacility->pFunctionality->researchFacility.psSubject = nullptr; // Make sure topic is cleared
}
if ((bMultiPlayer || player == selectedPlayer) && bTrigger)
{
psCBLastResearch = pResearch; // Fun with pointers. Throw them into some random global variable, and get Nexus to absorb them.
CBResFacilityOwner = player;
psCBLastResStructure = psResearchFacility;
eventFireCallbackTrigger((TRIGGER_TYPE)CALL_RESEARCHCOMPLETED);
psCBLastResStructure = nullptr;
CBResFacilityOwner = -1;
psCBLastResearch = nullptr;
}
triggerEventResearched(pResearch, psResearchFacility, player);
}
/*This function is called when the research files are reloaded*/
bool ResearchShutDown()
{
ResearchRelease();
return true;
}
/*This function is called when a game finishes*/
void ResearchRelease()
{
asResearch.clear();
for (auto &i : asPlayerResList)
{
i.clear();
}
}
/*puts research facility on hold*/
void holdResearch(STRUCTURE *psBuilding, QUEUE_MODE mode)
{
ASSERT_OR_RETURN(, psBuilding->pStructureType->type == REF_RESEARCH, "structure not a research facility");
RESEARCH_FACILITY *psResFac = &psBuilding->pFunctionality->researchFacility;
if (mode == ModeQueue)
{
sendStructureInfo(psBuilding, STRUCTUREINFO_HOLDRESEARCH, nullptr);
setStatusPendingHold(*psResFac);
return;
}
if (psResFac->psSubject)
{
//set the time the research facility was put on hold
psResFac->timeStartHold = gameTime;
//play audio to indicate on hold
if (psBuilding->player == selectedPlayer)
{
audio_PlayTrack(ID_SOUND_WINDOWCLOSE);
}
}
delPowerRequest(psBuilding);
}
/*release a research facility from hold*/
void releaseResearch(STRUCTURE *psBuilding, QUEUE_MODE mode)
{
ASSERT_OR_RETURN(, psBuilding->pStructureType->type == REF_RESEARCH, "structure not a research facility");
RESEARCH_FACILITY *psResFac = &psBuilding->pFunctionality->researchFacility;
if (mode == ModeQueue)
{
sendStructureInfo(psBuilding, STRUCTUREINFO_RELEASERESEARCH, nullptr);
setStatusPendingRelease(*psResFac);
return;
}
if (psResFac->psSubject && psResFac->timeStartHold)
{
//adjust the start time for the current subject
psResFac->timeStartHold = 0;
}
}
/*
Cancel All Research for player 0
*/
void CancelAllResearch(UDWORD pl)
{
STRUCTURE *psCurr;
for (psCurr = apsStructLists[pl]; psCurr != nullptr; psCurr = psCurr->psNext)
{
if (psCurr->pStructureType->type == REF_RESEARCH)
{
if (
(((RESEARCH_FACILITY *)psCurr->pFunctionality) != nullptr)
&& (((RESEARCH_FACILITY *)psCurr->pFunctionality)->psSubject != nullptr)
)
{
debug(LOG_NEVER, "canceling research for %p\n", static_cast<void *>(psCurr));
cancelResearch(psCurr, ModeQueue);
}
}
}
}
/** Sets the status of the topic to cancelled and stores the current research points accquired */
void cancelResearch(STRUCTURE *psBuilding, QUEUE_MODE mode)
{
UDWORD topicInc;
PLAYER_RESEARCH *pPlayerRes;
ASSERT_OR_RETURN(, psBuilding->pStructureType->type == REF_RESEARCH, "Structure not a research facility");
RESEARCH_FACILITY *psResFac = &psBuilding->pFunctionality->researchFacility;
if (!(RESEARCH *)psResFac->psSubject)
{
debug(LOG_SYNC, "Invalid research topic");
return;
}
topicInc = ((RESEARCH *)psResFac->psSubject)->index;
ASSERT_OR_RETURN(, topicInc <= asResearch.size(), "Invalid research topic %u (max %d)", topicInc, (int)asResearch.size());
pPlayerRes = &asPlayerResList[psBuilding->player][topicInc];
if (psBuilding->pStructureType->type == REF_RESEARCH)
{
if (mode == ModeQueue)
{
// Tell others that we want to stop researching something.
sendResearchStatus(psBuilding, topicInc, psBuilding->player, false);
// Immediately tell the UI that we can research this now. (But don't change the game state.)
MakeResearchCancelledPending(pPlayerRes);
setStatusPendingCancel(*psResFac);
return; // Wait for our message before doing anything. (Whatever this function does...)
}
//check if waiting to accrue power
if (pPlayerRes->currentPoints == 0)
{
// Reset this topic as not having been researched
ResetResearchStatus(pPlayerRes);
}
else
{
// Set the researched flag
MakeResearchCancelled(pPlayerRes);
}
// Initialise the research facility's subject
psResFac->psSubject = nullptr;
delPowerRequest(psBuilding);
}
}
/* For a given view data get the research this is related to */
RESEARCH *getResearchForMsg(const VIEWDATA *pViewData)
{
for (auto &inc : asResearch)
{
if (inc.pViewData == pViewData) // compare the pointer
{
return &inc;
}
}
return nullptr;
}
//set the iconID based on the name read in in the stats
static UWORD setIconID(const char *pIconName, const char *pName)
{
//compare the names with those created in 'Framer'
if (!strcmp(pIconName, "IMAGE_ROCKET"))
{
return IMAGE_ROCKET;
}
if (!strcmp(pIconName, "IMAGE_CANNON"))
{
return IMAGE_CANNON;
}
if (!strcmp(pIconName, "IMAGE_HOVERCRAFT"))
{
return IMAGE_HOVERCRAFT;
}
if (!strcmp(pIconName, "IMAGE_ECM"))
{
return IMAGE_ECM;
}
if (!strcmp(pIconName, "IMAGE_PLASCRETE"))
{
return IMAGE_PLASCRETE;
}
if (!strcmp(pIconName, "IMAGE_TRACKS"))
{
return IMAGE_TRACKS;
}
if (!strcmp(pIconName, "IMAGE_RES_DROIDTECH"))
{
return IMAGE_RES_DROIDTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_WEAPONTECH"))
{
return IMAGE_RES_WEAPONTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_COMPUTERTECH"))
{
return IMAGE_RES_COMPUTERTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_POWERTECH"))
{
return IMAGE_RES_POWERTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_SYSTEMTECH"))
{
return IMAGE_RES_SYSTEMTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_STRUCTURETECH"))
{
return IMAGE_RES_STRUCTURETECH;
}
if (!strcmp(pIconName, "IMAGE_RES_CYBORGTECH"))
{
return IMAGE_RES_CYBORGTECH;
}
if (!strcmp(pIconName, "IMAGE_RES_DEFENCE"))
{
return IMAGE_RES_DEFENCE;
}
if (!strcmp(pIconName, "IMAGE_RES_QUESTIONMARK"))
{
return IMAGE_RES_QUESTIONMARK;
}
if (!strcmp(pIconName, "IMAGE_RES_GRPACC"))
{
return IMAGE_RES_GRPACC;
}
if (!strcmp(pIconName, "IMAGE_RES_GRPUPG"))
{
return IMAGE_RES_GRPUPG;
}
if (!strcmp(pIconName, "IMAGE_RES_GRPREP"))
{
return IMAGE_RES_GRPREP;
}
if (!strcmp(pIconName, "IMAGE_RES_GRPROF"))
{
return IMAGE_RES_GRPROF;
}
if (!strcmp(pIconName, "IMAGE_RES_GRPDAM"))
{
return IMAGE_RES_GRPDAM;
}
// Add more names as images are created
ASSERT(false, "Invalid icon graphic %s for topic %s", pIconName, pName);
return NO_RESEARCH_ICON; // Should never get here.
}
SDWORD mapRIDToIcon(UDWORD rid)
{
switch (rid)
{
case RID_ROCKET:
return (IMAGE_ROCKET);
break;
case RID_CANNON:
return (IMAGE_CANNON);
break;
case RID_HOVERCRAFT:
return (IMAGE_HOVERCRAFT);
break;
case RID_ECM:
return (IMAGE_ECM);
break;
case RID_PLASCRETE:
return (IMAGE_PLASCRETE);
break;
case RID_TRACKS:
return (IMAGE_TRACKS);
break;
case RID_DROIDTECH:
return (IMAGE_RES_DROIDTECH);
break;
case RID_WEAPONTECH:
return (IMAGE_RES_WEAPONTECH);
break;
case RID_COMPUTERTECH:
return (IMAGE_RES_COMPUTERTECH);
break;
case RID_POWERTECH:
return (IMAGE_RES_POWERTECH);
break;
case RID_SYSTEMTECH:
return (IMAGE_RES_SYSTEMTECH);
break;
case RID_STRUCTURETECH:
return (IMAGE_RES_STRUCTURETECH);
break;
case RID_CYBORGTECH:
return (IMAGE_RES_CYBORGTECH);
break;
case RID_DEFENCE:
return (IMAGE_RES_DEFENCE);
break;
case RID_QUESTIONMARK:
return (IMAGE_RES_QUESTIONMARK);
break;
case RID_GRPACC:
return (IMAGE_RES_GRPACC);
break;
case RID_GRPUPG:
return (IMAGE_RES_GRPUPG);
break;
case RID_GRPREP:
return (IMAGE_RES_GRPREP);
break;
case RID_GRPROF:
return (IMAGE_RES_GRPROF);
break;
case RID_GRPDAM:
return (IMAGE_RES_GRPDAM);
break;
default:
ASSERT(false, "Weirdy mapping request for RID to icon");
return (-1); //pass back a value that can never have been set up
break;
}
}
SDWORD mapIconToRID(UDWORD iconID)
{
switch (iconID)
{
case IMAGE_ROCKET:
return (RID_ROCKET);
break;
case IMAGE_CANNON:
return (RID_CANNON);
break;
case IMAGE_HOVERCRAFT:
return (RID_HOVERCRAFT);
break;
case IMAGE_ECM:
return (RID_ECM);
break;
case IMAGE_PLASCRETE:
return (RID_PLASCRETE);
break;
case IMAGE_TRACKS:
return (RID_TRACKS);
break;
case IMAGE_RES_DROIDTECH:
return (RID_DROIDTECH);
break;
case IMAGE_RES_WEAPONTECH:
return (RID_WEAPONTECH);
break;
case IMAGE_RES_COMPUTERTECH:
return (RID_COMPUTERTECH);
break;
case IMAGE_RES_POWERTECH:
return (RID_POWERTECH);
break;
case IMAGE_RES_SYSTEMTECH:
return (RID_SYSTEMTECH);
break;
case IMAGE_RES_STRUCTURETECH:
return (RID_STRUCTURETECH);
break;
case IMAGE_RES_CYBORGTECH:
return (RID_CYBORGTECH);
break;
case IMAGE_RES_DEFENCE:
return (RID_DEFENCE);
break;
case IMAGE_RES_QUESTIONMARK:
return (RID_QUESTIONMARK);
break;
case IMAGE_RES_GRPACC:
return (RID_GRPACC);
break;
case IMAGE_RES_GRPUPG:
return (RID_GRPUPG);
break;