JsonBonus.cpp 29 KB

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