CRmgTemplate.cpp 26 KB

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