CRmgTemplate.cpp 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165
  1. /*
  2. * CRmgTemplate.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 <vstd/ContainerUtils.h>
  12. #include <boost/bimap.hpp>
  13. #include "CRmgTemplate.h"
  14. #include "Functions.h"
  15. #include "../TerrainHandler.h"
  16. #include "../GameLibrary.h"
  17. #include "../constants/StringConstants.h"
  18. #include "../entities/faction/CTownHandler.h"
  19. #include "../entities/ResourceTypeHandler.h"
  20. #include "../modding/ModScope.h"
  21. #include "../serializer/JsonSerializeFormat.h"
  22. #include <boost/lexical_cast.hpp>
  23. VCMI_LIB_NAMESPACE_BEGIN
  24. namespace
  25. {
  26. si32 decodeZoneId(const std::string & json)
  27. {
  28. return boost::lexical_cast<si32>(json);
  29. }
  30. std::string encodeZoneId(si32 id)
  31. {
  32. return std::to_string(id);
  33. }
  34. }
  35. CTreasureInfo::CTreasureInfo()
  36. : min(0),
  37. max(0),
  38. density(0)
  39. {
  40. }
  41. CTreasureInfo::CTreasureInfo(ui32 imin, ui32 imax, ui16 idensity)
  42. : min(imin), max(imax), density(idensity)
  43. {
  44. }
  45. bool CTreasureInfo::operator==(const CTreasureInfo & other) const
  46. {
  47. return (min == other.min) && (max == other.max) && (density == other.density);
  48. }
  49. void CTreasureInfo::serializeJson(JsonSerializeFormat & handler)
  50. {
  51. handler.serializeInt("min", min, 0);
  52. handler.serializeInt("max", max, 0);
  53. handler.serializeInt("density", density, 0);
  54. }
  55. namespace rmg
  56. {
  57. const TRmgTemplateZoneId ZoneOptions::NO_ZONE = -1;
  58. ZoneOptions::CTownInfo::CTownInfo()
  59. : townCount(0),
  60. castleCount(0),
  61. townDensity(0),
  62. castleDensity(0)
  63. {
  64. }
  65. int ZoneOptions::CTownInfo::getTownCount() const
  66. {
  67. return townCount;
  68. }
  69. int ZoneOptions::CTownInfo::getCastleCount() const
  70. {
  71. return castleCount;
  72. }
  73. int ZoneOptions::CTownInfo::getTownDensity() const
  74. {
  75. return townDensity;
  76. }
  77. int ZoneOptions::CTownInfo::getCastleDensity() const
  78. {
  79. return castleDensity;
  80. }
  81. void ZoneOptions::CTownInfo::serializeJson(JsonSerializeFormat & handler)
  82. {
  83. handler.serializeInt("towns", townCount, 0);
  84. handler.serializeInt("castles", castleCount, 0);
  85. handler.serializeInt("townDensity", townDensity, 0);
  86. handler.serializeInt("castleDensity", castleDensity, 0);
  87. handler.serializeInt("townTypesLikeZone", townTypesLikeZone, NO_ZONE);
  88. handler.serializeInt("townTypesNotLikeZone", townTypesNotLikeZone, NO_ZONE);
  89. handler.serializeInt("townTypesRelatedToZoneTerrain", townTypesRelatedToZoneTerrain, NO_ZONE);
  90. }
  91. ZoneOptions::CTownHints::CTownHints()
  92. : likeZone(NO_ZONE),
  93. relatedToZoneTerrain(NO_ZONE)
  94. {
  95. }
  96. void ZoneOptions::CTownHints::serializeJson(JsonSerializeFormat & handler)
  97. {
  98. handler.serializeInt("likeZone", likeZone, NO_ZONE);
  99. auto node = handler.getCurrent();
  100. if (node["notLikeZone"].isVector())
  101. {
  102. // TODO: Utility to serialize vector of ints?
  103. auto notLikeZoneData = handler.enterArray("notLikeZone");
  104. notLikeZone.resize(notLikeZoneData.size());
  105. for (size_t i = 0; i < notLikeZoneData.size(); ++i)
  106. {
  107. notLikeZoneData.serializeInt(i, notLikeZone[i]);
  108. }
  109. }
  110. else
  111. {
  112. notLikeZone.resize(1);
  113. handler.serializeInt("notLikeZone", notLikeZone[0], NO_ZONE);
  114. }
  115. handler.serializeInt("relatedToZoneTerrain", relatedToZoneTerrain, NO_ZONE);
  116. }
  117. ZoneOptions::ZoneOptions():
  118. id(0),
  119. type(ETemplateZoneType::PLAYER_START),
  120. size(1),
  121. maxTreasureValue(0),
  122. owner(PlayerColor(0)),
  123. matchTerrainToTown(true),
  124. townsAreSameType(false),
  125. monsterStrength(EMonsterStrength::ZONE_NORMAL),
  126. townsLikeZone(NO_ZONE),
  127. minesLikeZone(NO_ZONE),
  128. terrainTypeLikeZone(NO_ZONE),
  129. treasureLikeZone(NO_ZONE),
  130. customObjectsLikeZone(NO_ZONE),
  131. visiblePosition(Point(0, 0)),
  132. visibleSize(1.0),
  133. forcedLevel(EZoneLevel::AUTOMATIC)
  134. {
  135. }
  136. TRmgTemplateZoneId ZoneOptions::getId() const
  137. {
  138. return id;
  139. }
  140. void ZoneOptions::setId(TRmgTemplateZoneId value)
  141. {
  142. if(value <= 0)
  143. throw std::runtime_error(boost::str(boost::format("Zone %d id should be greater than 0.") % id));
  144. id = value;
  145. }
  146. ETemplateZoneType ZoneOptions::getType() const
  147. {
  148. return type;
  149. }
  150. void ZoneOptions::setType(ETemplateZoneType value)
  151. {
  152. type = value;
  153. }
  154. int ZoneOptions::getSize() const
  155. {
  156. return size;
  157. }
  158. void ZoneOptions::setSize(int value)
  159. {
  160. size = value;
  161. }
  162. std::optional<int> ZoneOptions::getOwner() const
  163. {
  164. return owner;
  165. }
  166. std::set<TerrainId> ZoneOptions::getTerrainTypes() const
  167. {
  168. if (terrainTypes.empty())
  169. {
  170. return vstd::difference(getDefaultTerrainTypes(), bannedTerrains);
  171. }
  172. else
  173. {
  174. return terrainTypes;
  175. }
  176. }
  177. void ZoneOptions::setTerrainTypes(const std::set<TerrainId> & value)
  178. {
  179. terrainTypes = value;
  180. }
  181. std::set<TerrainId> ZoneOptions::getDefaultTerrainTypes() const
  182. {
  183. std::set<TerrainId> terrains;
  184. for(const auto & terrain : LIBRARY->terrainTypeHandler->objects)
  185. {
  186. if (terrain->isLand() && terrain->isPassable())
  187. {
  188. terrains.insert(terrain->getId());
  189. }
  190. }
  191. return terrains;
  192. }
  193. std::set<FactionID> ZoneOptions::getDefaultTownTypes() const
  194. {
  195. return LIBRARY->townh->getDefaultAllowed();
  196. }
  197. std::set<FactionID> ZoneOptions::getTownTypes() const
  198. {
  199. if (townTypes.empty())
  200. {
  201. //Assume that all towns are allowed, unless banned
  202. return vstd::difference(getDefaultTownTypes(), bannedTownTypes);
  203. }
  204. else
  205. {
  206. return vstd::difference(townTypes, bannedTownTypes);
  207. }
  208. }
  209. void ZoneOptions::setTownTypes(const std::set<FactionID> & value)
  210. {
  211. townTypes = value;
  212. }
  213. void ZoneOptions::setMonsterTypes(const std::set<FactionID> & value)
  214. {
  215. monsterTypes = value;
  216. }
  217. std::set<FactionID> ZoneOptions::getMonsterTypes() const
  218. {
  219. return vstd::difference(monsterTypes, bannedMonsters);
  220. }
  221. void ZoneOptions::setMinesInfo(const std::map<GameResID, ui16> & value)
  222. {
  223. mines = value;
  224. }
  225. std::map<GameResID, ui16> ZoneOptions::getMinesInfo() const
  226. {
  227. return mines;
  228. }
  229. void ZoneOptions::setTreasureInfo(const std::vector<CTreasureInfo> & value)
  230. {
  231. treasureInfo = value;
  232. recalculateMaxTreasureValue();
  233. }
  234. void ZoneOptions::recalculateMaxTreasureValue()
  235. {
  236. maxTreasureValue = 0;
  237. for (const auto& ti : treasureInfo)
  238. {
  239. vstd::amax(maxTreasureValue, ti.max);
  240. }
  241. }
  242. void ZoneOptions::addTreasureInfo(const CTreasureInfo & value)
  243. {
  244. treasureInfo.push_back(value);
  245. vstd::amax(maxTreasureValue, value.max);
  246. }
  247. std::vector<CTreasureInfo> ZoneOptions::getTreasureInfo() const
  248. {
  249. return treasureInfo;
  250. }
  251. ui32 ZoneOptions::getMaxTreasureValue() const
  252. {
  253. return maxTreasureValue;
  254. }
  255. TRmgTemplateZoneId ZoneOptions::getMinesLikeZone() const
  256. {
  257. return minesLikeZone;
  258. }
  259. TRmgTemplateZoneId ZoneOptions::getTerrainTypeLikeZone() const
  260. {
  261. return terrainTypeLikeZone;
  262. }
  263. TRmgTemplateZoneId ZoneOptions::getTreasureLikeZone() const
  264. {
  265. return treasureLikeZone;
  266. }
  267. ObjectConfig ZoneOptions::getCustomObjects() const
  268. {
  269. return objectConfig;
  270. }
  271. void ZoneOptions::setCustomObjects(const ObjectConfig & value)
  272. {
  273. objectConfig = value;
  274. }
  275. TRmgTemplateZoneId ZoneOptions::getCustomObjectsLikeZone() const
  276. {
  277. return customObjectsLikeZone;
  278. }
  279. TRmgTemplateZoneId ZoneOptions::getTownsLikeZone() const
  280. {
  281. return townsLikeZone;
  282. }
  283. Point ZoneOptions::getVisiblePosition() const
  284. {
  285. return visiblePosition;
  286. }
  287. void ZoneOptions::setVisiblePosition(Point value)
  288. {
  289. visiblePosition = value;
  290. }
  291. float ZoneOptions::getVisibleSize() const
  292. {
  293. return visibleSize;
  294. }
  295. void ZoneOptions::setVisibleSize(float value)
  296. {
  297. visibleSize = value;
  298. }
  299. EZoneLevel ZoneOptions::getForcedLevel() const
  300. {
  301. return forcedLevel;
  302. }
  303. void ZoneOptions::setForcedLevel(EZoneLevel value)
  304. {
  305. forcedLevel = value;
  306. }
  307. void ZoneOptions::addConnection(const ZoneConnection & connection)
  308. {
  309. connectedZoneIds.push_back(connection.getOtherZoneId(getId()));
  310. connectionDetails.push_back(connection);
  311. }
  312. std::vector<ZoneConnection> ZoneOptions::getConnections() const
  313. {
  314. return connectionDetails;
  315. }
  316. std::vector<ZoneConnection>& ZoneOptions::getConnectionsRef()
  317. {
  318. return connectionDetails;
  319. }
  320. void ZoneOptions::setRoadOption(int connectionId, rmg::ERoadOption roadOption)
  321. {
  322. for(auto & connection : connectionDetails)
  323. {
  324. if(connection.getId() == connectionId)
  325. {
  326. connection.setRoadOption(roadOption);
  327. logGlobal->info("Set road option for connection %d between zones %d and %d to %s",
  328. connectionId, connection.getZoneA(), connection.getZoneB(),
  329. roadOption == rmg::ERoadOption::ROAD_TRUE ? "true" :
  330. roadOption == rmg::ERoadOption::ROAD_FALSE ? "false" : "random");
  331. return;
  332. }
  333. }
  334. logGlobal->warn("Failed to find connection with ID %d in zone %d", connectionId, id);
  335. }
  336. std::vector<TRmgTemplateZoneId> ZoneOptions::getConnectedZoneIds() const
  337. {
  338. return connectedZoneIds;
  339. }
  340. bool ZoneOptions::areTownsSameType() const
  341. {
  342. return townsAreSameType;
  343. }
  344. bool ZoneOptions::isMatchTerrainToTown() const
  345. {
  346. return matchTerrainToTown;
  347. }
  348. void ZoneOptions::setMatchTerrainToTown(bool value)
  349. {
  350. matchTerrainToTown = value;
  351. }
  352. const ZoneOptions::CTownInfo & ZoneOptions::getPlayerTowns() const
  353. {
  354. return playerTowns;
  355. }
  356. void ZoneOptions::setPlayerTowns(const CTownInfo & value)
  357. {
  358. playerTowns = value;
  359. }
  360. const ZoneOptions::CTownInfo & ZoneOptions::getNeutralTowns() const
  361. {
  362. return neutralTowns;
  363. }
  364. void ZoneOptions::setNeutralTowns(const CTownInfo & value)
  365. {
  366. neutralTowns = value;
  367. }
  368. const std::vector<ZoneOptions::CTownHints> & ZoneOptions::getTownHints() const
  369. {
  370. return townHints;
  371. }
  372. void ZoneOptions::setTownHints(const std::vector<CTownHints> & value)
  373. {
  374. townHints = value;
  375. }
  376. std::set<FactionID> ZoneOptions::getBannedTownTypes() const
  377. {
  378. return bannedTownTypes;
  379. }
  380. void ZoneOptions::setBannedTownTypes(const std::set<FactionID> & value)
  381. {
  382. bannedTownTypes = value;
  383. }
  384. void ZoneOptions::serializeJson(JsonSerializeFormat & handler)
  385. {
  386. static const std::vector<std::string> zoneTypes =
  387. {
  388. "playerStart",
  389. "cpuStart",
  390. "treasure",
  391. "junction",
  392. "water",
  393. "sealed"
  394. };
  395. handler.serializeEnum("type", type, zoneTypes);
  396. handler.serializeInt("size", size, 1);
  397. handler.serializeInt("owner", owner);
  398. handler.serializeStruct("playerTowns", playerTowns);
  399. handler.serializeStruct("neutralTowns", neutralTowns);
  400. handler.serializeBool("matchTerrainToTown", matchTerrainToTown, true);
  401. #define SERIALIZE_ZONE_LINK(fieldName) handler.serializeInt(#fieldName, fieldName, NO_ZONE);
  402. SERIALIZE_ZONE_LINK(townsLikeZone);
  403. SERIALIZE_ZONE_LINK(minesLikeZone);
  404. SERIALIZE_ZONE_LINK(terrainTypeLikeZone);
  405. SERIALIZE_ZONE_LINK(treasureLikeZone);
  406. SERIALIZE_ZONE_LINK(customObjectsLikeZone);
  407. #undef SERIALIZE_ZONE_LINK
  408. if(terrainTypeLikeZone == NO_ZONE)
  409. {
  410. handler.serializeIdArray("terrainTypes", terrainTypes);
  411. handler.serializeIdArray("bannedTerrains", bannedTerrains);
  412. }
  413. handler.serializeBool("townsAreSameType", townsAreSameType, false);
  414. handler.serializeIdArray("allowedMonsters", monsterTypes);
  415. handler.serializeIdArray("bannedMonsters", bannedMonsters);
  416. handler.serializeIdArray("allowedTowns", townTypes);
  417. handler.serializeIdArray("bannedTowns", bannedTownTypes);
  418. handler.enterArray("townHints").serializeStruct(townHints);
  419. {
  420. //TODO: add support for std::map to serializeEnum
  421. static const std::vector<std::string> zoneMonsterStrengths =
  422. {
  423. "none",
  424. "weak",
  425. "normal",
  426. "strong"
  427. };
  428. int temporaryZoneMonsterStrengthIndex = monsterStrength == EMonsterStrength::ZONE_NONE ? 0 : monsterStrength - EMonsterStrength::ZONE_WEAK + 1 ; // temporary until serializeEnum starts supporting std::map
  429. // temporaryZoneMonsterStrengthIndex = 0, 1, 2 and 3 for monsterStrength = ZONE_NONE, ZONE_WEAK, ZONE_NORMAL and ZONE_STRONG respectively
  430. handler.serializeEnum("monsters", temporaryZoneMonsterStrengthIndex, 2, zoneMonsterStrengths); // default is normal monsters
  431. switch (temporaryZoneMonsterStrengthIndex)
  432. {
  433. case 0:
  434. monsterStrength = EMonsterStrength::ZONE_NONE;
  435. break;
  436. case 1:
  437. monsterStrength = EMonsterStrength::ZONE_WEAK;
  438. break;
  439. case 2:
  440. monsterStrength = EMonsterStrength::ZONE_NORMAL;
  441. break;
  442. case 3:
  443. monsterStrength = EMonsterStrength::ZONE_STRONG;
  444. break;
  445. }
  446. }
  447. if(treasureLikeZone == NO_ZONE)
  448. {
  449. auto treasureData = handler.enterArray("treasure");
  450. treasureData.serializeStruct(treasureInfo);
  451. if (!handler.saving)
  452. {
  453. recalculateMaxTreasureValue();
  454. }
  455. }
  456. if((minesLikeZone == NO_ZONE) && (!handler.saving || !mines.empty()))
  457. {
  458. handler.serializeIdMap<GameResID, ui16>("mines", mines);
  459. }
  460. handler.serializeStruct("customObjects", objectConfig);
  461. handler.serializeInt("visiblePositionX", visiblePosition.x);
  462. handler.serializeInt("visiblePositionY", visiblePosition.y);
  463. handler.serializeFloat("visibleSize", visibleSize);
  464. if(!handler.saving && visibleSize < 0.01)
  465. visibleSize = 1.0;
  466. {
  467. static const std::vector<std::string> zoneLevels =
  468. {
  469. "automatic",
  470. "surface",
  471. "underground"
  472. };
  473. auto levelIndex = static_cast<int>(forcedLevel);
  474. handler.serializeEnum("forcedLevel", levelIndex, static_cast<int>(EZoneLevel::AUTOMATIC), zoneLevels);
  475. forcedLevel = static_cast<EZoneLevel>(levelIndex);
  476. }
  477. }
  478. ZoneConnection::ZoneConnection():
  479. id(-1),
  480. zoneA(-1),
  481. zoneB(-1),
  482. guardStrength(0),
  483. connectionType(rmg::EConnectionType::GUARDED),
  484. hasRoad(rmg::ERoadOption::ROAD_RANDOM)
  485. {
  486. }
  487. int ZoneConnection::getId() const
  488. {
  489. return id;
  490. }
  491. void ZoneConnection::setId(int id)
  492. {
  493. this->id = id;
  494. }
  495. TRmgTemplateZoneId ZoneConnection::getZoneA() const
  496. {
  497. return zoneA;
  498. }
  499. TRmgTemplateZoneId ZoneConnection::getZoneB() const
  500. {
  501. return zoneB;
  502. }
  503. TRmgTemplateZoneId ZoneConnection::getOtherZoneId(TRmgTemplateZoneId id) const
  504. {
  505. if (id == zoneA)
  506. {
  507. return zoneB;
  508. }
  509. else if (id == zoneB)
  510. {
  511. return zoneA;
  512. }
  513. else
  514. {
  515. throw rmgException("Zone does not belong to this connection");
  516. }
  517. }
  518. int ZoneConnection::getGuardStrength() const
  519. {
  520. return guardStrength;
  521. }
  522. rmg::EConnectionType ZoneConnection::getConnectionType() const
  523. {
  524. return connectionType;
  525. }
  526. rmg::ERoadOption ZoneConnection::getRoadOption() const
  527. {
  528. return hasRoad;
  529. }
  530. void ZoneConnection::setRoadOption(rmg::ERoadOption roadOption)
  531. {
  532. hasRoad = roadOption;
  533. }
  534. bool operator==(const ZoneConnection & l, const ZoneConnection & r)
  535. {
  536. return l.id == r.id;
  537. }
  538. bool operator<(const ZoneConnection & l, const ZoneConnection & r)
  539. {
  540. return l.id < r.id;
  541. }
  542. void ZoneConnection::serializeJson(JsonSerializeFormat & handler)
  543. {
  544. static const std::vector<std::string> connectionTypes =
  545. {
  546. "guarded",
  547. "fictive",
  548. "repulsive",
  549. "wide",
  550. "forcePortal"
  551. };
  552. static const std::vector<std::string> roadOptions =
  553. {
  554. "random",
  555. "true",
  556. "false"
  557. };
  558. if (handler.saving)
  559. {
  560. std::string zoneNameA = std::to_string(zoneA);
  561. std::string zoneNameB = std::to_string(zoneB);
  562. handler.serializeString("a", zoneNameA);
  563. handler.serializeString("b", zoneNameB);
  564. }
  565. else
  566. {
  567. std::string zoneNameA;
  568. std::string zoneNameB;
  569. handler.serializeString("a", zoneNameA);
  570. handler.serializeString("b", zoneNameB);
  571. zoneA = std::stoi(zoneNameA);
  572. zoneB = std::stoi(zoneNameB);
  573. }
  574. handler.serializeInt("guard", guardStrength, 0);
  575. handler.serializeEnum("type", connectionType, connectionTypes);
  576. handler.serializeEnum("road", hasRoad, roadOptions);
  577. }
  578. }
  579. using namespace rmg;//todo: remove
  580. CRmgTemplate::~CRmgTemplate() = default;
  581. CRmgTemplate::CRmgTemplate()
  582. : minSize(72, 72, 2),
  583. maxSize(72, 72, 2),
  584. mapSettings(std::make_unique<JsonNode>())
  585. {
  586. }
  587. bool CRmgTemplate::matchesSize(const int3 & value) const
  588. {
  589. const int64_t square = value.x * value.y * value.z;
  590. const int64_t minSquare = minSize.x * minSize.y * minSize.z;
  591. const int64_t maxSquare = maxSize.x * maxSize.y * maxSize.z;
  592. return minSquare <= square && square <= maxSquare;
  593. }
  594. bool CRmgTemplate::isWaterContentAllowed(EWaterContent::EWaterContent waterContent) const
  595. {
  596. return waterContent == EWaterContent::RANDOM || allowedWaterContent.count(waterContent);
  597. }
  598. const std::set<EWaterContent::EWaterContent> & CRmgTemplate::getWaterContentAllowed() const
  599. {
  600. return allowedWaterContent;
  601. }
  602. void CRmgTemplate::setId(const std::string & value)
  603. {
  604. id = value;
  605. }
  606. void CRmgTemplate::setName(const std::string & value)
  607. {
  608. name = value;
  609. }
  610. const std::string & CRmgTemplate::getName() const
  611. {
  612. return name;
  613. }
  614. const std::string & CRmgTemplate::getDescription() const
  615. {
  616. return description;
  617. }
  618. const std::string & CRmgTemplate::getId() const
  619. {
  620. return id;
  621. }
  622. const CRmgTemplate::CPlayerCountRange & CRmgTemplate::getPlayers() const
  623. {
  624. return players;
  625. }
  626. const CRmgTemplate::CPlayerCountRange & CRmgTemplate::getHumanPlayers() const
  627. {
  628. return humanPlayers;
  629. }
  630. const CRmgTemplate::Zones & CRmgTemplate::getZones() const
  631. {
  632. return zones;
  633. }
  634. const std::vector<ZoneConnection> & CRmgTemplate::getConnectedZoneIds() const
  635. {
  636. return connections;
  637. }
  638. void CRmgTemplate::validate() const
  639. {
  640. //TODO add some validation checks, throw on failure
  641. }
  642. std::pair<int3, int3> CRmgTemplate::getMapSizes() const
  643. {
  644. return {minSize, maxSize};
  645. }
  646. void CRmgTemplate::CPlayerCountRange::addRange(int lower, int upper)
  647. {
  648. range.emplace_back(lower, upper);
  649. }
  650. void CRmgTemplate::CPlayerCountRange::addNumber(int value)
  651. {
  652. range.emplace_back(value, value);
  653. }
  654. bool CRmgTemplate::CPlayerCountRange::isInRange(int count) const
  655. {
  656. for(const auto & pair : range)
  657. {
  658. if(count >= pair.first && count <= pair.second) return true;
  659. }
  660. return false;
  661. }
  662. std::set<int> CRmgTemplate::CPlayerCountRange::getNumbers() const
  663. {
  664. std::set<int> numbers;
  665. for(const auto & pair : range)
  666. {
  667. for(int i = pair.first; i <= pair.second; ++i) numbers.insert(i);
  668. }
  669. return numbers;
  670. }
  671. std::string CRmgTemplate::CPlayerCountRange::toString() const
  672. {
  673. if(range.size() == 1)
  674. {
  675. const auto & p = range.front();
  676. if((p.first == p.second) && (p.first == 0))
  677. return "";
  678. }
  679. std::string ret;
  680. bool first = true;
  681. for(const auto & p : range)
  682. {
  683. if(!first)
  684. ret +=",";
  685. else
  686. first = false;
  687. if(p.first == p.second)
  688. {
  689. ret += std::to_string(p.first);
  690. }
  691. else
  692. {
  693. ret += boost::str(boost::format("%d-%d") % p.first % p.second);
  694. }
  695. }
  696. return ret;
  697. }
  698. void CRmgTemplate::CPlayerCountRange::fromString(const std::string & value)
  699. {
  700. range.clear();
  701. if(value.empty())
  702. {
  703. addNumber(0);
  704. }
  705. else
  706. {
  707. std::vector<std::string> commaParts;
  708. boost::split(commaParts, value, boost::is_any_of(","));
  709. for(const auto & commaPart : commaParts)
  710. {
  711. std::vector<std::string> rangeParts;
  712. boost::split(rangeParts, commaPart, boost::is_any_of("-"));
  713. if(rangeParts.size() == 2)
  714. {
  715. auto lower = boost::lexical_cast<int>(rangeParts[0]);
  716. auto upper = boost::lexical_cast<int>(rangeParts[1]);
  717. addRange(lower, upper);
  718. }
  719. else if(rangeParts.size() == 1)
  720. {
  721. auto val = boost::lexical_cast<int>(rangeParts.front());
  722. addNumber(val);
  723. }
  724. }
  725. }
  726. }
  727. int CRmgTemplate::CPlayerCountRange::maxValue() const
  728. {
  729. return *boost::max_element(getNumbers());
  730. }
  731. int CRmgTemplate::CPlayerCountRange::minValue() const
  732. {
  733. return *boost::min_element(getNumbers());
  734. }
  735. void CRmgTemplate::serializeJson(JsonSerializeFormat & handler)
  736. {
  737. handler.serializeString("name", name);
  738. handler.serializeString("description", description);
  739. serializeSize(handler, minSize, "minSize");
  740. serializeSize(handler, maxSize, "maxSize");
  741. serializePlayers(handler, players, "players");
  742. serializePlayers(handler, humanPlayers, "humans"); // TODO: Rename this parameter
  743. handler.serializeIdArray("bannedSpells", bannedSpells);
  744. handler.serializeIdArray("bannedArtifacts", bannedArtifacts);
  745. handler.serializeIdArray("bannedSkills", bannedSkills);
  746. handler.serializeIdArray("bannedHeroes", bannedHeroes);
  747. handler.serializeIdArray("enabledSpells", enabledSpells);
  748. handler.serializeIdArray("enabledArtifacts", enabledArtifacts);
  749. handler.serializeIdArray("enabledSkills", enabledSkills);
  750. handler.serializeIdArray("enabledHeroes", enabledHeroes);
  751. *mapSettings = handler.getCurrent()["settings"];
  752. {
  753. auto connectionsData = handler.enterArray("connections");
  754. connectionsData.serializeStruct(connections);
  755. if(!handler.saving)
  756. {
  757. for(size_t i = 0; i < connections.size(); ++i)
  758. {
  759. connections[i].setId(i);
  760. }
  761. }
  762. }
  763. {
  764. boost::bimap<EWaterContent::EWaterContent, std::string> enc;
  765. enc.insert({EWaterContent::NONE, "none"});
  766. enc.insert({EWaterContent::NORMAL, "normal"});
  767. enc.insert({EWaterContent::ISLANDS, "islands"});
  768. JsonNode node;
  769. if(handler.saving)
  770. {
  771. node.setType(JsonNode::JsonType::DATA_VECTOR);
  772. for(auto wc : allowedWaterContent)
  773. {
  774. JsonNode n;
  775. n.String() = enc.left.at(wc);
  776. node.Vector().push_back(n);
  777. }
  778. }
  779. handler.serializeRaw("allowedWaterContent", node, std::nullopt);
  780. if(!handler.saving)
  781. {
  782. for(auto wc : node.Vector())
  783. {
  784. allowedWaterContent.insert(enc.right.at(std::string(wc.String())));
  785. }
  786. }
  787. }
  788. {
  789. auto zonesData = handler.enterStruct("zones");
  790. if(handler.saving)
  791. {
  792. for(auto & idAndZone : zones)
  793. {
  794. auto guard = handler.enterStruct(encodeZoneId(idAndZone.first));
  795. idAndZone.second->serializeJson(handler);
  796. }
  797. }
  798. else
  799. {
  800. for(const auto & idAndZone : zonesData->getCurrent().Struct())
  801. {
  802. auto guard = handler.enterStruct(idAndZone.first);
  803. auto zone = std::make_shared<ZoneOptions>();
  804. zone->setId(decodeZoneId(idAndZone.first));
  805. zone->serializeJson(handler);
  806. zones[zone->getId()] = zone;
  807. }
  808. }
  809. }
  810. }
  811. const JsonNode & CRmgTemplate::getMapSettings() const
  812. {
  813. return *mapSettings;
  814. }
  815. template<typename T>
  816. T CRmgTemplate::inheritZoneProperty(std::shared_ptr<rmg::ZoneOptions> zone,
  817. T (rmg::ZoneOptions::*getter)() const,
  818. void (rmg::ZoneOptions::*setter)(const T&),
  819. TRmgTemplateZoneId (rmg::ZoneOptions::*inheritFrom)() const,
  820. const std::string& propertyString,
  821. uint32_t iteration)
  822. {
  823. if (iteration >= 50)
  824. {
  825. logGlobal->error("Infinite recursion for %s detected in template %s", propertyString, name);
  826. return T();
  827. }
  828. if (((*zone).*inheritFrom)() != rmg::ZoneOptions::NO_ZONE)
  829. {
  830. iteration++;
  831. const auto otherZone = zones.at(((*zone).*inheritFrom)());
  832. T inheritedValue = inheritZoneProperty(otherZone, getter, setter, inheritFrom, propertyString, iteration);
  833. ((*zone).*setter)(inheritedValue);
  834. }
  835. return ((*zone).*getter)();
  836. }
  837. void CRmgTemplate::afterLoad()
  838. {
  839. for(auto & idAndZone : zones)
  840. {
  841. auto zone = idAndZone.second;
  842. // Inherit properties recursively
  843. inheritTownProperties(zone);
  844. inheritZoneProperty(zone,
  845. &rmg::ZoneOptions::getTerrainTypes,
  846. &rmg::ZoneOptions::setTerrainTypes,
  847. &rmg::ZoneOptions::getTerrainTypeLikeZone,
  848. "terrain types");
  849. inheritZoneProperty(zone,
  850. &rmg::ZoneOptions::getMinesInfo,
  851. &rmg::ZoneOptions::setMinesInfo,
  852. &rmg::ZoneOptions::getMinesLikeZone,
  853. "mine types");
  854. inheritZoneProperty(zone,
  855. &rmg::ZoneOptions::getTreasureInfo,
  856. &rmg::ZoneOptions::setTreasureInfo,
  857. &rmg::ZoneOptions::getTreasureLikeZone,
  858. "treasure info");
  859. inheritZoneProperty(zone,
  860. &rmg::ZoneOptions::getCustomObjects,
  861. &rmg::ZoneOptions::setCustomObjects,
  862. &rmg::ZoneOptions::getCustomObjectsLikeZone,
  863. "custom objects");
  864. //TODO: Inherit monster types as well
  865. auto monsterTypes = zone->getMonsterTypes();
  866. if (monsterTypes.empty())
  867. {
  868. zone->setMonsterTypes(LIBRARY->townh->getAllowedFactions(false));
  869. }
  870. }
  871. for(const auto & connection : connections)
  872. {
  873. auto id1 = connection.getZoneA();
  874. auto id2 = connection.getZoneB();
  875. auto zone1 = zones.at(id1);
  876. auto zone2 = zones.at(id2);
  877. zone1->addConnection(connection);
  878. zone2->addConnection(connection);
  879. }
  880. if(allowedWaterContent.empty() || allowedWaterContent.count(EWaterContent::RANDOM))
  881. {
  882. allowedWaterContent.insert(EWaterContent::NONE);
  883. allowedWaterContent.insert(EWaterContent::NORMAL);
  884. allowedWaterContent.insert(EWaterContent::ISLANDS);
  885. }
  886. allowedWaterContent.erase(EWaterContent::RANDOM);
  887. }
  888. void CRmgTemplate::inheritTownProperties(std::shared_ptr<rmg::ZoneOptions> zone, uint32_t iteration)
  889. {
  890. if (iteration >= 50)
  891. {
  892. logGlobal->error("Infinite recursion for town properties detected in template %s", name);
  893. return;
  894. }
  895. if (zone->getTownsLikeZone() != rmg::ZoneOptions::NO_ZONE)
  896. {
  897. const auto otherZone = zones.at(zone->getTownsLikeZone());
  898. // Recursively inherit from the source zone first
  899. inheritTownProperties(otherZone, iteration + 1);
  900. // Now copy all town-related properties from the source zone
  901. zone->setPlayerTowns(otherZone->getPlayerTowns());
  902. zone->setNeutralTowns(otherZone->getNeutralTowns());
  903. zone->setMatchTerrainToTown(otherZone->isMatchTerrainToTown());
  904. zone->setTownHints(otherZone->getTownHints());
  905. zone->setTownTypes(otherZone->getTownTypes());
  906. zone->setBannedTownTypes(otherZone->getBannedTownTypes());
  907. }
  908. }
  909. // TODO: Allow any integer size which does not match enum, as well
  910. void CRmgTemplate::serializeSize(JsonSerializeFormat & handler, int3 & value, const std::string & fieldName)
  911. {
  912. static const std::map<std::string, int3> sizeMapping =
  913. {
  914. {"s", {CMapHeader::MAP_SIZE_SMALL, CMapHeader::MAP_SIZE_SMALL, 1}},
  915. {"s+u", {CMapHeader::MAP_SIZE_SMALL, CMapHeader::MAP_SIZE_SMALL, 2}},
  916. {"m", {CMapHeader::MAP_SIZE_MIDDLE, CMapHeader::MAP_SIZE_MIDDLE, 1}},
  917. {"m+u", {CMapHeader::MAP_SIZE_MIDDLE, CMapHeader::MAP_SIZE_MIDDLE, 2}},
  918. {"l", {CMapHeader::MAP_SIZE_LARGE, CMapHeader::MAP_SIZE_LARGE, 1}},
  919. {"l+u", {CMapHeader::MAP_SIZE_LARGE, CMapHeader::MAP_SIZE_LARGE, 2}},
  920. {"xl", {CMapHeader::MAP_SIZE_XLARGE, CMapHeader::MAP_SIZE_XLARGE, 1}} ,
  921. {"xl+u", {CMapHeader::MAP_SIZE_XLARGE, CMapHeader::MAP_SIZE_XLARGE, 2}} ,
  922. {"h", {CMapHeader::MAP_SIZE_HUGE, CMapHeader::MAP_SIZE_HUGE, 1}},
  923. {"h+u", {CMapHeader::MAP_SIZE_HUGE, CMapHeader::MAP_SIZE_HUGE, 2}},
  924. {"xh", {CMapHeader::MAP_SIZE_XHUGE, CMapHeader::MAP_SIZE_XHUGE, 1}},
  925. {"xh+u", {CMapHeader::MAP_SIZE_XHUGE, CMapHeader::MAP_SIZE_XHUGE, 2}},
  926. {"g", {CMapHeader::MAP_SIZE_GIANT, CMapHeader::MAP_SIZE_GIANT, 1}},
  927. {"g+u", {CMapHeader::MAP_SIZE_GIANT, CMapHeader::MAP_SIZE_GIANT, 2}}
  928. };
  929. static const std::map<int3, std::string> sizeReverseMapping = vstd::invertMap(sizeMapping);
  930. std::string encodedValue;
  931. if(handler.saving)
  932. {
  933. auto iter = sizeReverseMapping.find(value);
  934. if(iter == sizeReverseMapping.end())
  935. encodedValue = boost::str(boost::format("%dx%dx%d") % value.x % value.y % value.z);
  936. else
  937. encodedValue = iter->second;
  938. }
  939. handler.serializeString(fieldName, encodedValue);
  940. if(!handler.saving)
  941. {
  942. auto iter = sizeMapping.find(encodedValue);
  943. if(iter == sizeMapping.end())
  944. {
  945. std::vector<std::string> parts;
  946. boost::split(parts, encodedValue, boost::is_any_of("x"));
  947. value.x = (boost::lexical_cast<int>(parts.at(0)));
  948. value.y = (boost::lexical_cast<int>(parts.at(1)));
  949. value.z = (boost::lexical_cast<int>(parts.at(2)));
  950. }
  951. else
  952. {
  953. value = iter->second;
  954. }
  955. }
  956. }
  957. void CRmgTemplate::serializePlayers(JsonSerializeFormat & handler, CPlayerCountRange & value, const std::string & fieldName)
  958. {
  959. std::string encodedValue;
  960. if(handler.saving)
  961. encodedValue = value.toString();
  962. handler.serializeString(fieldName, encodedValue);
  963. if(!handler.saving)
  964. value.fromString(encodedValue);
  965. }
  966. const std::vector<CompoundMapObjectID> & ZoneOptions::getBannedObjects() const
  967. {
  968. return objectConfig.getBannedObjects();
  969. }
  970. const std::vector<ObjectConfig::EObjectCategory> & ZoneOptions::getBannedObjectCategories() const
  971. {
  972. return objectConfig.getBannedObjectCategories();
  973. }
  974. const std::vector<ObjectInfo> & ZoneOptions::getConfiguredObjects() const
  975. {
  976. return objectConfig.getConfiguredObjects();
  977. }
  978. VCMI_LIB_NAMESPACE_END