JsonBonus.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931
  1. /*
  2. * JsonUtils.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 "JsonBonus.h"
  12. #include "JsonValidator.h"
  13. #include "../texts/CGeneralTextHandler.h"
  14. #include "../GameLibrary.h"
  15. #include "../bonuses/Limiters.h"
  16. #include "../bonuses/Propagators.h"
  17. #include "../bonuses/Updaters.h"
  18. #include "../CBonusTypeHandler.h"
  19. #include "../constants/StringConstants.h"
  20. #include "../modding/IdentifierStorage.h"
  21. VCMI_LIB_USING_NAMESPACE
  22. template <typename T>
  23. const T parseByMap(const std::map<std::string, T> & map, const JsonNode * val, const std::string & err)
  24. {
  25. if (!val->isNull())
  26. {
  27. const std::string & type = val->String();
  28. auto it = map.find(type);
  29. if (it == map.end())
  30. {
  31. logMod->error("Error: invalid %s%s.", err, type);
  32. return {};
  33. }
  34. else
  35. {
  36. return it->second;
  37. }
  38. }
  39. else
  40. return {};
  41. }
  42. template <typename T>
  43. const T parseByMapN(const std::map<std::string, T> & map, const JsonNode * val, const std::string & err)
  44. {
  45. if(val->isNumber())
  46. return static_cast<T>(val->Integer());
  47. else
  48. return parseByMap<T>(map, val, err);
  49. }
  50. static void loadBonusSubtype(BonusSubtypeID & subtype, BonusType type, const JsonNode & node)
  51. {
  52. if (node.isNull())
  53. {
  54. subtype = BonusSubtypeID();
  55. return;
  56. }
  57. if (node.isNumber()) // Compatibility code for 1.3 or older
  58. {
  59. logMod->warn("Bonus subtype must be string! (%s)", node.getModScope());
  60. subtype = BonusCustomSubtype(node.Integer());
  61. return;
  62. }
  63. if (!node.isString())
  64. {
  65. logMod->warn("Bonus subtype must be string! (%s)", node.getModScope());
  66. subtype = BonusSubtypeID();
  67. return;
  68. }
  69. switch (type)
  70. {
  71. case BonusType::MAGIC_SCHOOL_SKILL:
  72. case BonusType::SPELL_DAMAGE:
  73. case BonusType::SPELLS_OF_SCHOOL:
  74. case BonusType::SPELL_DAMAGE_REDUCTION:
  75. case BonusType::SPELL_SCHOOL_IMMUNITY:
  76. case BonusType::NEGATIVE_EFFECTS_IMMUNITY:
  77. {
  78. LIBRARY->identifiers()->requestIdentifier( "spellSchool", node, [&subtype](int32_t identifier)
  79. {
  80. subtype = SpellSchool(identifier);
  81. });
  82. break;
  83. }
  84. case BonusType::NO_TERRAIN_PENALTY:
  85. {
  86. LIBRARY->identifiers()->requestIdentifier( "terrain", node, [&subtype](int32_t identifier)
  87. {
  88. subtype = TerrainId(identifier);
  89. });
  90. break;
  91. }
  92. case BonusType::PRIMARY_SKILL:
  93. {
  94. LIBRARY->identifiers()->requestIdentifier( "primarySkill", node, [&subtype](int32_t identifier)
  95. {
  96. subtype = PrimarySkill(identifier);
  97. });
  98. break;
  99. }
  100. case BonusType::IMPROVED_NECROMANCY:
  101. case BonusType::HERO_GRANTS_ATTACKS:
  102. case BonusType::BONUS_DAMAGE_CHANCE:
  103. case BonusType::BONUS_DAMAGE_PERCENTAGE:
  104. case BonusType::SPECIAL_UPGRADE:
  105. case BonusType::HATE:
  106. case BonusType::SUMMON_GUARDIANS:
  107. case BonusType::MANUAL_CONTROL:
  108. case BonusType::SKELETON_TRANSFORMER_TARGET:
  109. {
  110. LIBRARY->identifiers()->requestIdentifier( "creature", node, [&subtype](int32_t identifier)
  111. {
  112. subtype = CreatureID(identifier);
  113. });
  114. break;
  115. }
  116. case BonusType::SPELL_IMMUNITY:
  117. case BonusType::SPELL_DURATION:
  118. case BonusType::SPECIAL_ADD_VALUE_ENCHANT:
  119. case BonusType::SPECIAL_FIXED_VALUE_ENCHANT:
  120. case BonusType::SPECIAL_PECULIAR_ENCHANT:
  121. case BonusType::SPECIAL_SPELL_LEV:
  122. case BonusType::SPECIFIC_SPELL_DAMAGE:
  123. case BonusType::SPELL:
  124. case BonusType::OPENING_BATTLE_SPELL:
  125. case BonusType::SPELL_LIKE_ATTACK:
  126. case BonusType::CATAPULT:
  127. case BonusType::CATAPULT_EXTRA_SHOTS:
  128. case BonusType::HEALER:
  129. case BonusType::SPELLCASTER:
  130. case BonusType::ENCHANTER:
  131. case BonusType::SPELL_AFTER_ATTACK:
  132. case BonusType::SPELL_BEFORE_ATTACK:
  133. case BonusType::SPECIFIC_SPELL_POWER:
  134. case BonusType::ENCHANTED:
  135. case BonusType::MORE_DAMAGE_FROM_SPELL:
  136. case BonusType::NOT_ACTIVE:
  137. {
  138. LIBRARY->identifiers()->requestIdentifier( "spell", node, [&subtype](int32_t identifier)
  139. {
  140. subtype = SpellID(identifier);
  141. });
  142. break;
  143. }
  144. case BonusType::GENERATE_RESOURCE:
  145. case BonusType::RESOURCES_CONSTANT_BOOST:
  146. case BonusType::RESOURCES_TOWN_MULTIPLYING_BOOST:
  147. {
  148. LIBRARY->identifiers()->requestIdentifier( "resource", node, [&subtype](int32_t identifier)
  149. {
  150. subtype = GameResID(identifier);
  151. });
  152. break;
  153. }
  154. case BonusType::MOVEMENT:
  155. case BonusType::WATER_WALKING:
  156. case BonusType::FLYING_MOVEMENT:
  157. case BonusType::NEGATE_ALL_NATURAL_IMMUNITIES:
  158. case BonusType::CREATURE_DAMAGE:
  159. case BonusType::FLYING:
  160. case BonusType::FIRST_STRIKE:
  161. case BonusType::GENERAL_DAMAGE_REDUCTION:
  162. case BonusType::PERCENTAGE_DAMAGE_BOOST:
  163. case BonusType::SOUL_STEAL:
  164. case BonusType::TRANSMUTATION:
  165. case BonusType::DESTRUCTION:
  166. case BonusType::DEATH_STARE:
  167. case BonusType::REBIRTH:
  168. case BonusType::VISIONS:
  169. case BonusType::SPELLS_OF_LEVEL: // spell level
  170. case BonusType::CREATURE_GROWTH: // creature level
  171. {
  172. LIBRARY->identifiers()->requestIdentifier( "bonusSubtype", node, [&subtype](int32_t identifier)
  173. {
  174. subtype = BonusCustomSubtype(identifier);
  175. });
  176. break;
  177. }
  178. default:
  179. {
  180. logMod->warn("Bonus type %s does not supports subtypes!", LIBRARY->bth->bonusToString(type));
  181. subtype = BonusSubtypeID();
  182. }
  183. }
  184. }
  185. static void loadBonusAddInfo(CAddInfo & var, BonusType type, const JsonNode & value)
  186. {
  187. const auto & getFirstValue = [](const JsonNode & jsonNode) -> const JsonNode &
  188. {
  189. if (jsonNode.isVector())
  190. return jsonNode[0];
  191. else
  192. return jsonNode;
  193. };
  194. if (value.isNull())
  195. return;
  196. switch (type)
  197. {
  198. case BonusType::IMPROVED_NECROMANCY:
  199. case BonusType::SPECIAL_ADD_VALUE_ENCHANT:
  200. case BonusType::SPECIAL_FIXED_VALUE_ENCHANT:
  201. case BonusType::DESTRUCTION:
  202. case BonusType::LIMITED_SHOOTING_RANGE:
  203. case BonusType::ACID_BREATH:
  204. case BonusType::BIND_EFFECT:
  205. case BonusType::SPELLCASTER:
  206. case BonusType::FEROCITY:
  207. case BonusType::PRIMARY_SKILL:
  208. case BonusType::ENCHANTER:
  209. case BonusType::SPECIAL_PECULIAR_ENCHANT:
  210. case BonusType::SPELL_IMMUNITY:
  211. case BonusType::DARKNESS:
  212. case BonusType::FULL_MAP_SCOUTING:
  213. case BonusType::FULL_MAP_DARKNESS:
  214. // 1 number
  215. var = getFirstValue(value).Integer();
  216. break;
  217. case BonusType::SPECIAL_UPGRADE:
  218. case BonusType::TRANSMUTATION:
  219. // 1 creature ID
  220. LIBRARY->identifiers()->requestIdentifier("creature", getFirstValue(value), [&](si32 identifier) { var = identifier; });
  221. break;
  222. case BonusType::DEATH_STARE:
  223. // 1 spell ID
  224. LIBRARY->identifiers()->requestIdentifier("spell", getFirstValue(value), [&](si32 identifier) { var = identifier; });
  225. break;
  226. case BonusType::SPELL_BEFORE_ATTACK:
  227. case BonusType::SPELL_AFTER_ATTACK:
  228. // 3 numbers
  229. if (value.isNumber())
  230. {
  231. var = getFirstValue(value).Integer();
  232. }
  233. else
  234. {
  235. var.resize(3);
  236. var[0] = value[0].Integer();
  237. var[1] = value[1].Integer();
  238. var[2] = value[2].Integer();
  239. }
  240. break;
  241. case BonusType::MULTIHEX_UNIT_ATTACK:
  242. case BonusType::MULTIHEX_ENEMY_ATTACK:
  243. case BonusType::MULTIHEX_ANIMATION:
  244. for (const auto & sequence : value.Vector())
  245. {
  246. static const std::map<char, int> charToDirection = {
  247. { 'f', 1 }, { 'l', 6}, {'r', 2}, {'b', 4}
  248. };
  249. int converted = 0;
  250. for (const auto & ch : boost::adaptors::reverse(sequence.String()))
  251. {
  252. char chLower = std::tolower(ch);
  253. if (charToDirection.count(chLower))
  254. converted = 10 * converted + charToDirection.at(chLower);
  255. }
  256. var.push_back(converted);
  257. }
  258. break;
  259. default:
  260. logMod->warn("Bonus type %s does not supports addInfo!", LIBRARY->bth->bonusToString(type) );
  261. }
  262. }
  263. static void loadBonusSourceInstance(BonusSourceID & sourceInstance, BonusSource sourceType, const JsonNode & node)
  264. {
  265. if (node.isNull())
  266. {
  267. sourceInstance = BonusCustomSource();
  268. return;
  269. }
  270. if (node.isNumber()) // Compatibility code for 1.3 or older
  271. {
  272. logMod->warn("Bonus source must be string!");
  273. sourceInstance = BonusCustomSource(node.Integer());
  274. return;
  275. }
  276. if (!node.isString())
  277. {
  278. logMod->warn("Bonus source must be string!");
  279. sourceInstance = BonusCustomSource();
  280. return;
  281. }
  282. switch (sourceType)
  283. {
  284. case BonusSource::ARTIFACT:
  285. case BonusSource::ARTIFACT_INSTANCE:
  286. {
  287. LIBRARY->identifiers()->requestIdentifier( "artifact", node, [&sourceInstance](int32_t identifier)
  288. {
  289. sourceInstance = ArtifactID(identifier);
  290. });
  291. break;
  292. }
  293. case BonusSource::OBJECT_TYPE:
  294. {
  295. LIBRARY->identifiers()->requestIdentifier( "object", node, [&sourceInstance](int32_t identifier)
  296. {
  297. sourceInstance = Obj(identifier);
  298. });
  299. break;
  300. }
  301. case BonusSource::OBJECT_INSTANCE:
  302. case BonusSource::HERO_BASE_SKILL:
  303. sourceInstance = ObjectInstanceID(ObjectInstanceID::decode(node.String()));
  304. break;
  305. case BonusSource::CREATURE_ABILITY:
  306. {
  307. LIBRARY->identifiers()->requestIdentifier( "creature", node, [&sourceInstance](int32_t identifier)
  308. {
  309. sourceInstance = CreatureID(identifier);
  310. });
  311. break;
  312. }
  313. case BonusSource::TERRAIN_OVERLAY:
  314. {
  315. LIBRARY->identifiers()->requestIdentifier( "spell", node, [&sourceInstance](int32_t identifier)
  316. {
  317. sourceInstance = BattleField(identifier);
  318. });
  319. break;
  320. }
  321. case BonusSource::SPELL_EFFECT:
  322. {
  323. LIBRARY->identifiers()->requestIdentifier( "spell", node, [&sourceInstance](int32_t identifier)
  324. {
  325. sourceInstance = SpellID(identifier);
  326. });
  327. break;
  328. }
  329. case BonusSource::TOWN_STRUCTURE:
  330. assert(0); // TODO
  331. sourceInstance = BuildingTypeUniqueID();
  332. break;
  333. case BonusSource::SECONDARY_SKILL:
  334. {
  335. LIBRARY->identifiers()->requestIdentifier( "secondarySkill", node, [&sourceInstance](int32_t identifier)
  336. {
  337. sourceInstance = SecondarySkill(identifier);
  338. });
  339. break;
  340. }
  341. case BonusSource::HERO_SPECIAL:
  342. {
  343. LIBRARY->identifiers()->requestIdentifier( "hero", node, [&sourceInstance](int32_t identifier)
  344. {
  345. sourceInstance = HeroTypeID(identifier);
  346. });
  347. break;
  348. }
  349. case BonusSource::CAMPAIGN_BONUS:
  350. sourceInstance = CampaignScenarioID(CampaignScenarioID::decode(node.String()));
  351. break;
  352. case BonusSource::ARMY:
  353. case BonusSource::STACK_EXPERIENCE:
  354. case BonusSource::COMMANDER:
  355. case BonusSource::GLOBAL:
  356. case BonusSource::TERRAIN_NATIVE:
  357. case BonusSource::OTHER:
  358. default:
  359. sourceInstance = BonusSourceID();
  360. break;
  361. }
  362. }
  363. static TUpdaterPtr parseUpdater(const JsonNode & updaterJson)
  364. {
  365. const std::map<std::string, std::shared_ptr<IUpdater>> bonusUpdaterMap =
  366. {
  367. {"TIMES_HERO_LEVEL", std::make_shared<TimesHeroLevelUpdater>()},
  368. {"TIMES_HERO_LEVEL_DIVIDE_STACK_LEVEL", std::make_shared<TimesHeroLevelDivideStackLevelUpdater>()},
  369. {"DIVIDE_STACK_LEVEL", std::make_shared<DivideStackLevelUpdater>()},
  370. {"TIMES_STACK_LEVEL", std::make_shared<TimesStackLevelUpdater>()},
  371. {"TIMES_STACK_SIZE", std::make_shared<TimesStackSizeUpdater>()},
  372. {"BONUS_OWNER_UPDATER", std::make_shared<OwnerUpdater>()}
  373. };
  374. switch(updaterJson.getType())
  375. {
  376. case JsonNode::JsonType::DATA_STRING:
  377. {
  378. auto it = bonusUpdaterMap.find(updaterJson.String());
  379. if (it != bonusUpdaterMap.end())
  380. return it->second;
  381. logGlobal->error("Unknown bonus updater type '%s'", updaterJson.String());
  382. return nullptr;
  383. }
  384. case JsonNode::JsonType::DATA_STRUCT:
  385. if(updaterJson["type"].String() == "GROWS_WITH_LEVEL")
  386. {
  387. // MOD COMPATIBILITY - parameters is deprecated in 1.7
  388. const JsonNode & param = updaterJson["parameters"];
  389. int valPer20 = updaterJson["valPer20"].isNull() ? param[0].Integer() : updaterJson["valPer20"].Integer();
  390. int stepSize = updaterJson["stepSize"].isNull() ? param[1].Integer() : updaterJson["stepSize"].Integer();
  391. return std::make_shared<GrowsWithLevelUpdater>(valPer20, std::max(1, stepSize));
  392. }
  393. if(updaterJson["type"].String() == "TIMES_HERO_LEVEL")
  394. {
  395. int stepSize = updaterJson["stepSize"].Integer();
  396. return std::make_shared<TimesHeroLevelUpdater>(std::max(1, stepSize));
  397. }
  398. if(updaterJson["type"].String() == "TIMES_STACK_SIZE")
  399. {
  400. int minimum = updaterJson["minimum"].isNull() ? std::numeric_limits<int>::min() : updaterJson["minimum"].Integer();
  401. int maximum = updaterJson["maximum"].isNull() ? std::numeric_limits<int>::max() : updaterJson["maximum"].Integer();
  402. int stepSize = updaterJson["stepSize"].Integer();
  403. if (minimum > maximum)
  404. {
  405. logMod->warn("TIMES_STACK_SIZE updater: minimum value (%d) is above maximum value(%d)!", minimum, maximum);
  406. return std::make_shared<TimesStackSizeUpdater>(maximum, minimum, std::max(1, stepSize));
  407. }
  408. return std::make_shared<TimesStackSizeUpdater>(minimum, maximum, std::max(1, stepSize));
  409. }
  410. if(updaterJson["type"].String() == "TIMES_ARMY_SIZE")
  411. {
  412. auto result = std::make_shared<TimesArmySizeUpdater>();
  413. result->minimum = updaterJson["minimum"].isNull() ? std::numeric_limits<int>::min() : updaterJson["minimum"].Integer();
  414. result->maximum = updaterJson["maximum"].isNull() ? std::numeric_limits<int>::max() : updaterJson["maximum"].Integer();
  415. result->stepSize = updaterJson["stepSize"].isNull() ? 1 : updaterJson["stepSize"].Integer();
  416. result->filteredLevel = updaterJson["filteredLevel"].isNull() ? -1 : updaterJson["filteredLevel"].Integer();
  417. if (result->minimum > result->maximum)
  418. {
  419. logMod->warn("TIMES_ARMY_SIZE updater: minimum value (%d) is above maximum value(%d)!", result->minimum, result->maximum);
  420. std::swap(result->minimum, result->maximum);
  421. }
  422. if (!updaterJson["filteredFaction"].isNull())
  423. {
  424. LIBRARY->identifiers()->requestIdentifier( "faction", updaterJson["filteredFaction"], [result](int32_t identifier)
  425. {
  426. result->filteredFaction = FactionID(identifier);
  427. });
  428. }
  429. if (!updaterJson["filteredCreature"].isNull())
  430. {
  431. LIBRARY->identifiers()->requestIdentifier( "creature", updaterJson["filteredCreature"], [result](int32_t identifier)
  432. {
  433. result->filteredCreature = CreatureID(identifier);
  434. });
  435. }
  436. return result;
  437. }
  438. else
  439. logMod->warn("Unknown updater type \"%s\"", updaterJson["type"].String());
  440. break;
  441. }
  442. return nullptr;
  443. }
  444. VCMI_LIB_NAMESPACE_BEGIN
  445. std::shared_ptr<Bonus> JsonUtils::parseBonus(const JsonVector & ability_vec)
  446. {
  447. auto b = std::make_shared<Bonus>();
  448. const JsonNode & typeNode = ability_vec[0];
  449. const JsonNode & subtypeNode = ability_vec[2];
  450. LIBRARY->identifiers()->requestIdentifier("bonus", typeNode, [b, subtypeNode](si32 bonusID)
  451. {
  452. b->type = static_cast<BonusType>(bonusID);
  453. loadBonusSubtype(b->subtype, b->type, subtypeNode);
  454. });
  455. b->val = static_cast<si32>(ability_vec[1].Float());
  456. b->additionalInfo = static_cast<si32>(ability_vec[3].Float());
  457. b->duration = BonusDuration::PERMANENT; //TODO: handle flags (as integer)
  458. b->turnsRemain = 0;
  459. return b;
  460. }
  461. static std::shared_ptr<const ILimiter> parseAggregateLimiter(const JsonNode & limiter)
  462. {
  463. const JsonVector & subLimiters = limiter.Vector();
  464. if(subLimiters.empty())
  465. {
  466. logMod->warn("Warning: empty limiter list");
  467. return std::make_shared<AllOfLimiter>();
  468. }
  469. std::shared_ptr<AggregateLimiter> result;
  470. int offset = 1;
  471. // determine limiter type and offset for sub-limiters
  472. if(subLimiters[0].getType() == JsonNode::JsonType::DATA_STRING)
  473. {
  474. const std::string & aggregator = subLimiters[0].String();
  475. if(aggregator == AllOfLimiter::aggregator)
  476. result = std::make_shared<AllOfLimiter>();
  477. else if(aggregator == AnyOfLimiter::aggregator)
  478. result = std::make_shared<AnyOfLimiter>();
  479. else if(aggregator == NoneOfLimiter::aggregator)
  480. result = std::make_shared<NoneOfLimiter>();
  481. }
  482. if(!result)
  483. {
  484. // collapse for single limiter without explicit aggregate operator
  485. if(subLimiters.size() == 1)
  486. return JsonUtils::parseLimiter(subLimiters[0]);
  487. // implicit aggregator must be allOf
  488. result = std::make_shared<AllOfLimiter>();
  489. offset = 0;
  490. }
  491. if(subLimiters.size() == offset)
  492. logMod->warn("Warning: empty sub-limiter list");
  493. for(int sl = offset; sl < subLimiters.size(); ++sl)
  494. result->add(JsonUtils::parseLimiter(subLimiters[sl]));
  495. return result;
  496. }
  497. static std::shared_ptr<const ILimiter> parseCreatureTypeLimiter(const JsonNode & limiter)
  498. {
  499. auto creatureLimiter = std::make_shared<CCreatureTypeLimiter>();
  500. const JsonNode & parameters = limiter["parameters"];
  501. const JsonNode & creatureNode = limiter.Struct().count("creature") ? limiter["creature"] : parameters[0];
  502. const JsonNode & upgradesNode = limiter.Struct().count("includeUpgrades") ? limiter["includeUpgrades"] : parameters[1];
  503. LIBRARY->identifiers()->requestIdentifier( "creature", creatureNode, [creatureLimiter](si32 creature)
  504. {
  505. creatureLimiter->setCreature(CreatureID(creature));
  506. });
  507. creatureLimiter->includeUpgrades = upgradesNode.Bool();
  508. return creatureLimiter;
  509. }
  510. static std::shared_ptr<const ILimiter> parseHasAnotherBonusLimiter(const JsonNode & limiter)
  511. {
  512. auto bonusLimiter = std::make_shared<HasAnotherBonusLimiter>();
  513. static const JsonNode nullNode;
  514. const JsonNode & parameters = limiter["parameters"];
  515. const JsonNode & jsonType = limiter.Struct().count("bonusType") ? limiter["bonusType"] : parameters[0];
  516. const JsonNode & jsonSubtype = limiter.Struct().count("bonusSubtype") ? limiter["bonusSubtype"] : (parameters.Vector().size() > 2 ? parameters[1] : nullNode);
  517. const JsonNode & jsonSourceType = limiter.Struct().count("bonusSourceType") ? limiter["bonusSourceType"] : (parameters.Vector().size() > 2 ? parameters[2]["type"] : parameters[1]["type"]);
  518. const JsonNode & jsonSourceID = limiter.Struct().count("bonusSourceID") ? limiter["bonusSourceID"] : (parameters.Vector().size() > 2 ? parameters[2]["id"] : parameters[1]["id"]);
  519. if (!jsonType.isNull())
  520. {
  521. LIBRARY->identifiers()->requestIdentifier("bonus", jsonType, [bonusLimiter, jsonSubtype](si32 bonusID)
  522. {
  523. bonusLimiter->type = static_cast<BonusType>(bonusID);
  524. if (!jsonSubtype.isNull())
  525. loadBonusSubtype(bonusLimiter->subtype, bonusLimiter->type, jsonSubtype);
  526. });
  527. }
  528. if(!jsonSourceType.isNull())
  529. {
  530. auto sourceIt = bonusSourceMap.find(jsonSourceType.String());
  531. if(sourceIt != bonusSourceMap.end())
  532. {
  533. bonusLimiter->source = sourceIt->second;
  534. bonusLimiter->isSourceRelevant = true;
  535. if(!jsonSourceID.isNull()) {
  536. loadBonusSourceInstance(bonusLimiter->sid, bonusLimiter->source, jsonSourceID);
  537. bonusLimiter->isSourceIDRelevant = true;
  538. }
  539. }
  540. else
  541. logMod->warn("HAS_ANOTHER_BONUS_LIMITER: unknown bonus source type '%s'!", jsonSourceType.String());
  542. }
  543. return bonusLimiter;
  544. }
  545. static std::shared_ptr<const ILimiter> parseCreatureAlignmentLimiter(const JsonNode & limiter)
  546. {
  547. const JsonNode & parameters = limiter["parameters"];
  548. const JsonNode & alignmentNode = limiter.Struct().count("alignment") ? limiter["alignment"] : parameters[0];
  549. int alignment = vstd::find_pos(GameConstants::ALIGNMENT_NAMES, alignmentNode.String());
  550. if(alignment == -1)
  551. {
  552. logMod->error("Error: invalid alignment %s.", alignmentNode.String());
  553. return nullptr;
  554. }
  555. else
  556. return std::make_shared<CreatureAlignmentLimiter>(static_cast<EAlignment>(alignment));
  557. }
  558. static std::shared_ptr<const ILimiter> parseFactionLimiter(const JsonNode & limiter)
  559. {
  560. const JsonNode & parameters = limiter["parameters"];
  561. const JsonNode & factionNode = limiter.Struct().count("faction") ? limiter["faction"] : parameters[0];
  562. auto factionLimiter = std::make_shared<FactionLimiter>();
  563. LIBRARY->identifiers()->requestIdentifier("faction", factionNode, [=](si32 faction)
  564. {
  565. factionLimiter->faction = FactionID(faction);
  566. });
  567. return factionLimiter;
  568. }
  569. static std::shared_ptr<const ILimiter> parseCreatureLevelLimiter(const JsonNode & limiter)
  570. {
  571. const JsonNode & parameters = limiter["parameters"];
  572. const JsonNode & minLevelNode = limiter.Struct().count("minLevel") ? limiter["minLevel"] : parameters[0];
  573. const JsonNode & maxLevelNode = limiter.Struct().count("maxlevel") ? limiter["maxlevel"] : parameters[1];
  574. //If parameters is empty, level limiter works as CREATURES_ONLY limiter
  575. auto levelLimiter = std::make_shared<CreatureLevelLimiter>();
  576. if (!minLevelNode.isNull())
  577. levelLimiter->minLevel = minLevelNode.Integer();
  578. if (!maxLevelNode.isNull())
  579. levelLimiter->maxLevel = maxLevelNode.Integer();
  580. return levelLimiter;
  581. }
  582. static std::shared_ptr<const ILimiter> parseCreatureTerrainLimiter(const JsonNode & limiter)
  583. {
  584. const JsonNode & parameters = limiter["parameters"];
  585. const JsonNode & terrainNode = limiter.Struct().count("terrain") ? limiter["terrain"] : parameters[0];
  586. auto terrainLimiter = std::make_shared<CreatureTerrainLimiter>();
  587. if(!terrainNode.isNull())
  588. {
  589. LIBRARY->identifiers()->requestIdentifier("terrain", terrainNode, [terrainLimiter](si32 terrain)
  590. {
  591. terrainLimiter->terrainType = terrain;
  592. });
  593. }
  594. return terrainLimiter;
  595. }
  596. static std::shared_ptr<const ILimiter> parseUnitOnHexLimiter(const JsonNode & limiter)
  597. {
  598. const JsonNode & parameters = limiter["parameters"];
  599. const JsonNode & hexesNode = limiter.Struct().count("hexes") ? limiter["hexes"] : parameters[0];
  600. auto hexLimiter = std::make_shared<UnitOnHexLimiter>();
  601. for (const auto & parameter : hexesNode.Vector())
  602. hexLimiter->applicableHexes.insert(BattleHex(parameter.Integer()));
  603. return hexLimiter;
  604. }
  605. static std::shared_ptr<const ILimiter> parseHasChargesLimiter(const JsonNode & limiter)
  606. {
  607. const JsonNode & parameters = limiter["parameters"];
  608. const JsonNode & costNode = limiter.Struct().count("cost") ? limiter["cost"] : parameters[0];
  609. auto hasChargesLimiter = std::make_shared<HasChargesLimiter>();
  610. if (!costNode.isNull())
  611. hasChargesLimiter->chargeCost = costNode.Integer();
  612. return hasChargesLimiter;
  613. }
  614. std::shared_ptr<const ILimiter> JsonUtils::parseLimiter(const JsonNode & limiter)
  615. {
  616. static const std::map<std::string, std::function<std::shared_ptr<const ILimiter>(const JsonNode & limiter)>> limiterParsers = {
  617. {"CREATURE_TYPE_LIMITER", parseCreatureTypeLimiter },
  618. {"HAS_ANOTHER_BONUS_LIMITER", parseHasAnotherBonusLimiter },
  619. {"CREATURE_ALIGNMENT_LIMITER", parseCreatureAlignmentLimiter},
  620. {"FACTION_LIMITER", parseFactionLimiter },
  621. {"CREATURE_FACTION_LIMITER", parseFactionLimiter },
  622. {"CREATURE_LEVEL_LIMITER", parseCreatureLevelLimiter },
  623. {"CREATURE_TERRAIN_LIMITER", parseCreatureTerrainLimiter },
  624. {"UNIT_ON_HEXES", parseUnitOnHexLimiter },
  625. {"HAS_CHARGES_LIMITER", parseHasChargesLimiter },
  626. };
  627. switch(limiter.getType())
  628. {
  629. case JsonNode::JsonType::DATA_VECTOR:
  630. return parseAggregateLimiter(limiter);
  631. case JsonNode::JsonType::DATA_STRING: //pre-defined limiters
  632. return parseByMap(bonusLimiterMap, &limiter, "limiter type ");
  633. case JsonNode::JsonType::DATA_STRUCT: //customizable limiters
  634. {
  635. std::string limiterType = limiter["type"].String();
  636. if (limiterParsers.count(limiterType))
  637. return limiterParsers.at(limiterType)(limiter);
  638. else
  639. logMod->error("Error: invalid customizable limiter type %s.", limiterType);
  640. }
  641. }
  642. return nullptr;
  643. }
  644. std::shared_ptr<Bonus> JsonUtils::parseBonus(const JsonNode &ability, const TextIdentifier & descriptionID)
  645. {
  646. auto b = std::make_shared<Bonus>();
  647. if (!parseBonus(ability, b.get(), descriptionID))
  648. {
  649. // caller code can not handle this case and presumes that returned bonus is always valid
  650. logGlobal->error("Failed to parse bonus! Json config was %S ", ability.toString());
  651. b->type = BonusType::NONE;
  652. return b;
  653. }
  654. return b;
  655. }
  656. bool JsonUtils::parseBonus(const JsonNode &ability, Bonus *b, const TextIdentifier & descriptionID)
  657. {
  658. const JsonNode * value = nullptr;
  659. const JsonNode & subtypeNode = ability["subtype"];
  660. const JsonNode & addinfoNode = ability["addInfo"];
  661. if (ability["type"].isNull())
  662. {
  663. logMod->error("Failed to parse bonus. Description: '%s'. Config: '%s'", descriptionID.get(), ability.toCompactString());
  664. return false;
  665. }
  666. LIBRARY->identifiers()->requestIdentifier("bonus", ability["type"], [b, subtypeNode, addinfoNode](si32 bonusID)
  667. {
  668. b->type = static_cast<BonusType>(bonusID);
  669. loadBonusSubtype(b->subtype, b->type, subtypeNode);
  670. loadBonusAddInfo(b->additionalInfo, b->type, addinfoNode);
  671. });
  672. b->val = static_cast<si32>(ability["val"].Float());
  673. value = &ability["valueType"];
  674. if (!value->isNull())
  675. b->valType = static_cast<BonusValueType>(parseByMapN(bonusValueMap, value, "value type "));
  676. b->stacking = ability["stacking"].String();
  677. b->turnsRemain = static_cast<si32>(ability["turns"].Float());
  678. if(!ability["description"].isNull())
  679. {
  680. if (ability["description"].isString() && !ability["description"].String().empty())
  681. {
  682. if (ability["description"].String()[0] == '@')
  683. b->description.appendTextID(ability["description"].String().substr(1));
  684. else if (!descriptionID.get().empty())
  685. {
  686. LIBRARY->generaltexth->registerString(ability.getModScope(), descriptionID, ability["description"]);
  687. b->description.appendTextID(descriptionID.get());
  688. }
  689. }
  690. if (ability["description"].isNumber())
  691. b->description.appendTextID("core.arraytxt." + std::to_string(ability["description"].Integer()));
  692. }
  693. if(!ability["icon"].isNull())
  694. b->customIconPath = ImagePath::fromJson(ability["icon"]);
  695. value = &ability["effectRange"];
  696. if (!value->isNull())
  697. b->effectRange = static_cast<BonusLimitEffect>(parseByMapN(bonusLimitEffect, value, "effect range "));
  698. value = &ability["duration"];
  699. if (!value->isNull())
  700. {
  701. switch (value->getType())
  702. {
  703. case JsonNode::JsonType::DATA_STRING:
  704. b->duration = parseByMap(bonusDurationMap, value, "duration type ");
  705. break;
  706. case JsonNode::JsonType::DATA_VECTOR:
  707. {
  708. BonusDuration::Type dur = 0;
  709. for (const JsonNode & d : value->Vector())
  710. dur |= parseByMapN(bonusDurationMap, &d, "duration type ");
  711. b->duration = dur;
  712. }
  713. break;
  714. default:
  715. logMod->error("Error! Wrong bonus duration format.");
  716. }
  717. }
  718. value = &ability["sourceType"];
  719. if (!value->isNull())
  720. b->source = static_cast<BonusSource>(parseByMap(bonusSourceMap, value, "source type "));
  721. if (!ability["sourceID"].isNull())
  722. loadBonusSourceInstance(b->sid, b->source, ability["sourceID"]);
  723. value = &ability["targetSourceType"];
  724. if (!value->isNull())
  725. b->targetSourceType = static_cast<BonusSource>(parseByMap(bonusSourceMap, value, "target type "));
  726. value = &ability["limiters"];
  727. if (!value->isNull())
  728. b->limiter = parseLimiter(*value);
  729. value = &ability["propagator"];
  730. if (!value->isNull())
  731. {
  732. //ALL_CREATURES old propagator compatibility
  733. if(value->String() == "ALL_CREATURES")
  734. {
  735. logMod->warn("ALL_CREATURES propagator is deprecated. Use GLOBAL_EFFECT propagator with CREATURES_ONLY limiter");
  736. b->addLimiter(std::make_shared<CreatureLevelLimiter>());
  737. b->propagator = bonusPropagatorMap.at("GLOBAL_EFFECT");
  738. }
  739. else
  740. b->propagator = parseByMap(bonusPropagatorMap, value, "propagator type ");
  741. }
  742. value = &ability["updater"];
  743. if(!value->isNull())
  744. b->addUpdater(parseUpdater(*value));
  745. value = &ability["propagationUpdater"];
  746. if(!value->isNull())
  747. b->propagationUpdater = parseUpdater(*value);
  748. return true;
  749. }
  750. CSelector JsonUtils::parseSelector(const JsonNode & ability)
  751. {
  752. CSelector ret = Selector::all;
  753. // Recursive parsers for anyOf, allOf, noneOf
  754. const auto * value = &ability["allOf"];
  755. if(value->isVector())
  756. {
  757. for(const auto & andN : value->Vector())
  758. ret = ret.And(parseSelector(andN));
  759. }
  760. value = &ability["anyOf"];
  761. if(value->isVector())
  762. {
  763. CSelector base = Selector::none;
  764. for(const auto & andN : value->Vector())
  765. base = base.Or(parseSelector(andN));
  766. ret = ret.And(base);
  767. }
  768. value = &ability["noneOf"];
  769. if(value->isVector())
  770. {
  771. CSelector base = Selector::none;
  772. for(const auto & andN : value->Vector())
  773. base = base.Or(parseSelector(andN));
  774. ret = ret.And(base.Not());
  775. }
  776. BonusType type = BonusType::NONE;
  777. // Actual selector parser
  778. value = &ability["type"];
  779. if(value->isString())
  780. {
  781. ret = ret.And(Selector::type()(static_cast<BonusType>(*LIBRARY->identifiers()->getIdentifier("bonus", value->String()))));
  782. }
  783. value = &ability["subtype"];
  784. if(!value->isNull() && type != BonusType::NONE)
  785. {
  786. BonusSubtypeID subtype;
  787. loadBonusSubtype(subtype, type, ability);
  788. ret = ret.And(Selector::subtype()(subtype));
  789. }
  790. value = &ability["sourceType"];
  791. std::optional<BonusSource> src = std::nullopt; //Fixes for GCC false maybe-uninitialized
  792. std::optional<BonusSourceID> id = std::nullopt;
  793. if(value->isString())
  794. {
  795. auto it = bonusSourceMap.find(value->String());
  796. if(it != bonusSourceMap.end())
  797. src = it->second;
  798. }
  799. value = &ability["sourceID"];
  800. if(!value->isNull() && src.has_value())
  801. {
  802. loadBonusSourceInstance(*id, *src, ability);
  803. }
  804. if(src && id)
  805. ret = ret.And(Selector::source(*src, *id));
  806. else if(src)
  807. ret = ret.And(Selector::sourceTypeSel(*src));
  808. value = &ability["targetSourceType"];
  809. if(value->isString())
  810. {
  811. auto it = bonusSourceMap.find(value->String());
  812. if(it != bonusSourceMap.end())
  813. ret = ret.And(Selector::targetSourceType()(it->second));
  814. }
  815. value = &ability["valueType"];
  816. if(value->isString())
  817. {
  818. auto it = bonusValueMap.find(value->String());
  819. if(it != bonusValueMap.end())
  820. ret = ret.And(Selector::valueType(it->second));
  821. }
  822. CAddInfo info;
  823. value = &ability["addInfo"];
  824. if(!value->isNull())
  825. {
  826. loadBonusAddInfo(info, type, ability["addInfo"]);
  827. ret = ret.And(Selector::info()(info));
  828. }
  829. value = &ability["effectRange"];
  830. if(value->isString())
  831. {
  832. auto it = bonusLimitEffect.find(value->String());
  833. if(it != bonusLimitEffect.end())
  834. ret = ret.And(Selector::effectRange()(it->second));
  835. }
  836. value = &ability["lastsTurns"];
  837. if(value->isNumber())
  838. ret = ret.And(Selector::turns(value->Integer()));
  839. value = &ability["lastsDays"];
  840. if(value->isNumber())
  841. ret = ret.And(Selector::days(value->Integer()));
  842. return ret;
  843. }
  844. VCMI_LIB_NAMESPACE_END