Repository navigation
Expand file tree
/
Copy pathRuleMissionScript.cpp
More file actions
347 lines (318 loc) · 9.17 KB
/
Copy pathRuleMissionScript.cpp
File metadata and controls
347 lines (318 loc) · 9.17 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
/*
* 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 "RuleMissionScript.h"
#include "../Engine/Exception.h"
namespace OpenXcom
{
/**
* RuleMissionScript: the rules for the alien mission progression.
* Each script element is independant, and the saved game will probe the list of these each month to determine what's going to happen.
*/
RuleMissionScript::RuleMissionScript(const std::string &type) : _type(type), _firstMonth(0), _lastMonth(-1), _label(0), _executionOdds(100),
_targetBaseOdds(0), _minDifficulty(0), _maxRuns(-1), _avoidRepeats(0), _delay(0),
_useTable(true), _siteType(false)
{
}
/**
* Destructor, cleans up the mess we left in ram.
*/
RuleMissionScript::~RuleMissionScript()
{
for (std::vector<std::pair<size_t, WeightedOptions*> >::iterator i = _missionWeights.begin(); i != _missionWeights.end(); ++i)
{
delete i->second;
}
for (std::vector<std::pair<size_t, WeightedOptions*> >::iterator i = _raceWeights.begin(); i != _raceWeights.end(); ++i)
{
delete i->second;
}
for (std::vector<std::pair<size_t, WeightedOptions*> >::iterator i = _regionWeights.begin(); i != _regionWeights.end(); ++i)
{
delete i->second;
}
}
/**
* Loads a missionScript from a YML file.
* @param node the node within the file we're reading.
*/
void RuleMissionScript::load(const YAML::Node& node)
{
_varName = node["varName"].as<std::string>(_varName);
_firstMonth = node["firstMonth"].as<int>(_firstMonth);
_lastMonth = node["lastMonth"].as<int>(_lastMonth);
_label = node["label"].as<unsigned int>(_label);
_executionOdds = node["executionOdds"].as<int>(_executionOdds);
_targetBaseOdds = node["targetBaseOdds"].as<int>(_targetBaseOdds);
_minDifficulty = node["minDifficulty"].as<int>(_minDifficulty);
_maxRuns = node["maxRuns"].as<int>(_maxRuns);
_avoidRepeats = node["avoidRepeats"].as<int>(_avoidRepeats);
_delay = node["startDelay"].as<int>(_delay);
_conditionals = node["conditionals"].as<std::vector<int> >(_conditionals);
if (const YAML::Node &weights = node["missionWeights"])
{
for (YAML::const_iterator nn = weights.begin(); nn != weights.end(); ++nn)
{
WeightedOptions *nw = new WeightedOptions();
nw->load(nn->second);
_missionWeights.push_back(std::make_pair(nn->first.as<size_t>(0), nw));
}
}
if (const YAML::Node &weights = node["raceWeights"])
{
for (YAML::const_iterator nn = weights.begin(); nn != weights.end(); ++nn)
{
WeightedOptions *nw = new WeightedOptions();
nw->load(nn->second);
_raceWeights.push_back(std::make_pair(nn->first.as<size_t>(0), nw));
}
}
if (const YAML::Node &weights = node["regionWeights"])
{
for (YAML::const_iterator nn = weights.begin(); nn != weights.end(); ++nn)
{
WeightedOptions *nw = new WeightedOptions();
nw->load(nn->second);
_regionWeights.push_back(std::make_pair(nn->first.as<size_t>(0), nw));
}
}
_researchTriggers = node["researchTriggers"].as< std::map<std::string, bool> >(_researchTriggers);
_useTable = node["useTable"].as<bool>(_useTable);
if (_varName == "" && (_maxRuns > 0 || _avoidRepeats > 0))
{
throw Exception("Error in mission script: " + _type +": no varName provided for a script with maxRuns or repeatAvoidance.");
}
}
/**
* Gets the name of this command.
* @return the name of the command.
*/
std::string RuleMissionScript::getType() const
{
return _type;
}
/**
* @return the first month this script should run.
*/
int RuleMissionScript::getFirstMonth() const
{
return _firstMonth;
}
/**
* @return the last month this script should run.
*/
int RuleMissionScript::getLastMonth() const
{
return _lastMonth;
}
/**
* @return the label this command uses for conditional tracking.
*/
int RuleMissionScript::getLabel() const
{
return _label;
}
/**
* @return the odds of this command's execution.
*/
int RuleMissionScript::getExecutionOdds() const
{
return _executionOdds;
}
/**
* @return the odds of this command targetting a base.
*/
int RuleMissionScript::getTargetBaseOdds() const
{
return _targetBaseOdds;
}
/**
* @return the minimum difficulty for this script to run.
*/
int RuleMissionScript::getMinDifficulty() const
{
return _minDifficulty;
}
/**
* @return the maximum runs for scripts tracking our varName.
*/
int RuleMissionScript::getMaxRuns() const
{
return _maxRuns;
}
/**
* @return the number of sites to avoid repeating missions against.
*/
int RuleMissionScript::getRepeatAvoidance() const
{
return _avoidRepeats;
}
/**
* @return the fixed delay on spawning the first wave (if any) to override whatever's written in the mission definition.
*/
int RuleMissionScript::getDelay() const
{
return _delay;
}
/**
* @return the list of conditions that govern execution of this command.
*/
const std::vector<int> &RuleMissionScript::getConditionals() const
{
return _conditionals;
}
/**
* @return if this command uses a weighted distribution to pick a race.
*/
bool RuleMissionScript::hasRaceWeights() const
{
return !_raceWeights.empty();
}
/**
* @return if this command uses a weighted distribution to pick a mission.
*/
bool RuleMissionScript::hasMissionWeights() const
{
return !_missionWeights.empty();
}
/**
* @return if this command uses a weighted distribution to pick a region.
*/
bool RuleMissionScript::hasRegionWeights() const
{
return !_regionWeights.empty();
}
/**
* @return a list of research topics that govern execution of this script.
*/
const std::map<std::string, bool> &RuleMissionScript::getResearchTriggers() const
{
return _researchTriggers;
}
/**
* @return if this command should remove the mission it generates from the strategy table.
*/
bool RuleMissionScript::getUseTable() const
{
return _useTable;
}
/**
* @return the name of the variable we want to use to track in the saved game.
*/
std::string RuleMissionScript::getVarName() const
{
return _varName;
}
/**
* @return a complete, unique list of all the mission types this command could possibly generate.
*/
std::set<std::string> RuleMissionScript::getAllMissionTypes() const
{
std::set<std::string> types;
for (std::vector<std::pair<size_t, WeightedOptions*> >::const_iterator i = _missionWeights.begin(); i != _missionWeights.end(); ++i)
{
std::vector<std::string> names = (*i).second->getNames();
for (std::vector<std::string>::const_iterator j = names.begin(); j != names.end(); ++j)
{
types.insert(*j);
}
}
return types;
}
/**
* @param month the month for which we want info.
* @return a list of the possible missions for the given month.
*/
std::vector<std::string> RuleMissionScript::getMissionTypes(const int month) const
{
std::vector<std::string> missions;
std::vector<std::pair<size_t, WeightedOptions*> >::const_reverse_iterator rw = _missionWeights.rbegin();
while (month < (int)(rw->first))
{
++rw;
if (rw == _missionWeights.rend())
{
--rw;
break;
}
}
std::vector<std::string> names = rw->second->getNames();
for (std::vector<std::string>::const_iterator i = names.begin(); i != names.end(); ++i)
{
missions.push_back(*i);
}
return missions;
}
/**
* @param month the month for which we want info.
* @return the list of regions we have to pick from this month.
*/
std::vector<std::string> RuleMissionScript::getRegions(const int month) const
{
std::vector<std::string> regions;
std::vector<std::pair<size_t, WeightedOptions*> >::const_reverse_iterator rw = _regionWeights.rbegin();
while (month < (int)(rw->first))
{
++rw;
if (rw == _regionWeights.rend())
{
--rw;
break;
}
}
std::vector<std::string> names = rw->second->getNames();
for (std::vector<std::string>::const_iterator i = names.begin(); i != names.end(); ++i)
{
regions.push_back(*i);
}
return regions;
}
/**
* Chooses one of the available races, regions, or missions for this command.
* @param monthsPassed The number of months that have passed in the game world.
* @param type the type of thing we want to generate, region, mission or race.
* @return The string id of the thing.
*/
std::string RuleMissionScript::generate(const size_t monthsPassed, const GenerationType type) const
{
std::vector<std::pair<size_t, WeightedOptions*> >::const_reverse_iterator rw;
if (type == GEN_RACE)
rw = _raceWeights.rbegin();
else if (type == GEN_REGION)
rw = _regionWeights.rbegin();
else
rw = _missionWeights.rbegin();
while (monthsPassed < rw->first)
++rw;
return rw->second->choose();
}
/**
* @param siteType set this command to be a missionSite type or not.
*/
void RuleMissionScript::setSiteType(const bool siteType)
{
_siteType = siteType;
}
/**
* @return if this is a mission site type command or not.
*/
bool RuleMissionScript::getSiteType() const
{
return _siteType;
}
}