CCampaignHandler.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857
  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. ret.monstersKeptByHero[creId / 8] |= (1 << creId % 8);
  263. }
  264. else
  265. logGlobal->warn("VCMP Loading: keepCreatures contains unresolved identifier %s", k.String());
  266. }
  267. for(auto & k : reader["keepArtifacts"].Vector())
  268. {
  269. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "artifact", k.String()))
  270. {
  271. int artId = identifier.get();
  272. ret.artifsKeptByHero[artId / 8] |= (1 << artId % 8);
  273. }
  274. else
  275. logGlobal->warn("VCMP Loading: keepArtifacts contains unresolved identifier %s", k.String());
  276. }
  277. ret.startOptions = startOptionsMap[reader["startOptions"].String()];
  278. switch(ret.startOptions)
  279. {
  280. case 0:
  281. //no bonuses. Seems to be OK
  282. break;
  283. case 1: //reading of bonuses player can choose
  284. {
  285. ret.playerColor = reader["playerColor"].Integer();
  286. for(auto & bjson : reader["bonuses"].Vector())
  287. {
  288. CScenarioTravel::STravelBonus bonus;
  289. bonus.type = bonusTypeMap[bjson["what"].String()];
  290. switch (bonus.type)
  291. {
  292. case CScenarioTravel::STravelBonus::EBonusType::RESOURCE:
  293. bonus.info1 = resourceTypeMap[bjson["type"].String()];
  294. bonus.info2 = bjson["amount"].Integer();
  295. break;
  296. case CScenarioTravel::STravelBonus::EBonusType::BUILDING:
  297. bonus.info1 = vstd::find_pos(EBuildingType::names, bjson["type"].String());
  298. if(bonus.info1 == -1)
  299. logGlobal->warn("VCMP Loading: unresolved building identifier %s", bjson["type"].String());
  300. break;
  301. default:
  302. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  303. bonus.info1 = heroId;
  304. else
  305. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "hero", bjson["hero"].String()))
  306. bonus.info1 = identifier.get();
  307. else
  308. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  309. bonus.info3 = bjson["amount"].Integer();
  310. switch(bonus.type)
  311. {
  312. case CScenarioTravel::STravelBonus::EBonusType::SPELL:
  313. case CScenarioTravel::STravelBonus::EBonusType::MONSTER:
  314. case CScenarioTravel::STravelBonus::EBonusType::SECONDARY_SKILL:
  315. case CScenarioTravel::STravelBonus::EBonusType::ARTIFACT:
  316. if(auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), bjson["what"].String(), bjson["type"].String()))
  317. bonus.info2 = identifier.get();
  318. else
  319. logGlobal->warn("VCMP Loading: unresolved %s identifier %s", bjson["what"].String(), bjson["type"].String());
  320. break;
  321. case CScenarioTravel::STravelBonus::EBonusType::SPELL_SCROLL:
  322. if(auto Identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "spell", bjson["type"].String()))
  323. bonus.info2 = Identifier.get();
  324. else
  325. logGlobal->warn("VCMP Loading: unresolved spell scroll identifier %s", bjson["type"].String());
  326. break;
  327. case CScenarioTravel::STravelBonus::EBonusType::PRIMARY_SKILL:
  328. for(auto & ps : primarySkillsMap)
  329. bonus.info2 |= bjson[ps.first].Integer() << ps.second;
  330. break;
  331. default:
  332. bonus.info2 = bjson["type"].Integer();
  333. }
  334. break;
  335. }
  336. ret.bonusesToChoose.push_back(bonus);
  337. }
  338. break;
  339. }
  340. case 2: //reading of players (colors / scenarios ?) player can choose
  341. {
  342. for(auto & bjson : reader["bonuses"].Vector())
  343. {
  344. CScenarioTravel::STravelBonus bonus;
  345. bonus.type = CScenarioTravel::STravelBonus::HEROES_FROM_PREVIOUS_SCENARIO;
  346. bonus.info1 = bjson["playerColor"].Integer(); //player color
  347. bonus.info2 = bjson["scenario"].Integer(); //from what scenario
  348. ret.bonusesToChoose.push_back(bonus);
  349. }
  350. break;
  351. }
  352. case 3: //heroes player can choose between
  353. {
  354. for(auto & bjson : reader["bonuses"].Vector())
  355. {
  356. CScenarioTravel::STravelBonus bonus;
  357. bonus.type = CScenarioTravel::STravelBonus::HERO;
  358. bonus.info1 = bjson["playerColor"].Integer(); //player color
  359. if(int heroId = heroSpecialMap[bjson["hero"].String()])
  360. bonus.info2 = heroId;
  361. else
  362. if (auto identifier = VLC->modh->identifiers.getIdentifier(CModHandler::scopeMap(), "hero", bjson["hero"].String()))
  363. bonus.info2 = identifier.get();
  364. else
  365. logGlobal->warn("VCMP Loading: unresolved hero identifier %s", bjson["hero"].String());
  366. ret.bonusesToChoose.push_back(bonus);
  367. }
  368. break;
  369. }
  370. default:
  371. {
  372. logGlobal->warn("VCMP Loading: Unsupported start options value");
  373. break;
  374. }
  375. }
  376. return ret;
  377. }
  378. CCampaignHeader CCampaignHandler::readHeaderFromMemory( CBinaryReader & reader, std::string filename, std::string modName, std::string encoding )
  379. {
  380. CCampaignHeader ret;
  381. ret.version = reader.readUInt32();
  382. ret.mapVersion = reader.readUInt8() - 1;//change range of it from [1, 20] to [0, 19]
  383. ret.name = readLocalizedString(reader, filename, modName, encoding, "name");
  384. ret.description = readLocalizedString(reader, filename, modName, encoding, "description");
  385. if (ret.version > CampaignVersion::RoE)
  386. ret.difficultyChoosenByPlayer = reader.readInt8();
  387. else
  388. ret.difficultyChoosenByPlayer = 0;
  389. ret.music = reader.readInt8();
  390. ret.filename = filename;
  391. ret.modName = modName;
  392. ret.encoding = encoding;
  393. ret.valid = true;
  394. return ret;
  395. }
  396. CCampaignScenario CCampaignHandler::readScenarioFromMemory( CBinaryReader & reader, std::string filename, std::string modName, std::string encoding, int version, int mapVersion )
  397. {
  398. auto prologEpilogReader = [&](const std::string & identifier) -> CCampaignScenario::SScenarioPrologEpilog
  399. {
  400. CCampaignScenario::SScenarioPrologEpilog ret;
  401. ret.hasPrologEpilog = reader.readUInt8();
  402. if(ret.hasPrologEpilog)
  403. {
  404. ret.prologVideo = reader.readUInt8();
  405. ret.prologMusic = reader.readUInt8();
  406. ret.prologText = readLocalizedString(reader, filename, modName, encoding, identifier);
  407. }
  408. return ret;
  409. };
  410. CCampaignScenario ret;
  411. ret.conquered = false;
  412. ret.mapName = reader.readBaseString();
  413. ret.packedMapSize = reader.readUInt32();
  414. if(mapVersion == 18)//unholy alliance
  415. {
  416. ret.loadPreconditionRegions(reader.readUInt16());
  417. }
  418. else
  419. {
  420. ret.loadPreconditionRegions(reader.readUInt8());
  421. }
  422. ret.regionColor = reader.readUInt8();
  423. ret.difficulty = reader.readUInt8();
  424. ret.regionText = readLocalizedString(reader, filename, modName, encoding, ret.mapName + ".region");
  425. ret.prolog = prologEpilogReader(ret.mapName + ".prolog");
  426. ret.epilog = prologEpilogReader(ret.mapName + ".epilog");
  427. ret.travelOptions = readScenarioTravelFromMemory(reader, version);
  428. return ret;
  429. }
  430. void CCampaignScenario::loadPreconditionRegions(ui32 regions)
  431. {
  432. for (int i=0; i<32; i++) //for each bit in region. h3c however can only hold up to 16
  433. {
  434. if ( (1 << i) & regions)
  435. preconditionRegions.insert(i);
  436. }
  437. }
  438. CScenarioTravel CCampaignHandler::readScenarioTravelFromMemory(CBinaryReader & reader, int version )
  439. {
  440. CScenarioTravel ret;
  441. ret.whatHeroKeeps = reader.readUInt8();
  442. reader.getStream()->read(ret.monstersKeptByHero.data(), ret.monstersKeptByHero.size());
  443. if (version < CampaignVersion::SoD)
  444. {
  445. ret.artifsKeptByHero.fill(0);
  446. reader.getStream()->read(ret.artifsKeptByHero.data(), ret.artifsKeptByHero.size() - 1);
  447. }
  448. else
  449. {
  450. reader.getStream()->read(ret.artifsKeptByHero.data(), ret.artifsKeptByHero.size());
  451. }
  452. ret.startOptions = reader.readUInt8();
  453. switch(ret.startOptions)
  454. {
  455. case 0:
  456. //no bonuses. Seems to be OK
  457. break;
  458. case 1: //reading of bonuses player can choose
  459. {
  460. ret.playerColor = reader.readUInt8();
  461. ui8 numOfBonuses = reader.readUInt8();
  462. for (int g=0; g<numOfBonuses; ++g)
  463. {
  464. CScenarioTravel::STravelBonus bonus;
  465. bonus.type = static_cast<CScenarioTravel::STravelBonus::EBonusType>(reader.readUInt8());
  466. //hero: FFFD means 'most powerful' and FFFE means 'generated'
  467. switch(bonus.type)
  468. {
  469. case CScenarioTravel::STravelBonus::SPELL:
  470. {
  471. bonus.info1 = reader.readUInt16(); //hero
  472. bonus.info2 = reader.readUInt8(); //spell ID
  473. break;
  474. }
  475. case CScenarioTravel::STravelBonus::MONSTER:
  476. {
  477. bonus.info1 = reader.readUInt16(); //hero
  478. bonus.info2 = reader.readUInt16(); //monster type
  479. bonus.info3 = reader.readUInt16(); //monster count
  480. break;
  481. }
  482. case CScenarioTravel::STravelBonus::BUILDING:
  483. {
  484. bonus.info1 = reader.readUInt8(); //building ID (0 - town hall, 1 - city hall, 2 - capitol, etc)
  485. break;
  486. }
  487. case CScenarioTravel::STravelBonus::ARTIFACT:
  488. {
  489. bonus.info1 = reader.readUInt16(); //hero
  490. bonus.info2 = reader.readUInt16(); //artifact ID
  491. break;
  492. }
  493. case CScenarioTravel::STravelBonus::SPELL_SCROLL:
  494. {
  495. bonus.info1 = reader.readUInt16(); //hero
  496. bonus.info2 = reader.readUInt8(); //spell ID
  497. break;
  498. }
  499. case CScenarioTravel::STravelBonus::PRIMARY_SKILL:
  500. {
  501. bonus.info1 = reader.readUInt16(); //hero
  502. bonus.info2 = reader.readUInt32(); //bonuses (4 bytes for 4 skills)
  503. break;
  504. }
  505. case CScenarioTravel::STravelBonus::SECONDARY_SKILL:
  506. {
  507. bonus.info1 = reader.readUInt16(); //hero
  508. bonus.info2 = reader.readUInt8(); //skill ID
  509. bonus.info3 = reader.readUInt8(); //skill level
  510. break;
  511. }
  512. case CScenarioTravel::STravelBonus::RESOURCE:
  513. {
  514. bonus.info1 = reader.readUInt8(); //type
  515. //FD - wood+ore
  516. //FE - mercury+sulfur+crystal+gem
  517. bonus.info2 = reader.readUInt32(); //count
  518. break;
  519. }
  520. default:
  521. logGlobal->warn("Corrupted h3c file");
  522. break;
  523. }
  524. ret.bonusesToChoose.push_back(bonus);
  525. }
  526. break;
  527. }
  528. case 2: //reading of players (colors / scenarios ?) player can choose
  529. {
  530. ui8 numOfBonuses = reader.readUInt8();
  531. for (int g=0; g<numOfBonuses; ++g)
  532. {
  533. CScenarioTravel::STravelBonus bonus;
  534. bonus.type = CScenarioTravel::STravelBonus::HEROES_FROM_PREVIOUS_SCENARIO;
  535. bonus.info1 = reader.readUInt8(); //player color
  536. bonus.info2 = reader.readUInt8(); //from what scenario
  537. ret.bonusesToChoose.push_back(bonus);
  538. }
  539. break;
  540. }
  541. case 3: //heroes player can choose between
  542. {
  543. ui8 numOfBonuses = reader.readUInt8();
  544. for (int g=0; g<numOfBonuses; ++g)
  545. {
  546. CScenarioTravel::STravelBonus bonus;
  547. bonus.type = CScenarioTravel::STravelBonus::HERO;
  548. bonus.info1 = reader.readUInt8(); //player color
  549. bonus.info2 = reader.readUInt16(); //hero, FF FF - random
  550. ret.bonusesToChoose.push_back(bonus);
  551. }
  552. break;
  553. }
  554. default:
  555. {
  556. logGlobal->warn("Corrupted h3c file");
  557. break;
  558. }
  559. }
  560. return ret;
  561. }
  562. std::vector< std::vector<ui8> > CCampaignHandler::getFile(std::unique_ptr<CInputStream> file, bool headerOnly)
  563. {
  564. CCompressedStream stream(std::move(file), true);
  565. std::vector< std::vector<ui8> > ret;
  566. do
  567. {
  568. std::vector<ui8> block(stream.getSize());
  569. stream.read(block.data(), block.size());
  570. ret.push_back(block);
  571. }
  572. while (!headerOnly && stream.getNextBlock());
  573. return ret;
  574. }
  575. bool CCampaign::conquerable( int whichScenario ) const
  576. {
  577. //check for void scenraio
  578. if (!scenarios[whichScenario].isNotVoid())
  579. {
  580. return false;
  581. }
  582. if (scenarios[whichScenario].conquered)
  583. {
  584. return false;
  585. }
  586. //check preconditioned regions
  587. for (int g=0; g<scenarios.size(); ++g)
  588. {
  589. if( vstd::contains(scenarios[whichScenario].preconditionRegions, g) && !scenarios[g].conquered)
  590. return false; //prerequisite does not met
  591. }
  592. return true;
  593. }
  594. bool CCampaignScenario::isNotVoid() const
  595. {
  596. return !mapName.empty();
  597. }
  598. const CGHeroInstance * CCampaignScenario::strongestHero(const PlayerColor & owner)
  599. {
  600. std::function<bool(JsonNode & node)> isOwned = [owner](JsonNode & node)
  601. {
  602. auto * h = CCampaignState::crossoverDeserialize(node);
  603. bool result = h->tempOwner == owner;
  604. vstd::clear_pointer(h);
  605. return result;
  606. };
  607. auto ownedHeroes = crossoverHeroes | boost::adaptors::filtered(isOwned);
  608. auto i = vstd::maxElementByFun(ownedHeroes, [](JsonNode & node)
  609. {
  610. auto * h = CCampaignState::crossoverDeserialize(node);
  611. double result = h->getHeroStrength();
  612. vstd::clear_pointer(h);
  613. return result;
  614. });
  615. return i == ownedHeroes.end() ? nullptr : CCampaignState::crossoverDeserialize(*i);
  616. }
  617. std::vector<CGHeroInstance *> CCampaignScenario::getLostCrossoverHeroes()
  618. {
  619. std::vector<CGHeroInstance *> lostCrossoverHeroes;
  620. if(conquered)
  621. {
  622. for(auto node2 : placedCrossoverHeroes)
  623. {
  624. auto * hero = CCampaignState::crossoverDeserialize(node2);
  625. auto it = range::find_if(crossoverHeroes, [hero](JsonNode node)
  626. {
  627. auto * h = CCampaignState::crossoverDeserialize(node);
  628. bool result = hero->subID == h->subID;
  629. vstd::clear_pointer(h);
  630. return result;
  631. });
  632. if(it == crossoverHeroes.end())
  633. {
  634. lostCrossoverHeroes.push_back(hero);
  635. }
  636. }
  637. }
  638. return lostCrossoverHeroes;
  639. }
  640. void CCampaignState::setCurrentMapAsConquered(const std::vector<CGHeroInstance *> & heroes)
  641. {
  642. camp->scenarios[*currentMap].crossoverHeroes.clear();
  643. for(CGHeroInstance * hero : heroes)
  644. {
  645. camp->scenarios[*currentMap].crossoverHeroes.push_back(crossoverSerialize(hero));
  646. }
  647. mapsConquered.push_back(*currentMap);
  648. mapsRemaining -= *currentMap;
  649. camp->scenarios[*currentMap].conquered = true;
  650. }
  651. boost::optional<CScenarioTravel::STravelBonus> CCampaignState::getBonusForCurrentMap() const
  652. {
  653. auto bonuses = getCurrentScenario().travelOptions.bonusesToChoose;
  654. assert(chosenCampaignBonuses.count(*currentMap) || bonuses.size() == 0);
  655. if(bonuses.empty())
  656. return boost::optional<CScenarioTravel::STravelBonus>();
  657. else
  658. return bonuses[currentBonusID()];
  659. }
  660. const CCampaignScenario & CCampaignState::getCurrentScenario() const
  661. {
  662. return camp->scenarios[*currentMap];
  663. }
  664. CCampaignScenario & CCampaignState::getCurrentScenario()
  665. {
  666. return camp->scenarios[*currentMap];
  667. }
  668. ui8 CCampaignState::currentBonusID() const
  669. {
  670. return chosenCampaignBonuses.at(*currentMap);
  671. }
  672. CCampaignState::CCampaignState( std::unique_ptr<CCampaign> _camp ) : camp(std::move(_camp))
  673. {
  674. for(int i = 0; i < camp->scenarios.size(); i++)
  675. {
  676. if(vstd::contains(camp->mapPieces, i)) //not all maps must be present in a campaign
  677. mapsRemaining.push_back(i);
  678. }
  679. }
  680. CMap * CCampaignState::getMap(int scenarioId) const
  681. {
  682. // FIXME: there is certainly better way to handle maps inside campaigns
  683. if(scenarioId == -1)
  684. scenarioId = currentMap.get();
  685. CMapService mapService;
  686. if(camp->header.version == CampaignVersion::Version::VCMI)
  687. return mapService.loadMap(ResourceID(camp->scenarios.at(scenarioId).mapName, EResType::MAP)).release();
  688. std::string scenarioName = camp->header.filename.substr(0, camp->header.filename.find('.'));
  689. boost::to_lower(scenarioName);
  690. scenarioName += ':' + std::to_string(scenarioId);
  691. std::string & mapContent = camp->mapPieces.find(scenarioId)->second;
  692. const auto * buffer = reinterpret_cast<const ui8 *>(mapContent.data());
  693. return mapService.loadMap(buffer, static_cast<int>(mapContent.size()), scenarioName, camp->header.modName, camp->header.encoding).release();
  694. }
  695. std::unique_ptr<CMapHeader> CCampaignState::getHeader(int scenarioId) const
  696. {
  697. if(scenarioId == -1)
  698. scenarioId = currentMap.get();
  699. CMapService mapService;
  700. if(camp->header.version == CampaignVersion::Version::VCMI)
  701. return mapService.loadMapHeader(ResourceID(camp->scenarios.at(scenarioId).mapName, EResType::MAP));
  702. std::string scenarioName = camp->header.filename.substr(0, camp->header.filename.find('.'));
  703. boost::to_lower(scenarioName);
  704. scenarioName += ':' + std::to_string(scenarioId);
  705. std::string & mapContent = camp->mapPieces.find(scenarioId)->second;
  706. const auto * buffer = reinterpret_cast<const ui8 *>(mapContent.data());
  707. return mapService.loadMapHeader(buffer, static_cast<int>(mapContent.size()), scenarioName, camp->header.modName, camp->header.encoding);
  708. }
  709. std::shared_ptr<CMapInfo> CCampaignState::getMapInfo(int scenarioId) const
  710. {
  711. if(scenarioId == -1)
  712. scenarioId = currentMap.get();
  713. auto mapInfo = std::make_shared<CMapInfo>();
  714. mapInfo->fileURI = camp->header.filename;
  715. mapInfo->mapHeader = getHeader(scenarioId);
  716. mapInfo->countPlayers();
  717. return mapInfo;
  718. }
  719. JsonNode CCampaignState::crossoverSerialize(CGHeroInstance * hero)
  720. {
  721. JsonNode node;
  722. JsonSerializer handler(nullptr, node);
  723. hero->serializeJsonOptions(handler);
  724. return node;
  725. }
  726. CGHeroInstance * CCampaignState::crossoverDeserialize(JsonNode & node)
  727. {
  728. JsonDeserializer handler(nullptr, node);
  729. auto * hero = new CGHeroInstance();
  730. hero->ID = Obj::HERO;
  731. hero->serializeJsonOptions(handler);
  732. return hero;
  733. }
  734. std::string CCampaignHandler::prologVideoName(ui8 index)
  735. {
  736. JsonNode config(ResourceID(std::string("CONFIG/campaignMedia"), EResType::TEXT));
  737. auto vids = config["videos"].Vector();
  738. if(index < vids.size())
  739. return vids[index].String();
  740. return "";
  741. }
  742. std::string CCampaignHandler::prologMusicName(ui8 index)
  743. {
  744. std::vector<std::string> music;
  745. return VLC->generaltexth->translate("core.cmpmusic." + std::to_string(static_cast<int>(index)));
  746. }
  747. std::string CCampaignHandler::prologVoiceName(ui8 index)
  748. {
  749. JsonNode config(ResourceID(std::string("CONFIG/campaignMedia"), EResType::TEXT));
  750. auto audio = config["voice"].Vector();
  751. if(index < audio.size())
  752. return audio[index].String();
  753. return "";
  754. }
  755. VCMI_LIB_NAMESPACE_END