CCampaignHandler.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
  1. /*
  2. * CCampaignHandler.cpp, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #include "StdInc.h"
  11. #include "CCampaignHandler.h"
  12. #include "../filesystem/Filesystem.h"
  13. #include "../filesystem/CCompressedStream.h"
  14. #include "../filesystem/CMemoryStream.h"
  15. #include "../filesystem/CBinaryReader.h"
  16. #include "../VCMI_Lib.h"
  17. #include "../vcmi_endian.h"
  18. #include "../CGeneralTextHandler.h"
  19. #include "../TextOperations.h"
  20. #include "../StartInfo.h"
  21. #include "../CModHandler.h"
  22. #include "../CArtHandler.h" //for hero crossover
  23. #include "../mapObjects/CGHeroInstance.h"//for hero crossover
  24. #include "../CHeroHandler.h"
  25. #include "../Languages.h"
  26. #include "../StringConstants.h"
  27. #include "CMapService.h"
  28. #include "CMap.h"
  29. #include "CMapInfo.h"
  30. // For hero crossover
  31. #include "serializer/CSerializer.h"
  32. #include "serializer/JsonDeserializer.h"
  33. #include "serializer/JsonSerializer.h"
  34. VCMI_LIB_NAMESPACE_BEGIN
  35. bool CScenarioTravel::STravelBonus::isBonusForHero() const
  36. {
  37. return type == SPELL || type == MONSTER || type == ARTIFACT || type == SPELL_SCROLL || type == PRIMARY_SKILL
  38. || type == SECONDARY_SKILL;
  39. }
  40. CCampaignHeader CCampaignHandler::getHeader( const std::string & name)
  41. {
  42. ResourceID resourceID(name, EResType::CAMPAIGN);
  43. std::string modName = VLC->modh->findResourceOrigin(resourceID);
  44. std::string language = VLC->modh->getModLanguage(modName);
  45. std::string encoding = Languages::getLanguageOptions(language).encoding;
  46. JsonNode jsonCampaign(resourceID);
  47. if(jsonCampaign.isNull())
  48. {
  49. auto fileStream = CResourceHandler::get(modName)->load(resourceID);
  50. std::vector<ui8> cmpgn = getFile(std::move(fileStream), true)[0];
  51. CMemoryStream stream(cmpgn.data(), cmpgn.size());
  52. CBinaryReader reader(&stream);
  53. CCampaignHeader ret = readHeaderFromMemory(reader, resourceID.getName(), modName, encoding);
  54. return ret;
  55. }
  56. else
  57. {
  58. CCampaignHeader ret = readHeaderFromJson(jsonCampaign, resourceID.getName(), modName, encoding);
  59. return ret;
  60. }
  61. }
  62. std::unique_ptr<CCampaign> CCampaignHandler::getCampaign( const std::string & name )
  63. {
  64. ResourceID resourceID(name, EResType::CAMPAIGN);
  65. std::string modName = VLC->modh->findResourceOrigin(resourceID);
  66. std::string language = VLC->modh->getModLanguage(modName);
  67. std::string encoding = Languages::getLanguageOptions(language).encoding;
  68. auto ret = std::make_unique<CCampaign>();
  69. JsonNode jsonCampaign(resourceID);
  70. if(jsonCampaign.isNull())
  71. {
  72. auto fileStream = CResourceHandler::get(modName)->load(resourceID);
  73. std::vector<std::vector<ui8>> file = getFile(std::move(fileStream), false);
  74. CMemoryStream stream(file[0].data(), file[0].size());
  75. CBinaryReader reader(&stream);
  76. ret->header = readHeaderFromMemory(reader, resourceID.getName(), modName, encoding);
  77. int howManyScenarios = static_cast<int>(VLC->generaltexth->getCampaignLength(ret->header.mapVersion));
  78. for(int g=0; g<howManyScenarios; ++g)
  79. {
  80. CCampaignScenario sc = readScenarioFromMemory(reader, resourceID.getName(), modName, encoding, ret->header.version, ret->header.mapVersion);
  81. ret->scenarios.push_back(sc);
  82. }
  83. int scenarioID = 0;
  84. //first entry is campaign header. start loop from 1
  85. for (int g=1; g<file.size() && scenarioID<howManyScenarios; ++g)
  86. {
  87. while(!ret->scenarios[scenarioID].isNotVoid()) //skip void scenarios
  88. {
  89. scenarioID++;
  90. }
  91. std::string scenarioName = resourceID.getName();
  92. boost::to_lower(scenarioName);
  93. scenarioName += ':' + std::to_string(g - 1);
  94. //set map piece appropriately, convert vector to string
  95. ret->mapPieces[scenarioID].assign(reinterpret_cast< const char* >(file[g].data()), file[g].size());
  96. CMapService mapService;
  97. auto hdr = mapService.loadMapHeader(
  98. reinterpret_cast<const ui8 *>(ret->mapPieces[scenarioID].c_str()),
  99. static_cast<int>(ret->mapPieces[scenarioID].size()),
  100. scenarioName,
  101. modName,
  102. encoding);
  103. ret->scenarios[scenarioID].scenarioName = hdr->name;
  104. scenarioID++;
  105. }
  106. }
  107. else
  108. {
  109. ret->header = readHeaderFromJson(jsonCampaign, resourceID.getName(), modName, encoding);
  110. for(auto & scenario : jsonCampaign["scenarios"].Vector())
  111. {
  112. CCampaignScenario sc = readScenarioFromJson(scenario, resourceID.getName(), modName, encoding, ret->header.version, ret->header.mapVersion);
  113. if(sc.isNotVoid())
  114. {
  115. CMapService mapService;
  116. if(auto hdr = mapService.loadMapHeader(ResourceID(sc.mapName, EResType::MAP)))
  117. sc.scenarioName = hdr->name;
  118. }
  119. ret->scenarios.push_back(sc);
  120. }
  121. }
  122. // handle campaign specific discrepancies
  123. if(resourceID.getName() == "DATA/AB")
  124. {
  125. ret->scenarios[6].keepHeroes.emplace_back(155); // keep hero Xeron for map 7 To Kill A Hero
  126. }
  127. else if(resourceID.getName() == "DATA/FINAL")
  128. {
  129. // keep following heroes for map 8 Final H
  130. ret->scenarios[7].keepHeroes.emplace_back(148); // Gelu
  131. ret->scenarios[7].keepHeroes.emplace_back(27); // Gem
  132. ret->scenarios[7].keepHeroes.emplace_back(102); // Crag Hack
  133. ret->scenarios[7].keepHeroes.emplace_back(96); // Yog
  134. }
  135. return ret;
  136. }
  137. static std::string convertMapName(std::string input)
  138. {
  139. boost::algorithm::to_lower(input);
  140. boost::algorithm::trim(input);
  141. size_t slashPos = input.find_last_of("/");
  142. if (slashPos != std::string::npos)
  143. return input.substr(slashPos + 1);
  144. return input;
  145. }
  146. std::string CCampaignHandler::readLocalizedString(CBinaryReader & reader, std::string filename, std::string modName, std::string encoding, std::string identifier)
  147. {
  148. TextIdentifier stringID( "campaign", convertMapName(filename), identifier);
  149. std::string input = TextOperations::toUnicode(reader.readBaseString(), encoding);
  150. if (input.empty())
  151. return "";
  152. VLC->generaltexth->registerString(modName, stringID, input);
  153. return VLC->generaltexth->translate(stringID.get());
  154. }
  155. CCampaignHeader CCampaignHandler::readHeaderFromJson(JsonNode & reader, std::string filename, std::string modName, std::string encoding )
  156. {
  157. CCampaignHeader ret;
  158. ret.version = reader["version"].Integer();
  159. if(ret.version < CampaignVersion::VCMI_MIN || ret.version > CampaignVersion::VCMI_MAX)
  160. {
  161. logGlobal->info("VCMP Loading: Unsupported campaign %s version %d", filename, ret.version);
  162. return ret;
  163. }
  164. ret.version = CampaignVersion::VCMI;
  165. ret.mapVersion = reader["campaignId"].Integer();
  166. ret.name = reader["name"].String();
  167. ret.description = reader["description"].String();
  168. ret.difficultyChoosenByPlayer = reader["allowDifficultySelection"].Bool();
  169. //skip ret.music because it's unused in vcmi
  170. ret.filename = filename;
  171. ret.modName = modName;
  172. ret.encoding = encoding;
  173. ret.valid = true;
  174. return ret;
  175. }
  176. CCampaignScenario CCampaignHandler::readScenarioFromJson(JsonNode & reader, std::string filename, std::string modName, std::string encoding, int version, int mapVersion)
  177. {
  178. auto prologEpilogReader = [](JsonNode & identifier) -> CCampaignScenario::SScenarioPrologEpilog
  179. {
  180. CCampaignScenario::SScenarioPrologEpilog ret;
  181. ret.hasPrologEpilog = !identifier.isNull();
  182. if(ret.hasPrologEpilog)
  183. {
  184. ret.prologVideo = identifier["video"].Integer();
  185. ret.prologMusic = identifier["music"].Integer();
  186. ret.prologText = identifier["text"].String();
  187. }
  188. return ret;
  189. };
  190. CCampaignScenario ret;
  191. ret.conquered = false;
  192. ret.mapName = reader["map"].String();
  193. for(auto & g : reader["precoditions"].Vector())
  194. ret.preconditionRegions.insert(g.Integer());
  195. ret.regionColor = reader["color"].Integer();
  196. ret.difficulty = reader["difficulty"].Integer();
  197. ret.regionText = reader["regionText"].String();
  198. ret.prolog = prologEpilogReader(reader["prolog"]);
  199. ret.epilog = prologEpilogReader(reader["epilog"]);
  200. ret.travelOptions = readScenarioTravelFromJson(reader, version);
  201. return ret;
  202. }
  203. CScenarioTravel CCampaignHandler::readScenarioTravelFromJson(JsonNode & reader, int version )
  204. {
  205. CScenarioTravel ret;
  206. std::map<std::string, ui8> heroKeepsMap = {
  207. {"experience", 1},
  208. {"primarySkill", 2},
  209. {"secondarySkill", 4},
  210. {"spells", 8},
  211. {"artifacts", 16}
  212. };
  213. std::map<std::string, ui8> startOptionsMap = {
  214. {"none", 0},
  215. {"bonus", 1},
  216. {"crossover", 2},
  217. {"hero", 3}
  218. };
  219. std::map<std::string, CScenarioTravel::STravelBonus::EBonusType> bonusTypeMap = {
  220. {"spell", CScenarioTravel::STravelBonus::EBonusType::SPELL},
  221. {"creature", CScenarioTravel::STravelBonus::EBonusType::MONSTER},
  222. {"building", CScenarioTravel::STravelBonus::EBonusType::BUILDING},
  223. {"artifact", CScenarioTravel::STravelBonus::EBonusType::ARTIFACT},
  224. {"scroll", CScenarioTravel::STravelBonus::EBonusType::SPELL_SCROLL},
  225. {"primarySkill", CScenarioTravel::STravelBonus::EBonusType::PRIMARY_SKILL},
  226. {"secondarySkill", CScenarioTravel::STravelBonus::EBonusType::SECONDARY_SKILL},
  227. {"resource", CScenarioTravel::STravelBonus::EBonusType::RESOURCE},
  228. //{"prevHero", CScenarioTravel::STravelBonus::EBonusType::HEROES_FROM_PREVIOUS_SCENARIO},
  229. //{"hero", CScenarioTravel::STravelBonus::EBonusType::HERO},
  230. };
  231. std::map<std::string, ui32> primarySkillsMap = {
  232. {"attack", 0},
  233. {"defence", 8},
  234. {"spellpower", 16},
  235. {"knowledge", 24},
  236. };
  237. std::map<std::string, ui16> heroSpecialMap = {
  238. {"strongest", 0xFFFD},
  239. {"generated", 0xFFFE},
  240. {"random", 0xFFFF}
  241. };
  242. std::map<std::string, ui8> resourceTypeMap = {
  243. //FD - wood+ore
  244. //FE - mercury+sulfur+crystal+gem
  245. {"wood", 0},
  246. {"mercury", 1},
  247. {"ore", 2},
  248. {"sulfur", 3},
  249. {"crystal", 4},
  250. {"gems", 5},
  251. {"gold", 6},
  252. {"common", 0xFD},
  253. {"rare", 0xFE}
  254. };
  255. for(auto & k : reader["heroKeeps"].Vector())
  256. ret.whatHeroKeeps |= heroKeepsMap[k.String()];
  257. for(auto & k : reader["keepCreatures"].Vector())
  258. {
  259. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "creature", k.String()))
  260. {
  261. int creId = identifier.get();
  262. if(creId >= ret.monstersKeptByHero.size())
  263. logGlobal->warn("VCMP Loading: creature %s with id %d isn't supported yet", k.String(), creId);
  264. else
  265. ret.monstersKeptByHero[creId / 8] |= (1 << creId % 8);
  266. }
  267. else
  268. logGlobal->warn("VCMP Loading: keepCreatures contains unresolved identifier %s", k.String());
  269. }
  270. for(auto & k : reader["keepArtifacts"].Vector())
  271. {
  272. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "artifact", k.String()))
  273. {
  274. int artId = identifier.get();
  275. if(artId >= ret.artifsKeptByHero.size())
  276. logGlobal->warn("VCMP Loading: artifact %s with id %d isn't supported yet", k.String(), artId);
  277. else
  278. ret.artifsKeptByHero[artId / 8] |= (1 << artId % 8);
  279. }
  280. else
  281. logGlobal->warn("VCMP Loading: keepArtifacts contains unresolved identifier %s", k.String());
  282. }
  283. ret.startOptions = startOptionsMap[reader["startOptions"].String()];
  284. switch(ret.startOptions)
  285. {
  286. case 0:
  287. //no bonuses. Seems to be OK
  288. break;
  289. case 1: //reading of bonuses player can choose
  290. {
  291. ret.playerColor = reader["playerColor"].Integer();
  292. for(auto & bjson : reader["bonuses"].Vector())
  293. {
  294. CScenarioTravel::STravelBonus bonus;
  295. bonus.type = bonusTypeMap[bjson["what"].String()];
  296. switch (bonus.type)
  297. {
  298. case CScenarioTravel::STravelBonus::EBonusType::RESOURCE:
  299. bonus.info1 = resourceTypeMap[bjson["type"].String()];
  300. bonus.info2 = bjson["amount"].Integer();
  301. break;
  302. case CScenarioTravel::STravelBonus::EBonusType::BUILDING:
  303. bonus.info1 = vstd::find_pos(EBuildingType::names, bjson["type"].String());
  304. if(bonus.info1 == -1)
  305. logGlobal->warn("VCMP Loading: unresolved building identifier %s", bjson["type"].String());
  306. break;
  307. default:
  308. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  309. bonus.info1 = heroId;
  310. else
  311. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "hero", bjson["hero"].String()))
  312. bonus.info1 = identifier.get();
  313. else
  314. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  315. bonus.info3 = bjson["amount"].Integer();
  316. switch(bonus.type)
  317. {
  318. case CScenarioTravel::STravelBonus::EBonusType::SPELL:
  319. case CScenarioTravel::STravelBonus::EBonusType::MONSTER:
  320. case CScenarioTravel::STravelBonus::EBonusType::SECONDARY_SKILL:
  321. case CScenarioTravel::STravelBonus::EBonusType::ARTIFACT:
  322. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), bjson["what"].String(), bjson["type"].String()))
  323. bonus.info2 = identifier.get();
  324. else
  325. logGlobal->warn("VCMP Loading: unresolved %s identifier %s", bjson["what"].String(), bjson["type"].String());
  326. break;
  327. case CScenarioTravel::STravelBonus::EBonusType::SPELL_SCROLL:
  328. if(auto Identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "spell", bjson["type"].String()))
  329. bonus.info2 = Identifier.get();
  330. else
  331. logGlobal->warn("VCMP Loading: unresolved spell scroll identifier %s", bjson["type"].String());
  332. break;
  333. case CScenarioTravel::STravelBonus::EBonusType::PRIMARY_SKILL:
  334. for(auto & ps : primarySkillsMap)
  335. bonus.info2 |= bjson[ps.first].Integer() << ps.second;
  336. break;
  337. default:
  338. bonus.info2 = bjson["type"].Integer();
  339. }
  340. break;
  341. }
  342. ret.bonusesToChoose.push_back(bonus);
  343. }
  344. break;
  345. }
  346. case 2: //reading of players (colors / scenarios ?) player can choose
  347. {
  348. for(auto & bjson : reader["bonuses"].Vector())
  349. {
  350. CScenarioTravel::STravelBonus bonus;
  351. bonus.type = CScenarioTravel::STravelBonus::HEROES_FROM_PREVIOUS_SCENARIO;
  352. bonus.info1 = bjson["playerColor"].Integer(); //player color
  353. bonus.info2 = bjson["scenario"].Integer(); //from what scenario
  354. ret.bonusesToChoose.push_back(bonus);
  355. }
  356. break;
  357. }
  358. case 3: //heroes player can choose between
  359. {
  360. for(auto & bjson : reader["bonuses"].Vector())
  361. {
  362. CScenarioTravel::STravelBonus bonus;
  363. bonus.type = CScenarioTravel::STravelBonus::HERO;
  364. bonus.info1 = bjson["playerColor"].Integer(); //player color
  365. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  366. bonus.info2 = heroId;
  367. else
  368. if (auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "hero", bjson["hero"].String()))
  369. bonus.info2 = identifier.get();
  370. else
  371. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  372. ret.bonusesToChoose.push_back(bonus);
  373. }
  374. break;
  375. }
  376. default:
  377. {
  378. logGlobal->warn("VCMP Loading: Unsupported start options value");
  379. break;
  380. }
  381. }
  382. return ret;
  383. }
  384. CCampaignHeader CCampaignHandler::readHeaderFromMemory( CBinaryReader & reader, std::string filename, std::string modName, std::string encoding )
  385. {
  386. CCampaignHeader ret;
  387. ret.version = reader.readUInt32();
  388. ret.mapVersion = reader.readUInt8() - 1;//change range of it from [1, 20] to [0, 19]
  389. ret.name = readLocalizedString(reader, filename, modName, encoding, "name");
  390. ret.description = readLocalizedString(reader, filename, modName, encoding, "description");
  391. if (ret.version > CampaignVersion::RoE)
  392. ret.difficultyChoosenByPlayer = reader.readInt8();
  393. else
  394. ret.difficultyChoosenByPlayer = 0;
  395. ret.music = reader.readInt8();
  396. ret.filename = filename;
  397. ret.modName = modName;
  398. ret.encoding = encoding;
  399. ret.valid = true;
  400. return ret;
  401. }
  402. CCampaignScenario CCampaignHandler::readScenarioFromMemory( CBinaryReader & reader, std::string filename, std::string modName, std::string encoding, int version, int mapVersion )
  403. {
  404. auto prologEpilogReader = [&](const std::string & identifier) -> CCampaignScenario::SScenarioPrologEpilog
  405. {
  406. CCampaignScenario::SScenarioPrologEpilog ret;
  407. ret.hasPrologEpilog = reader.readUInt8();
  408. if(ret.hasPrologEpilog)
  409. {
  410. ret.prologVideo = reader.readUInt8();
  411. ret.prologMusic = reader.readUInt8();
  412. ret.prologText = readLocalizedString(reader, filename, modName, encoding, identifier);
  413. }
  414. return ret;
  415. };
  416. CCampaignScenario ret;
  417. ret.conquered = false;
  418. ret.mapName = reader.readBaseString();
  419. ret.packedMapSize = reader.readUInt32();
  420. if(mapVersion == 18)//unholy alliance
  421. {
  422. ret.loadPreconditionRegions(reader.readUInt16());
  423. }
  424. else
  425. {
  426. ret.loadPreconditionRegions(reader.readUInt8());
  427. }
  428. ret.regionColor = reader.readUInt8();
  429. ret.difficulty = reader.readUInt8();
  430. ret.regionText = readLocalizedString(reader, filename, modName, encoding, ret.mapName + ".region");
  431. ret.prolog = prologEpilogReader(ret.mapName + ".prolog");
  432. ret.epilog = prologEpilogReader(ret.mapName + ".epilog");
  433. ret.travelOptions = readScenarioTravelFromMemory(reader, version);
  434. return ret;
  435. }
  436. void CCampaignScenario::loadPreconditionRegions(ui32 regions)
  437. {
  438. for (int i=0; i<32; i++) //for each bit in region. h3c however can only hold up to 16
  439. {
  440. if ( (1 << i) & regions)
  441. preconditionRegions.insert(i);
  442. }
  443. }
  444. CScenarioTravel CCampaignHandler::readScenarioTravelFromMemory(CBinaryReader & reader, int version )
  445. {
  446. CScenarioTravel ret;
  447. ret.whatHeroKeeps = reader.readUInt8();
  448. reader.getStream()->read(ret.monstersKeptByHero.data(), ret.monstersKeptByHero.size());
  449. if (version < CampaignVersion::SoD)
  450. {
  451. ret.artifsKeptByHero.fill(0);
  452. reader.getStream()->read(ret.artifsKeptByHero.data(), ret.artifsKeptByHero.size() - 1);
  453. }
  454. else
  455. {
  456. reader.getStream()->read(ret.artifsKeptByHero.data(), ret.artifsKeptByHero.size());
  457. }
  458. ret.startOptions = reader.readUInt8();
  459. switch(ret.startOptions)
  460. {
  461. case 0:
  462. //no bonuses. Seems to be OK
  463. break;
  464. case 1: //reading of bonuses player can choose
  465. {
  466. ret.playerColor = reader.readUInt8();
  467. ui8 numOfBonuses = reader.readUInt8();
  468. for (int g=0; g<numOfBonuses; ++g)
  469. {
  470. CScenarioTravel::STravelBonus bonus;
  471. bonus.type = static_cast<CScenarioTravel::STravelBonus::EBonusType>(reader.readUInt8());
  472. //hero: FFFD means 'most powerful' and FFFE means 'generated'
  473. switch(bonus.type)
  474. {
  475. case CScenarioTravel::STravelBonus::SPELL:
  476. {
  477. bonus.info1 = reader.readUInt16(); //hero
  478. bonus.info2 = reader.readUInt8(); //spell ID
  479. break;
  480. }
  481. case CScenarioTravel::STravelBonus::MONSTER:
  482. {
  483. bonus.info1 = reader.readUInt16(); //hero
  484. bonus.info2 = reader.readUInt16(); //monster type
  485. bonus.info3 = reader.readUInt16(); //monster count
  486. break;
  487. }
  488. case CScenarioTravel::STravelBonus::BUILDING:
  489. {
  490. bonus.info1 = reader.readUInt8(); //building ID (0 - town hall, 1 - city hall, 2 - capitol, etc)
  491. break;
  492. }
  493. case CScenarioTravel::STravelBonus::ARTIFACT:
  494. {
  495. bonus.info1 = reader.readUInt16(); //hero
  496. bonus.info2 = reader.readUInt16(); //artifact ID
  497. break;
  498. }
  499. case CScenarioTravel::STravelBonus::SPELL_SCROLL:
  500. {
  501. bonus.info1 = reader.readUInt16(); //hero
  502. bonus.info2 = reader.readUInt8(); //spell ID
  503. break;
  504. }
  505. case CScenarioTravel::STravelBonus::PRIMARY_SKILL:
  506. {
  507. bonus.info1 = reader.readUInt16(); //hero
  508. bonus.info2 = reader.readUInt32(); //bonuses (4 bytes for 4 skills)
  509. break;
  510. }
  511. case CScenarioTravel::STravelBonus::SECONDARY_SKILL:
  512. {
  513. bonus.info1 = reader.readUInt16(); //hero
  514. bonus.info2 = reader.readUInt8(); //skill ID
  515. bonus.info3 = reader.readUInt8(); //skill level
  516. break;
  517. }
  518. case CScenarioTravel::STravelBonus::RESOURCE:
  519. {
  520. bonus.info1 = reader.readUInt8(); //type
  521. //FD - wood+ore
  522. //FE - mercury+sulfur+crystal+gem
  523. bonus.info2 = reader.readUInt32(); //count
  524. break;
  525. }
  526. default:
  527. logGlobal->warn("Corrupted h3c file");
  528. break;
  529. }
  530. ret.bonusesToChoose.push_back(bonus);
  531. }
  532. break;
  533. }
  534. case 2: //reading of players (colors / scenarios ?) player can choose
  535. {
  536. ui8 numOfBonuses = reader.readUInt8();
  537. for (int g=0; g<numOfBonuses; ++g)
  538. {
  539. CScenarioTravel::STravelBonus bonus;
  540. bonus.type = CScenarioTravel::STravelBonus::HEROES_FROM_PREVIOUS_SCENARIO;
  541. bonus.info1 = reader.readUInt8(); //player color
  542. bonus.info2 = reader.readUInt8(); //from what scenario
  543. ret.bonusesToChoose.push_back(bonus);
  544. }
  545. break;
  546. }
  547. case 3: //heroes player can choose between
  548. {
  549. ui8 numOfBonuses = reader.readUInt8();
  550. for (int g=0; g<numOfBonuses; ++g)
  551. {
  552. CScenarioTravel::STravelBonus bonus;
  553. bonus.type = CScenarioTravel::STravelBonus::HERO;
  554. bonus.info1 = reader.readUInt8(); //player color
  555. bonus.info2 = reader.readUInt16(); //hero, FF FF - random
  556. ret.bonusesToChoose.push_back(bonus);
  557. }
  558. break;
  559. }
  560. default:
  561. {
  562. logGlobal->warn("Corrupted h3c file");
  563. break;
  564. }
  565. }
  566. return ret;
  567. }
  568. std::vector< std::vector<ui8> > CCampaignHandler::getFile(std::unique_ptr<CInputStream> file, bool headerOnly)
  569. {
  570. CCompressedStream stream(std::move(file), true);
  571. std::vector< std::vector<ui8> > ret;
  572. do
  573. {
  574. std::vector<ui8> block(stream.getSize());
  575. stream.read(block.data(), block.size());
  576. ret.push_back(block);
  577. }
  578. while (!headerOnly && stream.getNextBlock());
  579. return ret;
  580. }
  581. bool CCampaign::conquerable( int whichScenario ) const
  582. {
  583. //check for void scenraio
  584. if (!scenarios[whichScenario].isNotVoid())
  585. {
  586. return false;
  587. }
  588. if (scenarios[whichScenario].conquered)
  589. {
  590. return false;
  591. }
  592. //check preconditioned regions
  593. for (int g=0; g<scenarios.size(); ++g)
  594. {
  595. if( vstd::contains(scenarios[whichScenario].preconditionRegions, g) && !scenarios[g].conquered)
  596. return false; //prerequisite does not met
  597. }
  598. return true;
  599. }
  600. bool CCampaignScenario::isNotVoid() const
  601. {
  602. return !mapName.empty();
  603. }
  604. const CGHeroInstance * CCampaignScenario::strongestHero(const PlayerColor & owner)
  605. {
  606. std::function<bool(JsonNode & node)> isOwned = [owner](JsonNode & node)
  607. {
  608. auto * h = CCampaignState::crossoverDeserialize(node);
  609. bool result = h->tempOwner == owner;
  610. vstd::clear_pointer(h);
  611. return result;
  612. };
  613. auto ownedHeroes = crossoverHeroes | boost::adaptors::filtered(isOwned);
  614. auto i = vstd::maxElementByFun(ownedHeroes, [](JsonNode & node)
  615. {
  616. auto * h = CCampaignState::crossoverDeserialize(node);
  617. double result = h->getHeroStrength();
  618. vstd::clear_pointer(h);
  619. return result;
  620. });
  621. return i == ownedHeroes.end() ? nullptr : CCampaignState::crossoverDeserialize(*i);
  622. }
  623. std::vector<CGHeroInstance *> CCampaignScenario::getLostCrossoverHeroes()
  624. {
  625. std::vector<CGHeroInstance *> lostCrossoverHeroes;
  626. if(conquered)
  627. {
  628. for(auto node2 : placedCrossoverHeroes)
  629. {
  630. auto * hero = CCampaignState::crossoverDeserialize(node2);
  631. auto it = range::find_if(crossoverHeroes, [hero](JsonNode node)
  632. {
  633. auto * h = CCampaignState::crossoverDeserialize(node);
  634. bool result = hero->subID == h->subID;
  635. vstd::clear_pointer(h);
  636. return result;
  637. });
  638. if(it == crossoverHeroes.end())
  639. {
  640. lostCrossoverHeroes.push_back(hero);
  641. }
  642. }
  643. }
  644. return lostCrossoverHeroes;
  645. }
  646. void CCampaignState::setCurrentMapAsConquered(const std::vector<CGHeroInstance *> & heroes)
  647. {
  648. camp->scenarios[*currentMap].crossoverHeroes.clear();
  649. for(CGHeroInstance * hero : heroes)
  650. {
  651. camp->scenarios[*currentMap].crossoverHeroes.push_back(crossoverSerialize(hero));
  652. }
  653. mapsConquered.push_back(*currentMap);
  654. mapsRemaining -= *currentMap;
  655. camp->scenarios[*currentMap].conquered = true;
  656. }
  657. boost::optional<CScenarioTravel::STravelBonus> CCampaignState::getBonusForCurrentMap() const
  658. {
  659. auto bonuses = getCurrentScenario().travelOptions.bonusesToChoose;
  660. assert(chosenCampaignBonuses.count(*currentMap) || bonuses.size() == 0);
  661. if(bonuses.empty())
  662. return boost::optional<CScenarioTravel::STravelBonus>();
  663. else
  664. return bonuses[currentBonusID()];
  665. }
  666. const CCampaignScenario & CCampaignState::getCurrentScenario() const
  667. {
  668. return camp->scenarios[*currentMap];
  669. }
  670. CCampaignScenario & CCampaignState::getCurrentScenario()
  671. {
  672. return camp->scenarios[*currentMap];
  673. }
  674. ui8 CCampaignState::currentBonusID() const
  675. {
  676. return chosenCampaignBonuses.at(*currentMap);
  677. }
  678. CCampaignState::CCampaignState( std::unique_ptr<CCampaign> _camp ) : camp(std::move(_camp))
  679. {
  680. for(int i = 0; i < camp->scenarios.size(); i++)
  681. {
  682. if(vstd::contains(camp->mapPieces, i)) //not all maps must be present in a campaign
  683. mapsRemaining.push_back(i);
  684. }
  685. }
  686. CMap * CCampaignState::getMap(int scenarioId) const
  687. {
  688. // FIXME: there is certainly better way to handle maps inside campaigns
  689. if(scenarioId == -1)
  690. scenarioId = currentMap.get();
  691. CMapService mapService;
  692. if(camp->header.version == CampaignVersion::Version::VCMI)
  693. return mapService.loadMap(ResourceID(camp->scenarios.at(scenarioId).mapName, EResType::MAP)).release();
  694. std::string scenarioName = camp->header.filename.substr(0, camp->header.filename.find('.'));
  695. boost::to_lower(scenarioName);
  696. scenarioName += ':' + std::to_string(scenarioId);
  697. std::string & mapContent = camp->mapPieces.find(scenarioId)->second;
  698. const auto * buffer = reinterpret_cast<const ui8 *>(mapContent.data());
  699. return mapService.loadMap(buffer, static_cast<int>(mapContent.size()), scenarioName, camp->header.modName, camp->header.encoding).release();
  700. }
  701. std::unique_ptr<CMapHeader> CCampaignState::getHeader(int scenarioId) const
  702. {
  703. if(scenarioId == -1)
  704. scenarioId = currentMap.get();
  705. CMapService mapService;
  706. if(camp->header.version == CampaignVersion::Version::VCMI)
  707. return mapService.loadMapHeader(ResourceID(camp->scenarios.at(scenarioId).mapName, EResType::MAP));
  708. std::string scenarioName = camp->header.filename.substr(0, camp->header.filename.find('.'));
  709. boost::to_lower(scenarioName);
  710. scenarioName += ':' + std::to_string(scenarioId);
  711. std::string & mapContent = camp->mapPieces.find(scenarioId)->second;
  712. const auto * buffer = reinterpret_cast<const ui8 *>(mapContent.data());
  713. return mapService.loadMapHeader(buffer, static_cast<int>(mapContent.size()), scenarioName, camp->header.modName, camp->header.encoding);
  714. }
  715. std::shared_ptr<CMapInfo> CCampaignState::getMapInfo(int scenarioId) const
  716. {
  717. if(scenarioId == -1)
  718. scenarioId = currentMap.get();
  719. auto mapInfo = std::make_shared<CMapInfo>();
  720. mapInfo->fileURI = camp->header.filename;
  721. mapInfo->mapHeader = getHeader(scenarioId);
  722. mapInfo->countPlayers();
  723. return mapInfo;
  724. }
  725. JsonNode CCampaignState::crossoverSerialize(CGHeroInstance * hero)
  726. {
  727. JsonNode node;
  728. JsonSerializer handler(nullptr, node);
  729. hero->serializeJsonOptions(handler);
  730. return node;
  731. }
  732. CGHeroInstance * CCampaignState::crossoverDeserialize(JsonNode & node)
  733. {
  734. JsonDeserializer handler(nullptr, node);
  735. auto * hero = new CGHeroInstance();
  736. hero->ID = Obj::HERO;
  737. hero->serializeJsonOptions(handler);
  738. return hero;
  739. }
  740. std::string CCampaignHandler::prologVideoName(ui8 index)
  741. {
  742. JsonNode config(ResourceID(std::string("CONFIG/campaignMedia"), EResType::TEXT));
  743. auto vids = config["videos"].Vector();
  744. if(index < vids.size())
  745. return vids[index].String();
  746. return "";
  747. }
  748. std::string CCampaignHandler::prologMusicName(ui8 index)
  749. {
  750. std::vector<std::string> music;
  751. return VLC->generaltexth->translate("core.cmpmusic." + std::to_string(static_cast<int>(index)));
  752. }
  753. std::string CCampaignHandler::prologVoiceName(ui8 index)
  754. {
  755. JsonNode config(ResourceID(std::string("CONFIG/campaignMedia"), EResType::TEXT));
  756. auto audio = config["voice"].Vector();
  757. if(index < audio.size())
  758. return audio[index].String();
  759. return "";
  760. }
  761. VCMI_LIB_NAMESPACE_END