1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
|
/*
* CSpellHandler.cpp, part of VCMI engine
*
* Authors: listed in file AUTHORS in main folder
*
* License: GNU General Public License v2.0 or later
* Full text of license available in license.txt file, in main folder
*
*/
#include "StdInc.h"
#include <cctype>
#include "CSpellHandler.h"
#include "Problem.h"
#include <vcmi/spells/Caster.h>
#include "../filesystem/Filesystem.h"
#include "../constants/StringConstants.h"
#include "../battle/BattleInfo.h"
#include "../battle/CBattleInfoCallback.h"
#include "../battle/Unit.h"
#include "../json/JsonBonus.h"
#include "../json/JsonUtils.h"
#include "../mapObjects/CGHeroInstance.h" //todo: remove
#include "../modding/IdentifierStorage.h"
#include "../modding/ModUtility.h"
#include "../serializer/CSerializer.h"
#include "../texts/CLegacyConfigParser.h"
#include "../texts/CGeneralTextHandler.h"
#include "ISpellMechanics.h"
VCMI_LIB_NAMESPACE_BEGIN
namespace SpellConfig
{
static const std::string LEVEL_NAMES[] = {"none", "basic", "advanced", "expert"};
const spells::SchoolInfo SCHOOL[4] =
{
{
SpellSchool::AIR,
"air"
},
{
SpellSchool::FIRE,
"fire"
},
{
SpellSchool::WATER,
"water"
},
{
SpellSchool::EARTH,
"earth"
}
};
//order as described in http://bugs.vcmi.eu/view.php?id=91
static const SpellSchool SCHOOL_ORDER[4] =
{
SpellSchool::AIR, //=0
SpellSchool::FIRE, //=1
SpellSchool::EARTH,//=3(!)
SpellSchool::WATER //=2(!)
};
} //namespace SpellConfig
///CSpell
CSpell::CSpell():
id(SpellID::NONE),
level(0),
power(0),
combat(false),
creatureAbility(false),
castOnSelf(false),
castOnlyOnSelf(false),
castWithoutSkip(false),
positiveness(ESpellPositiveness::NEUTRAL),
defaultProbability(0),
rising(false),
damage(false),
offensive(false),
special(true),
nonMagical(false),
targetType(spells::AimType::NO_TARGET)
{
levels.resize(GameConstants::SPELL_SCHOOL_LEVELS);
}
//must be instantiated in .cpp file for access to complete types of all member fields
CSpell::~CSpell() = default;
bool CSpell::adventureCast(SpellCastEnvironment * env, const AdventureSpellCastParameters & parameters) const
{
assert(env);
if(!adventureMechanics)
{
env->complain("Invalid adventure spell cast attempt!");
return false;
}
return adventureMechanics->adventureCast(env, parameters);
}
const CSpell::LevelInfo & CSpell::getLevelInfo(const int32_t level) const
{
if(level < 0 || level >= GameConstants::SPELL_SCHOOL_LEVELS)
{
logGlobal->error("CSpell::getLevelInfo: invalid school mastery level %d", level);
return levels.at(MasteryLevel::EXPERT);
}
return levels.at(level);
}
int64_t CSpell::calculateDamage(const spells::Caster * caster) const
{
//check if spell really does damage - if not, return 0
if(!isDamage())
return 0;
auto rawDamage = calculateRawEffectValue(caster->getEffectLevel(this), caster->getEffectPower(this), 1);
return caster->getSpellBonus(this, rawDamage, nullptr);
}
bool CSpell::hasSchool(SpellSchool which) const
{
return school.count(which) && school.at(which);
}
bool CSpell::canBeCast(const CBattleInfoCallback * cb, spells::Mode mode, const spells::Caster * caster) const
{
//if caller do not interested in description just discard it and do not pollute even debug log
spells::detail::ProblemImpl problem;
return canBeCast(problem, cb, mode, caster);
}
bool CSpell::canBeCast(spells::Problem & problem, const CBattleInfoCallback * cb, spells::Mode mode, const spells::Caster * caster) const
{
spells::BattleCast event(cb, caster, mode, this);
auto mechanics = battleMechanics(&event);
return mechanics->canBeCast(problem);
}
spells::AimType CSpell::getTargetType() const
{
return targetType;
}
void CSpell::forEachSchool(const std::function<void(const SpellSchool &, bool &)>& cb) const
{
bool stop = false;
for(auto iter : SpellConfig::SCHOOL_ORDER)
{
const spells::SchoolInfo & cnf = SpellConfig::SCHOOL[iter.getNum()];
if(school.at(cnf.id))
{
cb(cnf.id, stop);
if(stop)
break;
}
}
}
SpellID CSpell::getId() const
{
return id;
}
std::string CSpell::getNameTextID() const
{
TextIdentifier id("spell", modScope, identifier, "name");
return id.get();
}
std::string CSpell::getNameTranslated() const
{
return VLC->generaltexth->translate(getNameTextID());
}
std::string CSpell::getDescriptionTextID(int32_t level) const
{
TextIdentifier id("spell", modScope, identifier, "description", SpellConfig::LEVEL_NAMES[level]);
return id.get();
}
std::string CSpell::getDescriptionTranslated(int32_t level) const
{
return VLC->generaltexth->translate(getDescriptionTextID(level));
}
std::string CSpell::getJsonKey() const
{
return modScope + ':' + identifier;
}
std::string CSpell::getModScope() const
{
return modScope;
}
int32_t CSpell::getIndex() const
{
return id.toEnum();
}
int32_t CSpell::getIconIndex() const
{
return getIndex();
}
int32_t CSpell::getLevel() const
{
return level;
}
bool CSpell::isCombat() const
{
return combat;
}
bool CSpell::isAdventure() const
{
return !combat;
}
bool CSpell::isCreatureAbility() const
{
return creatureAbility;
}
bool CSpell::isMagical() const
{
return !nonMagical;
}
bool CSpell::isPositive() const
{
return positiveness == POSITIVE;
}
bool CSpell::isNegative() const
{
return positiveness == NEGATIVE;
}
bool CSpell::isNeutral() const
{
return positiveness == NEUTRAL;
}
boost::logic::tribool CSpell::getPositiveness() const
{
switch (positiveness)
{
case CSpell::POSITIVE:
return true;
case CSpell::NEGATIVE:
return false;
default:
return boost::logic::indeterminate;
}
}
bool CSpell::isDamage() const
{
return damage;
}
bool CSpell::isOffensive() const
{
return offensive;
}
bool CSpell::isSpecial() const
{
return special;
}
bool CSpell::hasEffects() const
{
return !levels[0].effects.empty() || !levels[0].cumulativeEffects.empty();
}
bool CSpell::hasBattleEffects() const
{
return levels[0].battleEffects.getType() == JsonNode::JsonType::DATA_STRUCT && !levels[0].battleEffects.Struct().empty();
}
bool CSpell::canCastOnSelf() const
{
return castOnSelf;
}
bool CSpell::canCastOnlyOnSelf() const
{
return castOnlyOnSelf;
}
bool CSpell::canCastWithoutSkip() const
{
return castWithoutSkip;
}
const std::string & CSpell::getIconImmune() const
{
return iconImmune;
}
const std::string & CSpell::getIconBook() const
{
return iconBook;
}
const std::string & CSpell::getIconEffect() const
{
return iconEffect;
}
const std::string & CSpell::getIconScenarioBonus() const
{
return iconScenarioBonus;
}
const std::string & CSpell::getIconScroll() const
{
return iconScroll;
}
const AudioPath & CSpell::getCastSound() const
{
return castSound;
}
int32_t CSpell::getCost(const int32_t skillLevel) const
{
return getLevelInfo(skillLevel).cost;
}
int32_t CSpell::getBasePower() const
{
return power;
}
int32_t CSpell::getLevelPower(const int32_t skillLevel) const
{
return getLevelInfo(skillLevel).power;
}
si32 CSpell::getProbability(const FactionID & factionId) const
{
if(!vstd::contains(probabilities, factionId))
{
return defaultProbability;
}
return probabilities.at(factionId);
}
void CSpell::getEffects(std::vector<Bonus> & lst, const int level, const bool cumulative, const si32 duration, std::optional<si32 *> maxDuration) const
{
if(level < 0 || level >= GameConstants::SPELL_SCHOOL_LEVELS)
{
logGlobal->error("invalid school level %d", level);
return;
}
const auto & levelObject = levels.at(level);
if(levelObject.effects.empty() && levelObject.cumulativeEffects.empty())
{
logGlobal->error("This spell (%s) has no effects for level %d", getNameTranslated(), level);
return;
}
const auto & effects = cumulative ? levelObject.cumulativeEffects : levelObject.effects;
lst.reserve(lst.size() + effects.size());
for(const auto& b : effects)
{
Bonus nb(*b);
//use configured duration if present
if(nb.turnsRemain == 0)
nb.turnsRemain = duration;
if(maxDuration)
vstd::amax(*(maxDuration.value()), nb.turnsRemain);
lst.push_back(nb);
}
}
int64_t CSpell::adjustRawDamage(const spells::Caster * caster, const battle::Unit * affectedCreature, int64_t rawDamage) const
{
auto ret = rawDamage;
//affected creature-specific part
if(nullptr != affectedCreature)
{
const auto * bearer = affectedCreature->getBonusBearer();
//applying protections - when spell has more then one elements, only one protection should be applied (I think)
forEachSchool([&](const SpellSchool & cnf, bool & stop)
{
if(bearer->hasBonusOfType(BonusType::SPELL_DAMAGE_REDUCTION, BonusSubtypeID(cnf)))
{
ret *= 100 - bearer->valOfBonuses(BonusType::SPELL_DAMAGE_REDUCTION, BonusSubtypeID(cnf));
ret /= 100;
stop = true; //only bonus from one school is used
}
});
CSelector selector = Selector::typeSubtype(BonusType::SPELL_DAMAGE_REDUCTION, BonusSubtypeID(SpellSchool::ANY));
auto cachingStr = "type_SPELL_DAMAGE_REDUCTION_s_ANY";
//general spell dmg reduction, works only on magical effects
if(bearer->hasBonus(selector, cachingStr) && isMagical())
{
ret *= 100 - bearer->valOfBonuses(selector, cachingStr);
ret /= 100;
}
//dmg increasing
if(bearer->hasBonusOfType(BonusType::MORE_DAMAGE_FROM_SPELL, BonusSubtypeID(id)))
{
ret *= 100 + bearer->valOfBonuses(BonusType::MORE_DAMAGE_FROM_SPELL, BonusSubtypeID(id));
ret /= 100;
}
//invincible
if(affectedCreature->isInvincible())
ret = 0;
}
ret = caster->getSpellBonus(this, ret, affectedCreature);
return ret;
}
int64_t CSpell::calculateRawEffectValue(int32_t effectLevel, int32_t basePowerMultiplier, int32_t levelPowerMultiplier) const
{
return static_cast<int64_t>(basePowerMultiplier) * getBasePower() + levelPowerMultiplier * getLevelPower(effectLevel);
}
void CSpell::setIsOffensive(const bool val)
{
offensive = val;
if(val)
{
positiveness = CSpell::NEGATIVE;
damage = true;
}
}
void CSpell::setIsRising(const bool val)
{
rising = val;
if(val)
{
positiveness = CSpell::POSITIVE;
}
}
JsonNode CSpell::convertTargetCondition(const BTVector & immunity, const BTVector & absImmunity, const BTVector & limit, const BTVector & absLimit) const
{
static const std::string CONDITION_NORMAL = "normal";
static const std::string CONDITION_ABSOLUTE = "absolute";
#define BONUS_NAME(x) { BonusType::x, #x },
static const std::map<BonusType, std::string> bonusNameRMap = { BONUS_LIST };
#undef BONUS_NAME
JsonNode res;
auto convertVector = [&](const std::string & targetName, const BTVector & source, const std::string & value)
{
for(auto bonusType : source)
{
auto iter = bonusNameRMap.find(bonusType);
if(iter != bonusNameRMap.end())
{
auto fullId = ModUtility::makeFullIdentifier("", "bonus", iter->second);
res[targetName][fullId].String() = value;
}
else
{
logGlobal->error("Invalid bonus type %d", static_cast<int32_t>(bonusType));
}
}
};
auto convertSection = [&](const std::string & targetName, const BTVector & normal, const BTVector & absolute)
{
convertVector(targetName, normal, CONDITION_NORMAL);
convertVector(targetName, absolute, CONDITION_ABSOLUTE);
};
convertSection("allOf", limit, absLimit);
convertSection("noneOf", immunity, absImmunity);
return res;
}
void CSpell::setupMechanics()
{
mechanics = spells::ISpellMechanicsFactory::get(this);
adventureMechanics = IAdventureSpellMechanics::createMechanics(this);
}
const IAdventureSpellMechanics & CSpell::getAdventureMechanics() const
{
return *adventureMechanics;
}
std::unique_ptr<spells::Mechanics> CSpell::battleMechanics(const spells::IBattleCast * event) const
{
return mechanics->create(event);
}
void CSpell::registerIcons(const IconRegistar & cb) const
{
cb(getIndex(), 0, "SPELLS", iconBook);
cb(getIndex()+1, 0, "SPELLINT", iconEffect);
cb(getIndex(), 0, "SPELLBON", iconScenarioBonus);
cb(getIndex(), 0, "SPELLSCR", iconScroll);
}
void CSpell::updateFrom(const JsonNode & data)
{
//todo:CSpell::updateFrom
}
void CSpell::serializeJson(JsonSerializeFormat & handler)
{
}
///CSpell::AnimationInfo
CSpell::AnimationItem::AnimationItem() :
verticalPosition(VerticalPosition::TOP),
transparency(1),
pause(0)
{
}
///CSpell::AnimationInfo
AnimationPath CSpell::AnimationInfo::selectProjectile(const double angle) const
{
AnimationPath res;
double maximum = 0.0;
for(const auto & info : projectile)
{
if(info.minimumAngle < angle && info.minimumAngle >= maximum)
{
maximum = info.minimumAngle;
res = info.resourceName;
}
}
return res;
}
///CSpell::TargetInfo
CSpell::TargetInfo::TargetInfo(const CSpell * spell, const int level, spells::Mode mode)
: type(spell->getTargetType()),
smart(false),
massive(false),
clearAffected(false),
clearTarget(false)
{
const auto & levelInfo = spell->getLevelInfo(level);
smart = levelInfo.smartTarget;
massive = levelInfo.range.empty();
clearAffected = levelInfo.clearAffected;
clearTarget = levelInfo.clearTarget;
}
bool DLL_LINKAGE isInScreenRange(const int3 & center, const int3 & pos)
{
int3 diff = pos - center;
return diff.x >= -9 && diff.x <= 9 && diff.y >= -8 && diff.y <= 8;
}
///CSpellHandler
std::vector<JsonNode> CSpellHandler::loadLegacyData()
{
using namespace SpellConfig;
std::vector<JsonNode> legacyData;
CLegacyConfigParser parser(TextPath::builtin("DATA/SPTRAITS.TXT"));
auto readSchool = [&](JsonMap & schools, const std::string & name)
{
if (parser.readString() == "x")
{
schools[name].Bool() = true;
}
};
auto read = [&](bool combat, bool ability)
{
do
{
JsonNode lineNode;
const auto id = legacyData.size();
lineNode["index"].Integer() = id;
lineNode["type"].String() = ability ? "ability" : (combat ? "combat" : "adventure");
lineNode["name"].String() = parser.readString();
parser.readString(); //ignored unused abbreviated name
lineNode["level"].Integer() = static_cast<si64>(parser.readNumber());
auto& schools = lineNode["school"].Struct();
readSchool(schools, "earth");
readSchool(schools, "water");
readSchool(schools, "fire");
readSchool(schools, "air");
auto& levels = lineNode["levels"].Struct();
auto getLevel = [&](const size_t idx)->JsonMap&
{
assert(idx < GameConstants::SPELL_SCHOOL_LEVELS);
return levels[LEVEL_NAMES[idx]].Struct();
};
auto costs = parser.readNumArray<si32>(GameConstants::SPELL_SCHOOL_LEVELS);
lineNode["power"].Integer() = static_cast<si64>(parser.readNumber());
auto powers = parser.readNumArray<si32>(GameConstants::SPELL_SCHOOL_LEVELS);
auto & chances = lineNode["gainChance"].Struct();
for(const auto & name : NFaction::names)
chances[name].Integer() = static_cast<si64>(parser.readNumber());
auto AIVals = parser.readNumArray<si32>(GameConstants::SPELL_SCHOOL_LEVELS);
std::vector<std::string> descriptions;
for(size_t i = 0; i < GameConstants::SPELL_SCHOOL_LEVELS; i++)
descriptions.push_back(parser.readString());
parser.readString(); //ignore attributes. All data present in JSON
//save parsed level specific data
for(size_t i = 0; i < GameConstants::SPELL_SCHOOL_LEVELS; i++)
{
auto& level = getLevel(i);
level["description"].String() = descriptions[i];
level["cost"].Integer() = costs[i];
level["power"].Integer() = powers[i];
level["aiValue"].Integer() = AIVals[i];
}
legacyData.push_back(lineNode);
}
while (parser.endLine() && !parser.isNextEntryEmpty());
};
auto skip = [&](int cnt)
{
for(int i=0; i<cnt; i++)
parser.endLine();
};
skip(5);// header
read(false,false); //read adventure map spells
skip(3);
read(true,false); //read battle spells
skip(3);
read(true,true);//read creature abilities
//TODO: maybe move to config
//clone Acid Breath attributes for Acid Breath damage effect
JsonNode temp = legacyData[SpellID::ACID_BREATH_DEFENSE];
temp["index"].Integer() = SpellID::ACID_BREATH_DAMAGE;
legacyData.push_back(temp);
objects.resize(legacyData.size());
return legacyData;
}
const std::vector<std::string> & CSpellHandler::getTypeNames() const
{
static const std::vector<std::string> typeNames = { "spell" };
return typeNames;
}
std::vector<int> CSpellHandler::spellRangeInHexes(std::string input) const
{
BattleHexArray ret;
std::string rng = input + ','; //copy + artificial comma for easier handling
if(rng.size() >= 2 && std::tolower(rng[0]) != 'x') //there is at least one hex in range (+artificial comma)
{
std::string number1;
std::string number2;
int beg = 0;
int end = 0;
bool readingFirst = true;
for(auto & elem : rng)
{
if(std::isdigit(elem) ) //reading number
{
if(readingFirst)
number1 += elem;
else
number2 += elem;
}
else if(elem == ',') //comma
{
//calculating variables
if(readingFirst)
{
beg = std::stoi(number1);
number1 = "";
}
else
{
end = std::stoi(number2);
number2 = "";
}
//obtaining new hexes
std::set<ui16> curLayer;
if(readingFirst)
{
ret.insert(beg);
}
else
{
for(int i = beg; i <= end; ++i)
ret.insert(i);
}
}
else if(elem == '-') //dash
{
beg = std::stoi(number1);
number1 = "";
readingFirst = false;
}
}
}
std::vector<int> result;
result.reserve(ret.size());
std::transform(ret.begin(), ret.end(), std::back_inserter(result),
[](const BattleHex & hex) { return hex.toInt(); }
);
return result;
}
std::shared_ptr<CSpell> CSpellHandler::loadFromJson(const std::string & scope, const JsonNode & json, const std::string & identifier, size_t index)
{
assert(identifier.find(':') == std::string::npos);
assert(!scope.empty());
using namespace SpellConfig;
SpellID id(static_cast<si32>(index));
auto spell = std::make_shared<CSpell>();
spell->id = id;
spell->identifier = identifier;
spell->modScope = scope;
const auto type = json["type"].String();
if(type == "ability")
{
spell->creatureAbility = true;
spell->combat = true;
}
else
{
spell->creatureAbility = false;
spell->combat = type == "combat";
}
VLC->generaltexth->registerString(scope, spell->getNameTextID(), json["name"]);
logMod->trace("%s: loading spell %s", __FUNCTION__, spell->getNameTranslated());
const auto schoolNames = json["school"];
for(const spells::SchoolInfo & info : SpellConfig::SCHOOL)
{
spell->school[info.id] = schoolNames[info.jsonName].Bool();
}
spell->castOnSelf = json["canCastOnSelf"].Bool();
spell->castOnlyOnSelf = json["canCastOnlyOnSelf"].Bool();
spell->castWithoutSkip = json["canCastWithoutSkip"].Bool();
spell->level = static_cast<si32>(json["level"].Integer());
spell->power = static_cast<si32>(json["power"].Integer());
spell->defaultProbability = static_cast<si32>(json["defaultGainChance"].Integer());
for(const auto & node : json["gainChance"].Struct())
{
const int chance = static_cast<int>(node.second.Integer());
VLC->identifiers()->requestIdentifier(node.second.getModScope(), "faction", node.first, [=](si32 factionID)
{
spell->probabilities[FactionID(factionID)] = chance;
});
}
auto targetType = json["targetType"].String();
if(targetType == "NO_TARGET")
spell->targetType = spells::AimType::NO_TARGET;
else if(targetType == "CREATURE")
spell->targetType = spells::AimType::CREATURE;
else if(targetType == "OBSTACLE")
spell->targetType = spells::AimType::OBSTACLE;
else if(targetType == "LOCATION")
spell->targetType = spells::AimType::LOCATION;
else
logMod->warn("Spell %s: target type %s - assumed NO_TARGET.", spell->getNameTranslated(), (targetType.empty() ? "empty" : "unknown ("+targetType+")"));
for(const auto & counteredSpell: json["counters"].Struct())
{
if(counteredSpell.second.Bool())
{
VLC->identifiers()->requestIdentifier(counteredSpell.second.getModScope(), "spell", counteredSpell.first, [=](si32 id)
{
spell->counteredSpells.emplace_back(id);
});
}
}
//TODO: more error checking - f.e. conflicting flags
const auto flags = json["flags"];
//by default all flags are set to false in constructor
spell->damage = flags["damage"].Bool(); //do this before "offensive"
spell->nonMagical = flags["nonMagical"].Bool();
if(flags["offensive"].Bool())
{
spell->setIsOffensive(true);
}
if(flags["rising"].Bool())
{
spell->setIsRising(true);
}
const bool implicitPositiveness = spell->offensive || spell->rising; //(!) "damage" does not mean NEGATIVE --AVS
if(flags["indifferent"].Bool())
{
spell->positiveness = CSpell::NEUTRAL;
}
else if(flags["negative"].Bool())
{
spell->positiveness = CSpell::NEGATIVE;
}
else if(flags["positive"].Bool())
{
spell->positiveness = CSpell::POSITIVE;
}
else if(!implicitPositiveness)
{
spell->positiveness = CSpell::NEUTRAL; //duplicates constructor but, just in case
logMod->error("Spell %s: no positiveness specified, assumed NEUTRAL.", spell->getNameTranslated());
}
spell->special = flags["special"].Bool();
spell->onlyOnWaterMap = json["onlyOnWaterMap"].Bool();
auto findBonus = [&](const std::string & name, std::vector<BonusType> & vec)
{
auto it = bonusNameMap.find(name);
if(it == bonusNameMap.end())
{
logMod->error("Spell %s: invalid bonus name %s", spell->getNameTranslated(), name);
}
else
{
vec.push_back(static_cast<BonusType>(it->second));
}
};
auto readBonusStruct = [&](const std::string & name, std::vector<BonusType> & vec)
{
for(auto bonusData: json[name].Struct())
{
const std::string bonusId = bonusData.first;
const bool flag = bonusData.second.Bool();
if(flag)
findBonus(bonusId, vec);
}
};
if(json["targetCondition"].isNull())
{
CSpell::BTVector immunities;
CSpell::BTVector absoluteImmunities;
CSpell::BTVector limiters;
CSpell::BTVector absoluteLimiters;
readBonusStruct("immunity", immunities);
readBonusStruct("absoluteImmunity", absoluteImmunities);
readBonusStruct("limit", limiters);
readBonusStruct("absoluteLimit", absoluteLimiters);
if(!(immunities.empty() && absoluteImmunities.empty() && limiters.empty() && absoluteLimiters.empty()))
{
logMod->warn("Spell %s has old target condition format. Expected configuration: ", spell->getNameTranslated());
spell->targetCondition = spell->convertTargetCondition(immunities, absoluteImmunities, limiters, absoluteLimiters);
logMod->warn("\n\"targetCondition\" : %s", spell->targetCondition.toString());
}
}
else
{
spell->targetCondition = json["targetCondition"];
//TODO: could this be safely merged instead of discarding?
if(!json["immunity"].isNull())
logMod->warn("Spell %s 'immunity' field mixed with 'targetCondition' discarded", spell->getNameTranslated());
if(!json["absoluteImmunity"].isNull())
logMod->warn("Spell %s 'absoluteImmunity' field mixed with 'targetCondition' discarded", spell->getNameTranslated());
if(!json["limit"].isNull())
logMod->warn("Spell %s 'limit' field mixed with 'targetCondition' discarded", spell->getNameTranslated());
if(!json["absoluteLimit"].isNull())
logMod->warn("Spell %s 'absoluteLimit' field mixed with 'targetCondition' discarded", spell->getNameTranslated());
}
const JsonNode & graphicsNode = json["graphics"];
spell->iconImmune = graphicsNode["iconImmune"].String();
spell->iconBook = graphicsNode["iconBook"].String();
spell->iconEffect = graphicsNode["iconEffect"].String();
spell->iconScenarioBonus = graphicsNode["iconScenarioBonus"].String();
spell->iconScroll = graphicsNode["iconScroll"].String();
const JsonNode & animationNode = json["animation"];
auto loadAnimationQueue = [&](const std::string & jsonName, CSpell::TAnimationQueue & q)
{
auto queueNode = animationNode[jsonName].Vector();
for(const JsonNode & item : queueNode)
{
CSpell::TAnimation newItem;
if(item.getType() == JsonNode::JsonType::DATA_STRING)
newItem.resourceName = AnimationPath::fromJson(item);
else if(item.getType() == JsonNode::JsonType::DATA_STRUCT)
{
newItem.resourceName = AnimationPath::fromJson(item["defName"]);
newItem.effectName = item["effectName"].String();
auto vPosStr = item["verticalPosition"].String();
if("bottom" == vPosStr)
newItem.verticalPosition = VerticalPosition::BOTTOM;
if (item["transparency"].isNumber())
newItem.transparency = item["transparency"].Float();
else
newItem.transparency = 1.0;
}
else if(item.isNumber())
{
newItem.pause = item.Integer();
}
q.push_back(newItem);
}
};
loadAnimationQueue("affect", spell->animationInfo.affect);
loadAnimationQueue("cast", spell->animationInfo.cast);
loadAnimationQueue("hit", spell->animationInfo.hit);
const JsonVector & projectile = animationNode["projectile"].Vector();
for(const JsonNode & item : projectile)
{
CSpell::ProjectileInfo info;
info.resourceName = AnimationPath::fromJson(item["defName"]);
info.minimumAngle = item["minimumAngle"].Float();
spell->animationInfo.projectile.push_back(info);
}
const JsonNode & soundsNode = json["sounds"];
spell->castSound = AudioPath::fromJson(soundsNode["cast"]);
//load level attributes
const int levelsCount = GameConstants::SPELL_SCHOOL_LEVELS;
for(int levelIndex = 0; levelIndex < levelsCount; levelIndex++)
{
const JsonNode & levelNode = json["levels"][LEVEL_NAMES[levelIndex]];
CSpell::LevelInfo & levelObject = spell->levels[levelIndex];
const si32 levelPower = levelObject.power = static_cast<si32>(levelNode["power"].Integer());
if (!spell->isCreatureAbility())
VLC->generaltexth->registerString(scope, spell->getDescriptionTextID(levelIndex), levelNode["description"]);
levelObject.cost = static_cast<si32>(levelNode["cost"].Integer());
levelObject.AIValue = static_cast<si32>(levelNode["aiValue"].Integer());
levelObject.smartTarget = levelNode["targetModifier"]["smart"].Bool();
levelObject.clearTarget = levelNode["targetModifier"]["clearTarget"].Bool();
levelObject.clearAffected = levelNode["targetModifier"]["clearAffected"].Bool();
levelObject.range = spellRangeInHexes(levelNode["range"].String());
for(const auto & elem : levelNode["effects"].Struct())
{
const JsonNode & bonusNode = elem.second;
auto b = JsonUtils::parseBonus(bonusNode);
const bool usePowerAsValue = bonusNode["val"].isNull();
b->sid = BonusSourceID(spell->id); //for all
b->source = BonusSource::SPELL_EFFECT;//for all
if(usePowerAsValue)
b->val = levelPower;
levelObject.effects.push_back(b);
}
for(const auto & elem : levelNode["cumulativeEffects"].Struct())
{
const JsonNode & bonusNode = elem.second;
auto b = JsonUtils::parseBonus(bonusNode);
const bool usePowerAsValue = bonusNode["val"].isNull();
b->sid = BonusSourceID(spell->id); //for all
b->source = BonusSource::SPELL_EFFECT;//for all
if(usePowerAsValue)
b->val = levelPower;
levelObject.cumulativeEffects.push_back(b);
}
if(levelNode["battleEffects"].getType() == JsonNode::JsonType::DATA_STRUCT && !levelNode["battleEffects"].Struct().empty())
{
levelObject.battleEffects = levelNode["battleEffects"];
if(!levelObject.cumulativeEffects.empty() || !levelObject.effects.empty() || spell->isOffensive())
logGlobal->error("Mixing %s special effects with old format effects gives unpredictable result", spell->getNameTranslated());
}
}
return spell;
}
void CSpellHandler::afterLoadFinalization()
{
for(auto & spell : objects)
{
spell->setupMechanics();
}
}
void CSpellHandler::beforeValidate(JsonNode & object)
{
//handle "base" level info
JsonNode & levels = object["levels"];
JsonNode & base = levels["base"];
auto inheritNode = [&](const std::string & name)
{
JsonUtils::inherit(levels[name],base);
};
inheritNode("none");
inheritNode("basic");
inheritNode("advanced");
inheritNode("expert");
}
std::set<SpellID> CSpellHandler::getDefaultAllowed() const
{
std::set<SpellID> allowedSpells;
for(auto const & s : objects)
if (!s->isSpecial() && !s->isCreatureAbility())
allowedSpells.insert(s->getId());
return allowedSpells;
}
VCMI_LIB_NAMESPACE_END
|