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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include "GameSetup.h"
#include "System/TdfParser.h"
#include "System/FileSystem/ArchiveScanner.h"
#include "Map/MapParser.h"
#include "Sim/Misc/GlobalConstants.h"
#include "System/UnsyncedRNG.h"
#include "System/Exceptions.h"
#include "System/Util.h"
#include "System/Log/ILog.h"
#include <algorithm>
#include <map>
#include <cctype>
#include <cstring>
#include <boost/format.hpp>
CR_BIND(CGameSetup,)
CR_REG_METADATA(CGameSetup, (
CR_MEMBER(gameSetupText),
CR_POSTLOAD(PostLoad)
))
CGameSetup* gameSetup = NULL;
void CGameSetup::LoadSavedScript(const std::string& file, const std::string& script)
{
if (script.empty())
return;
if (gameSetup != NULL)
return;
CGameSetup* temp = new CGameSetup();
if (!temp->Init(script)) {
delete temp; temp = NULL;
} else {
temp->saveName = file;
// set the global instance
gameSetup = temp;
}
}
const std::map<std::string, std::string>& CGameSetup::GetMapOptions()
{
static std::map<std::string, std::string> dummyOptions;
if (gameSetup != NULL) {
return gameSetup->GetMapOptionsCont();
}
return dummyOptions;
}
const std::map<std::string, std::string>& CGameSetup::GetModOptions()
{
static std::map<std::string, std::string> dummyOptions;
if (gameSetup != NULL) {
return gameSetup->GetModOptionsCont();
}
return dummyOptions;
}
const std::vector<PlayerBase>& CGameSetup::GetPlayerStartingData()
{
static std::vector<PlayerBase> dummyData;
if (gameSetup != NULL) {
return gameSetup->GetPlayerStartingDataCont();
}
return dummyData;
}
const std::vector<TeamBase>& CGameSetup::GetTeamStartingData()
{
static std::vector<TeamBase> dummyData;
if (gameSetup != NULL) {
return gameSetup->GetTeamStartingDataCont();
}
return dummyData;
}
const std::vector<AllyTeam>& CGameSetup::GetAllyStartingData()
{
static std::vector<AllyTeam> dummyData;
if (gameSetup != NULL) {
return gameSetup->GetAllyStartingDataCont();
}
return dummyData;
}
CGameSetup::CGameSetup()
: fixedAllies(true)
, useLuaGaia(true)
, noHelperAIs(false)
, ghostedBuildings(true)
, disableMapDamage(false)
, onlyLocal(false)
, hostDemo(false)
, mapHash(0)
, modHash(0)
, mapSeed(0)
, gameStartDelay(0)
, numDemoPlayers(0)
, maxUnitsPerTeam(1500)
, maxSpeed(0.0f)
, minSpeed(0.0f)
, startPosType(StartPos_Fixed)
{}
void CGameSetup::PostLoad()
{
Init(gameSetupText);
}
void CGameSetup::LoadUnitRestrictions(const TdfParser& file)
{
int numRestrictions;
file.GetDef(numRestrictions, "0", "GAME\\NumRestrictions");
for (int i = 0; i < numRestrictions; ++i) {
char key[100];
sprintf(key, "GAME\\RESTRICT\\Unit%d", i);
string resName = file.SGetValueDef("", key);
sprintf(key, "GAME\\RESTRICT\\Limit%d", i);
int resLimit;
file.GetDef(resLimit, "0", key);
restrictedUnits[resName] = resLimit;
}
}
void CGameSetup::LoadStartPositionsFromMap()
{
MapParser mapParser(MapFile());
if (!mapParser.IsValid()) {
throw content_error("MapInfo: " + mapParser.GetErrorLog());
}
for (size_t a = 0; a < teamStartingData.size(); ++a) {
float3 pos;
// don't fail when playing with more players than
// start positions and we didn't use them anyway
if (!mapParser.GetStartPos(teamStartingData[a].teamStartNum, pos))
throw content_error(mapParser.GetErrorLog());
// map should ensure positions are valid
// (but clients will always do clamping)
teamStartingData[a].SetStartPos(pos);
}
}
void CGameSetup::LoadStartPositions(bool withoutMap)
{
if (withoutMap && (startPosType == StartPos_Random || startPosType == StartPos_Fixed))
throw content_error("You need the map to use the map's startpositions");
if (startPosType == StartPos_Random) {
// Server syncs these later, so we can use unsynced rng
UnsyncedRNG rng;
rng.Seed(gameSetupText.length());
rng.Seed((size_t)gameSetupText.c_str());
std::vector<int> teamStartNum(teamStartingData.size());
for (size_t i = 0; i < teamStartingData.size(); ++i)
teamStartNum[i] = i;
std::random_shuffle(teamStartNum.begin(), teamStartNum.end(), rng);
for (size_t i = 0; i < teamStartingData.size(); ++i)
teamStartingData[i].teamStartNum = teamStartNum[i];
} else {
for (size_t a = 0; a < teamStartingData.size(); ++a) {
teamStartingData[a].teamStartNum = (int)a;
}
}
if (startPosType == StartPos_Fixed || startPosType == StartPos_Random) {
LoadStartPositionsFromMap();
}
}
void CGameSetup::LoadMutators(const TdfParser& file, std::vector<std::string>& mutatorsList)
{
for (int a = 0; a < 10; ++a) {
std::string s = file.SGetValueDef("", IntToString(a, "GAME\\MUTATOR%i"));
if (s.empty()) break;
mutatorsList.push_back(s);
}
}
void CGameSetup::LoadPlayers(const TdfParser& file, std::set<std::string>& nameList)
{
numDemoPlayers = 0;
// i = player index in game (no gaps), a = player index in script
int i = 0;
for (int a = 0; a < MAX_PLAYERS; ++a) {
char section[50];
sprintf(section, "GAME\\PLAYER%i", a);
string s(section);
if (!file.SectionExist(s)) {
continue;
}
PlayerBase data;
// expects lines of form team=x rather than team=TEAMx
// team field is relocated in RemapTeams
std::map<std::string, std::string> setup = file.GetAllValues(s);
for (std::map<std::string, std::string>::const_iterator it = setup.begin(); it != setup.end(); ++it)
data.SetValue(it->first, it->second);
// do checks for sanity
if (data.name.empty())
throw content_error(str( boost::format("GameSetup: No name given for Player %i") %a ));
if (nameList.find(data.name) != nameList.end())
throw content_error(str(boost::format("GameSetup: Player %i has name %s which is already taken") %a %data.name.c_str() ));
nameList.insert(data.name);
if (data.isFromDemo)
numDemoPlayers++;
playerStartingData.push_back(data);
playerRemap[a] = i;
++i;
}
unsigned playerCount = 0;
if (file.GetValue(playerCount, "GAME\\NumPlayers") && playerStartingData.size() != playerCount) {
LOG_L(L_WARNING,
_STPF_ " players in GameSetup script (NumPlayers says %i)",
playerStartingData.size(), playerCount);
}
}
void CGameSetup::LoadSkirmishAIs(const TdfParser& file, std::set<std::string>& nameList)
{
// i = AI index in game (no gaps), a = AI index in script
for (int a = 0; a < MAX_PLAYERS; ++a) {
char section[50];
sprintf(section, "GAME\\AI%i\\", a);
string s(section);
if (!file.SectionExist(s.substr(0, s.length() - 1))) {
continue;
}
SkirmishAIData data;
data.team = atoi(file.SGetValueDef("-1", s + "Team").c_str());
if (data.team == -1) {
throw content_error("missing AI.Team in GameSetup script");
}
data.hostPlayer = atoi(file.SGetValueDef("-1", s + "Host").c_str());
if (data.hostPlayer == -1) {
throw content_error("missing AI.Host in GameSetup script");
}
data.shortName = file.SGetValueDef("", s + "ShortName");
if (data.shortName == "") {
throw content_error("missing AI.ShortName in GameSetup script");
}
data.version = file.SGetValueDef("", s + "Version");
if (file.SectionExist(s + "Options")) {
data.options = file.GetAllValues(s + "Options");
std::map<std::string, std::string>::const_iterator kv;
for (kv = data.options.begin(); kv != data.options.end(); ++kv) {
data.optionKeys.push_back(kv->first);
}
}
// get the visible name (comparable to player-name)
std::string name = file.SGetValueDef(data.shortName, s + "Name");
int instanceIndex = 0;
std::string name_unique = name;
while (nameList.find(name_unique) != nameList.end()) {
name_unique = name + "_" + IntToString(instanceIndex++);
// so we possibly end up with something like myBot_0, or RAI_2
}
data.name = name_unique;
nameList.insert(data.name);
skirmishAIStartingData.push_back(data);
}
}
void CGameSetup::LoadTeams(const TdfParser& file)
{
// i = team index in game (no gaps), a = team index in script
int i = 0;
for (int a = 0; a < MAX_TEAMS; ++a) {
char section[50];
sprintf(section, "GAME\\TEAM%i", a);
string s(section);
if (!file.SectionExist(s.substr(0, s.length()))) {
continue;
}
TeamBase data;
// Get default color from palette (based on "color" tag)
for (size_t num = 0; num < 3; ++num) {
data.color[num] = TeamBase::teamDefaultColor[a][num];
}
data.color[3] = 255;
const std::map<std::string, std::string>& setup = file.GetAllValues(s);
for (std::map<std::string, std::string>::const_iterator it = setup.begin(); it != setup.end(); ++it)
data.SetValue(it->first, it->second);
teamStartingData.push_back(data);
teamRemap[a] = i;
++i;
}
unsigned teamCount = 0;
if (file.GetValue(teamCount, "Game\\NumTeams") && teamStartingData.size() != teamCount) {
LOG_L(L_WARNING,
_STPF_ " teams in GameSetup script (NumTeams: %i)",
teamStartingData.size(), teamCount);
}
}
void CGameSetup::LoadAllyTeams(const TdfParser& file)
{
// i = allyteam index in game (no gaps), a = allyteam index in script
int i = 0;
for (int a = 0; a < MAX_TEAMS; ++a) {
char section[50];
sprintf(section,"GAME\\ALLYTEAM%i",a);
string s(section);
if (!file.SectionExist(s))
continue;
AllyTeam data;
std::map<std::string, std::string> setup = file.GetAllValues(s);
for (std::map<std::string, std::string>::const_iterator it = setup.begin(); it != setup.end(); ++it)
data.SetValue(it->first, it->second);
allyStartingData.push_back(data);
allyteamRemap[a] = i;
++i;
}
{
const size_t numAllyTeams = allyStartingData.size();
for (size_t a = 0; a < numAllyTeams; ++a) {
allyStartingData[a].allies.resize(numAllyTeams, false);
allyStartingData[a].allies[a] = true; // each team is allied with itself
std::ostringstream section;
section << "GAME\\ALLYTEAM" << a << "\\";
const size_t numAllies = atoi(file.SGetValueDef("0", section.str() + "NumAllies").c_str());
for (size_t b = 0; b < numAllies; ++b) {
std::ostringstream key;
key << "GAME\\ALLYTEAM" << a << "\\Ally" << b;
const int other = atoi(file.SGetValueDef("0",key.str()).c_str());
allyStartingData[a].allies[allyteamRemap[other]] = true;
}
}
}
unsigned allyCount = 0;
if (file.GetValue(allyCount, "GAME\\NumAllyTeams") && (allyStartingData.size() != allyCount)) {
LOG_L(L_WARNING, "Incorrect number of ally teams in GameSetup script");
}
}
void CGameSetup::RemapPlayers()
{
// relocate Team.TeamLeader field
for (size_t a = 0; a < teamStartingData.size(); ++a) {
if (playerRemap.find(teamStartingData[a].GetLeader()) == playerRemap.end()) {
std::ostringstream buf;
buf << "GameSetup: Team " << a << " has invalid leader: " << teamStartingData[a].GetLeader();
throw content_error(buf.str());
}
teamStartingData[a].SetLeader(playerRemap[teamStartingData[a].GetLeader()]);
}
// relocate AI.hostPlayer field
for (size_t a = 0; a < skirmishAIStartingData.size(); ++a) {
if (playerRemap.find(skirmishAIStartingData[a].hostPlayer) == playerRemap.end()) {
throw content_error("invalid AI.Host in GameSetup script");
}
skirmishAIStartingData[a].hostPlayer = playerRemap[skirmishAIStartingData[a].hostPlayer];
}
}
void CGameSetup::RemapTeams()
{
// relocate Player.team field
for (size_t a = 0; a < playerStartingData.size(); ++a) {
if (playerStartingData[a].spectator) {
// start spectating the first team (0)
playerStartingData[a].team = 0;
} else {
if (teamRemap.find(playerStartingData[a].team) == teamRemap.end())
throw content_error( str(boost::format("GameSetup: Player %i belong to wrong team: %i") %a %playerStartingData[a].team) );
playerStartingData[a].team = teamRemap[playerStartingData[a].team];
}
}
// relocate AI.team field
for (size_t a = 0; a < skirmishAIStartingData.size(); ++a) {
if (teamRemap.find(skirmishAIStartingData[a].team) == teamRemap.end())
throw content_error("invalid AI.Team in GameSetup script");
skirmishAIStartingData[a].team = teamRemap[skirmishAIStartingData[a].team];
team_skirmishAI[skirmishAIStartingData[a].team] = &(skirmishAIStartingData[a]);
}
}
void CGameSetup::RemapAllyteams()
{
// relocate Team.Allyteam field
for (size_t a = 0; a < teamStartingData.size(); ++a) {
if (allyteamRemap.find(teamStartingData[a].teamAllyteam) == allyteamRemap.end()) {
throw content_error("invalid Team.Allyteam in GameSetup script");
}
teamStartingData[a].teamAllyteam = allyteamRemap[teamStartingData[a].teamAllyteam];
}
}
// TODO: RemapSkirmishAIs()
bool CGameSetup::Init(const std::string& buf)
{
// Copy buffer contents
gameSetupText = buf;
// Parse game parameters
TdfParser file(buf.c_str(),buf.size());
if (!file.SectionExist("GAME"))
return false;
// Used by dedicated server only
file.GetTDef(mapHash, unsigned(0), "GAME\\MapHash");
file.GetTDef(modHash, unsigned(0), "GAME\\ModHash");
file.GetTDef(mapSeed, unsigned(0), "GAME\\MapSeed");
gameID = file.SGetValueDef("", "GAME\\GameID");
modName = file.SGetValueDef("", "GAME\\Gametype");
mapName = file.SGetValueDef("", "GAME\\MapName");
saveName = file.SGetValueDef("", "GAME\\Savefile");
demoName = file.SGetValueDef("", "GAME\\Demofile");
hostDemo = !demoName.empty();
file.GetTDef(gameStartDelay, (unsigned int) 4, "GAME\\GameStartDelay");
file.GetDef(onlyLocal, "0", "GAME\\OnlyLocal");
file.GetDef(useLuaGaia, "1", "GAME\\ModOptions\\LuaGaia");
file.GetDef(noHelperAIs, "0", "GAME\\ModOptions\\NoHelperAIs");
file.GetDef(maxUnitsPerTeam, "32000", "GAME\\ModOptions\\MaxUnits");
file.GetDef(disableMapDamage, "0", "GAME\\ModOptions\\DisableMapDamage");
file.GetDef(ghostedBuildings, "1", "GAME\\ModOptions\\GhostedBuildings");
file.GetDef(maxSpeed, "3.0", "GAME\\ModOptions\\MaxSpeed");
file.GetDef(minSpeed, "0.3", "GAME\\ModOptions\\MinSpeed");
file.GetDef(fixedAllies, "1", "GAME\\ModOptions\\FixedAllies");
// Read the map & mod options
if (file.SectionExist("GAME\\MapOptions")) { mapOptions = file.GetAllValues("GAME\\MapOptions"); }
if (file.SectionExist("GAME\\ModOptions")) { modOptions = file.GetAllValues("GAME\\ModOptions"); }
// Read startPosType (with clamping)
int startPosTypeInt;
file.GetDef(startPosTypeInt, "0", "GAME\\StartPosType");
if (startPosTypeInt < 0 || startPosTypeInt > StartPos_Last)
startPosTypeInt = 0;
startPosType = (StartPosType)startPosTypeInt;
// Read subsections
std::set<std::string> playersNameList;
LoadPlayers(file, playersNameList);
LoadSkirmishAIs(file, playersNameList);
LoadTeams(file);
LoadAllyTeams(file);
// Relocate indices (for gap removing)
RemapPlayers();
RemapTeams();
RemapAllyteams();
LoadMutators(file, mutatorsList);
LoadUnitRestrictions(file);
// Postprocessing
modName = archiveScanner->NameFromArchive(modName);
return true;
}
const std::string CGameSetup::MapFile() const
{
return (archiveScanner->MapNameToMapFile(mapName));
}
|