JsonBonus.cpp 32 KB

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