Repository navigation
Expand file tree
/
Copy pathAlienMission.cpp
More file actions
777 lines (740 loc) · 24.7 KB
/
Copy pathAlienMission.cpp
File metadata and controls
777 lines (740 loc) · 24.7 KB
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
/*
* Copyright 2010-2016 OpenXcom Developers.
*
* This file is part of OpenXcom.
*
* OpenXcom 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 3 of the License, or
* (at your option) any later version.
*
* OpenXcom 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 OpenXcom. If not, see <http://www.gnu.org/licenses/>.
*/
#include "AlienMission.h"
#include "AlienBase.h"
#include "Base.h"
#include "../fmath.h"
#include "../Engine/Exception.h"
#include "../Engine/Game.h"
#include "../Engine/Logger.h"
#include "../Engine/RNG.h"
#include "../Geoscape/Globe.h"
#include "../Mod/RuleAlienMission.h"
#include "../Mod/RuleRegion.h"
#include "../Mod/RuleCountry.h"
#include "../Mod/Mod.h"
#include "../Mod/RuleUfo.h"
#include "../Mod/UfoTrajectory.h"
#include "../Mod/RuleGlobe.h"
#include "../Mod/Texture.h"
#include "SavedGame.h"
#include "MissionSite.h"
#include "Ufo.h"
#include "Craft.h"
#include "Region.h"
#include "Country.h"
#include "Waypoint.h"
#include <assert.h>
#include <algorithm>
#include "../Mod/AlienDeployment.h"
namespace OpenXcom
{
AlienMission::AlienMission(const RuleAlienMission &rule) : _rule(rule), _nextWave(0), _nextUfoCounter(0), _spawnCountdown(0), _liveUfos(0), _uniqueID(0), _missionSiteZone(-1), _base(0)
{
// Empty by design.
}
AlienMission::~AlienMission()
{
// Empty by design.
}
class matchById: public std::unary_function<const AlienBase *, bool>
{
public:
/// Remember ID.
matchById(int id) : _id(id) { /* Empty by design. */ }
/// Match with stored ID.
bool operator()(const AlienBase *ab) const { return ab->getId() == _id; }
private:
int _id;
};
/**
* Loads the alien mission from a YAML file.
* @param node The YAML node containing the data.
* @param game The game data, required to locate the alien base.
*/
void AlienMission::load(const YAML::Node& node, SavedGame &game)
{
_region = node["region"].as<std::string>(_region);
_race = node["race"].as<std::string>(_race);
_nextWave = node["nextWave"].as<size_t>(_nextWave);
_nextUfoCounter = node["nextUfoCounter"].as<size_t>(_nextUfoCounter);
_spawnCountdown = node["spawnCountdown"].as<size_t>(_spawnCountdown);
_liveUfos = node["liveUfos"].as<size_t>(_liveUfos);
_uniqueID = node["uniqueID"].as<int>(_uniqueID);
if (const YAML::Node &base = node["alienBase"])
{
int id = base.as<int>();
std::vector<AlienBase*>::const_iterator found = std::find_if (game.getAlienBases()->begin(), game.getAlienBases()->end(), matchById(id));
if (found == game.getAlienBases()->end())
{
throw Exception("Corrupted save: Invalid base for mission.");
}
_base = *found;
}
_missionSiteZone = node["missionSiteZone"].as<int>(_missionSiteZone);
}
/**
* Saves the alien mission to a YAML file.
* @return YAML node.
*/
YAML::Node AlienMission::save() const
{
YAML::Node node;
node["type"] = _rule.getType();
node["region"] = _region;
node["race"] = _race;
node["nextWave"] = _nextWave;
node["nextUfoCounter"] = _nextUfoCounter;
node["spawnCountdown"] = _spawnCountdown;
node["liveUfos"] = _liveUfos;
node["uniqueID"] = _uniqueID;
if (_base)
{
node["alienBase"] = _base->getId();
}
node["missionSiteZone"] = _missionSiteZone;
return node;
}
/**
* Check if a mission is over and can be safely removed from the game.
* A mission is over if it will spawn no more UFOs and it has no UFOs still in
* the game.
* @return If the mission can be safely removed from game.
*/
bool AlienMission::isOver() const
{
if (_rule.getObjective() == OBJECTIVE_INFILTRATION)
{
//Infiltrations continue for ever.
return false;
}
if (_nextWave == _rule.getWaveCount() && !_liveUfos)
{
return true;
}
return false;
}
/**
* Find an XCOM base in this region that is marked for retaliation.
*/
class FindMarkedXCOMBase: public std::unary_function<const Base *, bool>
{
public:
FindMarkedXCOMBase(const RuleRegion ®ion) : _region(region) { /* Empty by design. */ }
bool operator()(const Base *base) const { return (_region.insideRegion(base->getLongitude(), base->getLatitude()) && base->getRetaliationTarget()); }
private:
const RuleRegion &_region;
};
void AlienMission::think(Game &engine, const Globe &globe)
{
const Mod &mod = *engine.getMod();
SavedGame &game = *engine.getSavedGame();
if (_nextWave >= _rule.getWaveCount())
return;
if (_spawnCountdown > 30)
{
_spawnCountdown -= 30;
return;
}
const MissionWave &wave = _rule.getWave(_nextWave);
const UfoTrajectory &trajectory = *mod.getUfoTrajectory(wave.trajectory);
Ufo *ufo = spawnUfo(game, mod, globe, wave, trajectory);
if (ufo)
{
//Some missions may not spawn a UFO!
game.getUfos()->push_back(ufo);
}
else if ((mod.getDeployment(wave.ufoType) && !mod.getUfo(wave.ufoType) && mod.getDeployment(wave.ufoType)->getMarkerName() != "") // a mission site that we want to spawn directly
|| (_rule.getObjective() == OBJECTIVE_SITE && wave.objective)) // or we want to spawn one at random according to our terrain
{
std::vector<MissionArea> areas = mod.getRegion(_region)->getMissionZones().at((_rule.getSpawnZone() == -1) ? trajectory.getZone(0) : _rule.getSpawnZone()).areas;
MissionArea area = areas.at((_missionSiteZone == -1) ? RNG::generate(0, areas.size()-1) : _missionSiteZone);
Texture *texture = mod.getGlobe()->getTexture(area.texture);
AlienDeployment *deployment = mod.getDeployment(wave.ufoType) ? mod.getDeployment(wave.ufoType) : mod.getDeployment(texture->getRandomDeployment());
spawnMissionSite(game, deployment, area);
}
++_nextUfoCounter;
if (_nextUfoCounter == wave.ufoCount)
{
_nextUfoCounter = 0;
++_nextWave;
}
if (_rule.getObjective() == OBJECTIVE_INFILTRATION && _nextWave == _rule.getWaveCount())
{
for (std::vector<Country*>::iterator c = game.getCountries()->begin(); c != game.getCountries()->end(); ++c)
{
if (!(*c)->getPact() && !(*c)->getNewPact() && mod.getRegion(_region)->insideRegion((*c)->getRules()->getLabelLongitude(), (*c)->getRules()->getLabelLatitude()))
{
(*c)->setNewPact();
std::vector<MissionArea> areas = mod.getRegion(_region)->getMissionZones().at(_rule.getSpawnZone()).areas;
MissionArea area = areas.at(RNG::generate(0, areas.size()-1));
spawnAlienBase(globe, engine, area);
break;
}
}
// Infiltrations loop for ever.
_nextWave = 0;
}
if (_rule.getObjective() == OBJECTIVE_BASE && _nextWave == _rule.getWaveCount())
{
std::vector<MissionArea> areas = mod.getRegion(_region)->getMissionZones().at(_rule.getSpawnZone()).areas;
MissionArea area = areas.at(RNG::generate(0, areas.size()-1));
spawnAlienBase(globe, engine, area);
}
if (_nextWave != _rule.getWaveCount())
{
size_t spawnTimer = _rule.getWave(_nextWave).spawnTimer / 30;
_spawnCountdown = (spawnTimer/2 + RNG::generate(0, spawnTimer)) * 30;
}
}
/**
* This function will spawn a UFO according the mission rules.
* Some code is duplicated between cases, that's ok for now. It's on different
* code paths and the function is MUCH easier to read written this way.
* @param game The saved game information.
* @param mod The mod.
* @param globe The globe, for land checks.
* @param wave The wave for the desired UFO.
* @param trajectory The rule for the desired trajectory.
* @return Pointer to the spawned UFO. If the mission does not desire to spawn a UFO, 0 is returned.
*/
Ufo *AlienMission::spawnUfo(const SavedGame &game, const Mod &mod, const Globe &globe, const MissionWave &wave, const UfoTrajectory &trajectory)
{
RuleUfo *ufoRule = mod.getUfo(wave.ufoType);
if (_rule.getObjective() == OBJECTIVE_RETALIATION)
{
const RuleRegion ®ionRules = *mod.getRegion(_region);
std::vector<Base *>::const_iterator found =
std::find_if (game.getBases()->begin(), game.getBases()->end(),
FindMarkedXCOMBase(regionRules));
if (found != game.getBases()->end())
{
// Spawn a battleship straight for the XCOM base.
const RuleUfo &battleshipRule = *mod.getUfo(_rule.getSpawnUfo());
const UfoTrajectory &assaultTrajectory = *mod.getUfoTrajectory(UfoTrajectory::RETALIATION_ASSAULT_RUN);
Ufo *ufo = new Ufo(&battleshipRule);
ufo->setMissionInfo(this, &assaultTrajectory);
std::pair<double, double> pos;
if (trajectory.getAltitude(0) == "STR_GROUND")
{
pos = getLandPoint(globe, regionRules, trajectory.getZone(0));
}
else
{
pos = regionRules.getRandomPoint(trajectory.getZone(0));
}
ufo->setAltitude(assaultTrajectory.getAltitude(0));
ufo->setSpeed(assaultTrajectory.getSpeedPercentage(0) * battleshipRule.getMaxSpeed());
ufo->setLongitude(pos.first);
ufo->setLatitude(pos.second);
Waypoint *wp = new Waypoint();
wp->setLongitude((*found)->getLongitude());
wp->setLatitude((*found)->getLatitude());
ufo->setDestination(wp);
return ufo;
}
}
else if (_rule.getObjective() == OBJECTIVE_SUPPLY)
{
if (ufoRule == 0 || (wave.objective && !_base))
{
// No base to supply!
return 0;
}
// Our destination is always an alien base.
Ufo *ufo = new Ufo(ufoRule);
ufo->setMissionInfo(this, &trajectory);
const RuleRegion ®ionRules = *mod.getRegion(_region);
std::pair<double, double> pos;
if (trajectory.getAltitude(0) == "STR_GROUND")
{
pos = getLandPoint(globe, regionRules, trajectory.getZone(0));
}
else
{
pos = regionRules.getRandomPoint(trajectory.getZone(0));
}
ufo->setAltitude(trajectory.getAltitude(0));
ufo->setSpeed(trajectory.getSpeedPercentage(0) * ufoRule->getMaxSpeed());
ufo->setLongitude(pos.first);
ufo->setLatitude(pos.second);
Waypoint *wp = new Waypoint();
if (trajectory.getAltitude(1) == "STR_GROUND")
{
if (wave.objective)
{
// Supply ships on supply missions land on bases, ignore trajectory zone.
pos.first = _base->getLongitude();
pos.second = _base->getLatitude();
}
else
{
// Other ships can land where they want.
pos = getLandPoint(globe, regionRules, trajectory.getZone(1));
}
}
else
{
pos = regionRules.getRandomPoint(trajectory.getZone(1));
}
wp->setLongitude(pos.first);
wp->setLatitude(pos.second);
ufo->setDestination(wp);
return ufo;
}
if (ufoRule == 0)
return 0;
// Spawn according to sequence.
Ufo *ufo = new Ufo(ufoRule);
ufo->setMissionInfo(this, &trajectory);
const RuleRegion ®ionRules = *mod.getRegion(_region);
std::pair<double, double> pos = getWaypoint(trajectory, 0, globe, regionRules);
ufo->setAltitude(trajectory.getAltitude(0));
if (trajectory.getAltitude(0) == "STR_GROUND")
{
ufo->setSecondsRemaining(trajectory.groundTimer()*5);
}
ufo->setSpeed(trajectory.getSpeedPercentage(0) * ufoRule->getMaxSpeed());
ufo->setLongitude(pos.first);
ufo->setLatitude(pos.second);
Waypoint *wp = new Waypoint();
pos = getWaypoint(trajectory, 1, globe, regionRules);
wp->setLongitude(pos.first);
wp->setLatitude(pos.second);
ufo->setDestination(wp);
return ufo;
}
void AlienMission::start(size_t initialCount)
{
_nextWave = 0;
_nextUfoCounter = 0;
_liveUfos = 0;
if (initialCount == 0)
{
size_t spawnTimer = _rule.getWave(0).spawnTimer / 30;
_spawnCountdown = (spawnTimer / 2 + RNG::generate(0, spawnTimer)) * 30;
}
else
{
_spawnCountdown = initialCount;
}
}
/** @brief Match a base from it's coordinates.
* This function object uses coordinates to match a base.
*/
class MatchBaseCoordinates: public std::unary_function<const Base *, bool>
{
public:
/// Remember the query coordinates.
MatchBaseCoordinates(double lon, double lat) : _lon(lon), _lat(lat) { /* Empty by design. */ }
/// Match with base's coordinates.
bool operator()(const Base *base) const { return AreSame(base->getLongitude(), _lon) && AreSame(base->getLatitude(), _lat); }
private:
double _lon, _lat;
};
/**
* This function is called when one of the mission's UFOs arrives at it's current destination.
* It takes care of sending the UFO to the next waypoint, landing UFOs and
* marking them for removal as required. It must set the game data in a way that the rest of the code
* understands what to do.
* @param ufo The UFO that reached it's waypoint.
* @param engine The game engine, required to get access to game data and game rules.
* @param globe The earth globe, required to get access to land checks.
*/
void AlienMission::ufoReachedWaypoint(Ufo &ufo, Game &engine, const Globe &globe)
{
const Mod &mod = *engine.getMod();
SavedGame &game = *engine.getSavedGame();
const size_t curWaypoint = ufo.getTrajectoryPoint();
const size_t nextWaypoint = curWaypoint + 1;
const UfoTrajectory &trajectory = ufo.getTrajectory();
int waveNumber = _nextWave - 1;
if (waveNumber < 0)
{
waveNumber = _rule.getWaveCount() - 1;
}
const MissionWave &wave = _rule.getWave(waveNumber);
if (nextWaypoint >= trajectory.getWaypointCount())
{
ufo.setDetected(false);
ufo.setStatus(Ufo::DESTROYED);
return;
}
ufo.setAltitude(trajectory.getAltitude(nextWaypoint));
ufo.setTrajectoryPoint(nextWaypoint);
const RuleRegion ®ionRules = *mod.getRegion(_region);
std::pair<double, double> pos = getWaypoint(trajectory, nextWaypoint, globe, regionRules);
Waypoint *wp = new Waypoint();
wp->setLongitude(pos.first);
wp->setLatitude(pos.second);
ufo.setDestination(wp);
if (ufo.getAltitude() != "STR_GROUND")
{
if (ufo.getLandId() != 0)
{
ufo.setLandId(0);
}
// Set next waypoint.
ufo.setSpeed((int)(ufo.getRules()->getMaxSpeed() * trajectory.getSpeedPercentage(nextWaypoint)));
}
else
{
// UFO landed.
if (_missionSiteZone != -1 && wave.objective && trajectory.getZone(curWaypoint) == (size_t)(_rule.getSpawnZone()))
{
// Remove UFO, replace with MissionSite.
addScore(ufo.getLongitude(), ufo.getLatitude(), game);
ufo.setStatus(Ufo::DESTROYED);
MissionArea area = regionRules.getMissionZones().at(trajectory.getZone(curWaypoint)).areas.at(_missionSiteZone);
Texture *texture = mod.getGlobe()->getTexture(area.texture);
AlienDeployment *deployment;
if (mod.getDeployment(_rule.getSiteType()))
{
deployment = mod.getDeployment(_rule.getSiteType());
}
else
{
deployment = mod.getDeployment(texture->getRandomDeployment());
}
MissionSite *missionSite = spawnMissionSite(game, deployment, area);
if (missionSite)
{
for (std::vector<Target*>::iterator t = ufo.getFollowers()->begin(); t != ufo.getFollowers()->end();)
{
Craft* c = dynamic_cast<Craft*>(*t);
if (c && c->getNumSoldiers() != 0)
{
c->setDestination(missionSite);
t = ufo.getFollowers()->begin();
}
else
{
++t;
}
}
}
}
else if (trajectory.getID() == UfoTrajectory::RETALIATION_ASSAULT_RUN)
{
// Ignore what the trajectory might say, this is a base assault.
// Remove UFO, replace with Base defense.
ufo.setDetected(false);
std::vector<Base *>::const_iterator found =
std::find_if (game.getBases()->begin(), game.getBases()->end(),
MatchBaseCoordinates(ufo.getLongitude(), ufo.getLatitude()));
if (found == game.getBases()->end())
{
ufo.setStatus(Ufo::DESTROYED);
// Only spawn mission if the base is still there.
return;
}
ufo.setDestination(*found);
}
else
{
if (globe.insideLand(ufo.getLongitude(), ufo.getLatitude()))
{
// Set timer for UFO on the ground.
ufo.setSecondsRemaining(trajectory.groundTimer() * 5);
if (ufo.getDetected() && ufo.getLandId() == 0)
{
ufo.setLandId(engine.getSavedGame()->getId("STR_LANDING_SITE"));
}
}
else
{
// There's nothing to land on
ufo.setSecondsRemaining(5);
}
}
}
}
/**
* This function is called when one of the mission's UFOs is shot down (crashed or destroyed).
* Currently the only thing that happens is delaying the next UFO in the mission sequence.
* @param ufo The UFO that was shot down.
*/
void AlienMission::ufoShotDown(Ufo &ufo)
{
switch (ufo.getStatus())
{
case Ufo::FLYING:
case Ufo::LANDED:
assert(0 && "Ufo seems ok!");
break;
case Ufo::CRASHED:
case Ufo::DESTROYED:
if (_nextWave != _rule.getWaveCount())
{
// Delay next wave
_spawnCountdown += 30 * (RNG::generate(0, 48) + 400);
}
break;
}
}
/**
* This function is called when one of the mission's UFOs has finished it's time on the ground.
* It takes care of sending the UFO to the next waypoint and marking them for removal as required.
* It must set the game data in a way that the rest of the code understands what to do.
* @param ufo The UFO that reached it's waypoint.
* @param game The saved game information.
*/
void AlienMission::ufoLifting(Ufo &ufo, SavedGame &game)
{
switch (ufo.getStatus())
{
case Ufo::FLYING:
assert(0 && "Ufo is already on the air!");
break;
case Ufo::LANDED:
{
// base missions only get points when they are completed.
if (_rule.getPoints() > 0 && _rule.getObjective() != OBJECTIVE_BASE)
{
addScore(ufo.getLongitude(), ufo.getLatitude(), game);
}
ufo.setAltitude("STR_VERY_LOW");
ufo.setSpeed((int)(ufo.getRules()->getMaxSpeed() * ufo.getTrajectory().getSpeedPercentage(ufo.getTrajectoryPoint())));
}
break;
case Ufo::CRASHED:
// Mission expired
ufo.setDetected(false);
ufo.setStatus(Ufo::DESTROYED);
break;
case Ufo::DESTROYED:
assert(0 && "UFO can't fly!");
break;
}
}
/**
* The new time must be a multiple of 30 minutes, and more than 0.
* Calling this on a finished mission has no effect.
* @param minutes The minutes until the next UFO wave will spawn.
*/
void AlienMission::setWaveCountdown(size_t minutes)
{
assert(minutes != 0 && minutes % 30 == 0);
if (isOver())
{
return;
}
_spawnCountdown = minutes;
}
/**
* Assigns a unique ID to this mission.
* It is an error to assign two IDs to the same mission.
* @param id The UD to assign.
*/
void AlienMission::setId(int id)
{
assert(_uniqueID == 0 && "Reassigning ID!");
_uniqueID = id;
}
/**
* @return The unique ID assigned to this mission.
*/
int AlienMission::getId() const
{
assert(_uniqueID != 0 && "Uninitialized mission!");
return _uniqueID;
}
/**
* Sets the alien base associated with this mission.
* Only the alien supply missions care about this.
* @param base A pointer to an alien base.
*/
void AlienMission::setAlienBase(const AlienBase *base)
{
_base = base;
}
/**
* Only alien supply missions ever have a valid pointer.
* @return A pointer (possibly 0) of the AlienBase for this mission.
*/
const AlienBase *AlienMission::getAlienBase() const
{
return _base;
}
/**
* Add alien points to the country and region at the coordinates given.
* @param lon Longitudinal coordinates to check.
* @param lat Latitudinal coordinates to check.
* @param game The saved game information.
*/
void AlienMission::addScore(double lon, double lat, SavedGame &game) const
{
if (_rule.getObjective() == OBJECTIVE_INFILTRATION)
return; // pact score is a special case
for (std::vector<Region *>::iterator region = game.getRegions()->begin(); region != game.getRegions()->end(); ++region)
{
if ((*region)->getRules()->insideRegion(lon, lat))
{
(*region)->addActivityAlien(_rule.getPoints());
break;
}
}
for (std::vector<Country *>::iterator country = game.getCountries()->begin(); country != game.getCountries()->end(); ++country)
{
if ((*country)->getRules()->insideCountry(lon, lat))
{
(*country)->addActivityAlien(_rule.getPoints());
break;
}
}
}
/**
* Spawn an alien base.
* @param globe The earth globe, required to get access to land checks.
* @param engine The game engine, required to get access to game data and game rules.
* @param zone The mission zone, required for determining the base coordinates.
*/
void AlienMission::spawnAlienBase(const Globe &globe, Game &engine, const MissionArea &area)
{
SavedGame &game = *engine.getSavedGame();
const Mod &ruleset = *engine.getMod();
// Once the last UFO is spawned, the aliens build their base.
const RuleRegion ®ionRules = *ruleset.getRegion(_region);
AlienDeployment *deployment;
if (ruleset.getDeployment(_rule.getSiteType()))
{
deployment = ruleset.getDeployment(_rule.getSiteType());
}
else if (ruleset.getGlobe()->getTexture(area.texture) && !ruleset.getGlobe()->getTexture(area.texture)->getDeployments().empty())
{
deployment = ruleset.getDeployment(ruleset.getGlobe()->getTexture(area.texture)->getRandomDeployment());
}
else
{
deployment = ruleset.getDeployment("STR_ALIEN_BASE_ASSAULT");
}
if (deployment == 0)
{
throw Exception("No deployment defined for alien base, please define one in either the mission zone's texture, the mission's siteType, or alternatively, define a deployment called STR_ALIEN_BASE_ASSAULT as a fallback");
}
AlienBase *ab = new AlienBase(deployment);
ab->setAlienRace(_race);
ab->setId(game.getId(deployment->getMarkerName()));
ab->setLongitude(RNG::generate(area.lonMin, area.lonMax));
ab->setLatitude(RNG::generate(area.latMin, area.latMax));
game.getAlienBases()->push_back(ab);
addScore(ab->getLongitude(), ab->getLatitude(), game);
}
/*
* Sets the mission's region. if the region is incompatible with
* actually carrying out an attack, use the "fallback" region as
* defined in the ruleset.
* (this is a slight difference from the original, which just
* defaulted them to zone[0], North America)
* @param region the region we want to try to set the mission to.
* @param mod the mod, in case we need to swap out the region.
*/
void AlienMission::setRegion(const std::string ®ion, const Mod &mod)
{
if (!mod.getRegion(region)->getMissionRegion().empty())
{
_region = mod.getRegion(region)->getMissionRegion();
}
else
{
_region = region;
}
}
/**
* Select a destination based on the criteria of our trajectory and desired waypoint.
* @param trajectory the trajectory in question.
* @param nextWaypoint the next logical waypoint in sequence (0 for newly spawned UFOs)
* @param globe The earth globe, required to get access to land checks.
* @param region the ruleset for the region of our mission.
* @return a set of lon and lat coordinates based on the criteria of the trajectory.
*/
std::pair<double, double> AlienMission::getWaypoint(const UfoTrajectory &trajectory, const size_t nextWaypoint, const Globe &globe, const RuleRegion ®ion)
{
int waveNumber = _nextWave - 1;
if (waveNumber < 0)
{
waveNumber = _rule.getWaveCount() - 1;
}
if (_missionSiteZone != -1 && _rule.getWave(waveNumber).objective && trajectory.getZone(nextWaypoint) == (size_t)(_rule.getSpawnZone()))
{
const MissionArea *area = ®ion.getMissionZones().at(_rule.getObjective()).areas.at(_missionSiteZone);
return std::make_pair(area->lonMin, area->latMin);
}
if (trajectory.getWaypointCount() > nextWaypoint + 1 && trajectory.getAltitude(nextWaypoint + 1) == "STR_GROUND")
{
return getLandPoint(globe, region, trajectory.getZone(nextWaypoint));
}
return region.getRandomPoint(trajectory.getZone(nextWaypoint));
}
/**
* Get a random point inside the given region zone.
* The point will be used to land a UFO, so it HAS to be on land.
*/
std::pair<double, double> AlienMission::getLandPoint(const Globe &globe, const RuleRegion ®ion, size_t zone)
{
int tries = 0;
std::pair<double, double> pos;
do
{
pos = region.getRandomPoint(zone);
++tries;
}
while (!(globe.insideLand(pos.first, pos.second)
&& region.insideRegion(pos.first, pos.second))
&& tries < 100);
if (tries == 100)
{
Log(LOG_DEBUG) << "Region: " << region.getType() << " Longitude: " << pos.first << " Latitude: " << pos.second << " invalid zone: " << zone << " ufo forced to land on water!";
}
return pos;
}
/**
* Attempt to spawn a Mission Site at a given location.
* @param game reference to the saved game.
* @param rules reference to the game rules.
* @param area the point on the globe at which to spawn this site.
* @return a pointer to the mission site.
*/
MissionSite *AlienMission::spawnMissionSite(SavedGame &game, AlienDeployment *deployment, const MissionArea &area)
{
if (deployment)
{
MissionSite *missionSite = new MissionSite(&_rule, deployment);
missionSite->setLongitude(RNG::generate(area.lonMin, area.lonMax));
missionSite->setLatitude(RNG::generate(area.latMin, area.latMax));
missionSite->setId(game.getId(deployment->getMarkerName()));
missionSite->setSecondsRemaining(RNG::generate(deployment->getDurationMin(), deployment->getDurationMax()) * 3600);
missionSite->setAlienRace(_race);
missionSite->setTexture(area.texture);
missionSite->setCity(area.name);
missionSite->setSiteDepth(RNG::generate(deployment->getMinSiteDepth(), deployment->getMaxSiteDepth()));
game.getMissionSites()->push_back(missionSite);
return missionSite;
}
return 0;
}
/**
* Tell the mission which entry in the zone array we're targetting for our missionSite payload.
* @param zone the number of the zone to target, synonymous with a city.
*/
void AlienMission::setMissionSiteZone(int zone)
{
_missionSiteZone = zone;
}
}