JsonBonus.cpp 29 KB

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