HeroBonus.h 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227
  1. /*
  2. * HeroBonus.h, 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. #pragma once
  11. #include "GameConstants.h"
  12. #include "JsonNode.h"
  13. class CCreature;
  14. struct Bonus;
  15. class IBonusBearer;
  16. class CBonusSystemNode;
  17. class ILimiter;
  18. class IPropagator;
  19. class IUpdater;
  20. class BonusList;
  21. typedef std::shared_ptr<BonusList> TBonusListPtr;
  22. typedef std::shared_ptr<const BonusList> TConstBonusListPtr;
  23. typedef std::shared_ptr<ILimiter> TLimiterPtr;
  24. typedef std::shared_ptr<IPropagator> TPropagatorPtr;
  25. typedef std::shared_ptr<IUpdater> TUpdaterPtr;
  26. typedef std::set<CBonusSystemNode*> TNodes;
  27. typedef std::set<const CBonusSystemNode*> TCNodes;
  28. typedef std::vector<CBonusSystemNode *> TNodesVector;
  29. class CSelector : std::function<bool(const Bonus*)>
  30. {
  31. typedef std::function<bool(const Bonus*)> TBase;
  32. public:
  33. CSelector() {}
  34. template<typename T>
  35. CSelector(const T &t, //SFINAE trick -> include this c-tor in overload resolution only if parameter is class
  36. //(includes functors, lambdas) or function. Without that VC is going mad about ambiguities.
  37. typename std::enable_if < boost::mpl::or_ < std::is_class<T>, std::is_function<T >> ::value>::type *dummy = nullptr)
  38. : TBase(t)
  39. {}
  40. CSelector(std::nullptr_t)
  41. {}
  42. CSelector And(CSelector rhs) const
  43. {
  44. //lambda may likely outlive "this" (it can be even a temporary) => we copy the OBJECT (not pointer)
  45. auto thisCopy = *this;
  46. return [thisCopy, rhs](const Bonus *b) mutable { return thisCopy(b) && rhs(b); };
  47. }
  48. CSelector Or(CSelector rhs) const
  49. {
  50. auto thisCopy = *this;
  51. return [thisCopy, rhs](const Bonus *b) mutable { return thisCopy(b) || rhs(b); };
  52. }
  53. bool operator()(const Bonus *b) const
  54. {
  55. return TBase::operator()(b);
  56. }
  57. operator bool() const
  58. {
  59. return !!static_cast<const TBase&>(*this);
  60. }
  61. };
  62. class DLL_LINKAGE CBonusProxy
  63. {
  64. public:
  65. CBonusProxy(const IBonusBearer * Target, CSelector Selector);
  66. CBonusProxy(const CBonusProxy & other);
  67. CBonusProxy(CBonusProxy && other);
  68. CBonusProxy & operator=(CBonusProxy && other);
  69. CBonusProxy & operator=(const CBonusProxy & other);
  70. TConstBonusListPtr get() const;
  71. const BonusList * operator->() const;
  72. private:
  73. mutable int64_t cachedLast;
  74. const IBonusBearer * target;
  75. CSelector selector;
  76. mutable TConstBonusListPtr data;
  77. };
  78. class DLL_LINKAGE CTotalsProxy
  79. {
  80. public:
  81. CTotalsProxy(const IBonusBearer * Target, CSelector Selector, int InitialValue);
  82. CTotalsProxy(const CTotalsProxy & other);
  83. CTotalsProxy(CTotalsProxy && other) = delete;
  84. CTotalsProxy & operator=(const CTotalsProxy & other);
  85. CTotalsProxy & operator=(CTotalsProxy && other) = delete;
  86. int getMeleeValue() const;
  87. int getRangedValue() const;
  88. int getValue() const;
  89. private:
  90. const IBonusBearer * target;
  91. CSelector selector;
  92. int initialValue;
  93. mutable int64_t cachedLast;
  94. mutable int value;
  95. mutable int64_t meleeCachedLast;
  96. mutable int meleeValue;
  97. mutable int64_t rangedCachedLast;
  98. mutable int rangedValue;
  99. };
  100. class DLL_LINKAGE CCheckProxy
  101. {
  102. public:
  103. CCheckProxy(const IBonusBearer * Target, CSelector Selector);
  104. CCheckProxy(const CCheckProxy & other);
  105. bool getHasBonus() const;
  106. private:
  107. const IBonusBearer * target;
  108. CSelector selector;
  109. mutable int64_t cachedLast;
  110. mutable bool hasBonus;
  111. };
  112. class DLL_LINKAGE CAddInfo : public std::vector<si32>
  113. {
  114. public:
  115. enum { NONE = -1 };
  116. CAddInfo();
  117. CAddInfo(si32 value);
  118. bool operator==(si32 value) const;
  119. bool operator!=(si32 value) const;
  120. si32 & operator[](size_type pos);
  121. si32 operator[](size_type pos) const;
  122. std::string toString() const;
  123. JsonNode toJsonNode() const;
  124. };
  125. #define BONUS_TREE_DESERIALIZATION_FIX if(!h.saving && h.smartPointerSerialization) deserializationFix();
  126. #define BONUS_LIST \
  127. BONUS_NAME(NONE) \
  128. BONUS_NAME(LEVEL_COUNTER) /* for commander artifacts*/ \
  129. BONUS_NAME(MOVEMENT) /*both water/land*/ \
  130. BONUS_NAME(LAND_MOVEMENT) \
  131. BONUS_NAME(SEA_MOVEMENT) \
  132. BONUS_NAME(MORALE) \
  133. BONUS_NAME(LUCK) \
  134. BONUS_NAME(PRIMARY_SKILL) /*uses subtype to pick skill; additional info if set: 1 - only melee, 2 - only distance*/ \
  135. BONUS_NAME(SIGHT_RADIOUS) /*the correct word is RADIUS, but this one's already used in mods */\
  136. BONUS_NAME(MANA_REGENERATION) /*points per turn apart from normal (1 + mysticism)*/ \
  137. BONUS_NAME(FULL_MANA_REGENERATION) /*all mana points are replenished every day*/ \
  138. BONUS_NAME(NONEVIL_ALIGNMENT_MIX) /*good and neutral creatures can be mixed without morale penalty*/ \
  139. BONUS_NAME(SECONDARY_SKILL_PREMY) /*%*/ \
  140. BONUS_NAME(SURRENDER_DISCOUNT) /*%*/ \
  141. BONUS_NAME(STACKS_SPEED) /*additional info - percent of speed bonus applied after direct bonuses; >0 - added, <0 - subtracted to this part*/ \
  142. BONUS_NAME(FLYING_MOVEMENT) /*value - penalty percentage*/ \
  143. BONUS_NAME(SPELL_DURATION) \
  144. BONUS_NAME(AIR_SPELL_DMG_PREMY) \
  145. BONUS_NAME(EARTH_SPELL_DMG_PREMY) \
  146. BONUS_NAME(FIRE_SPELL_DMG_PREMY) \
  147. BONUS_NAME(WATER_SPELL_DMG_PREMY) \
  148. BONUS_NAME(WATER_WALKING) /*value - penalty percentage*/ \
  149. BONUS_NAME(NEGATE_ALL_NATURAL_IMMUNITIES) \
  150. BONUS_NAME(STACK_HEALTH) \
  151. BONUS_NAME(BLOCK_MORALE) \
  152. BONUS_NAME(BLOCK_LUCK) \
  153. BONUS_NAME(FIRE_SPELLS) \
  154. BONUS_NAME(AIR_SPELLS) \
  155. BONUS_NAME(WATER_SPELLS) \
  156. BONUS_NAME(EARTH_SPELLS) \
  157. BONUS_NAME(GENERATE_RESOURCE) /*daily value, uses subtype (resource type)*/ \
  158. BONUS_NAME(CREATURE_GROWTH) /*for legion artifacts: value - week growth bonus, subtype - monster level if aplicable*/ \
  159. BONUS_NAME(WHIRLPOOL_PROTECTION) /*hero won't lose army when teleporting through whirlpool*/ \
  160. BONUS_NAME(SPELL) /*hero knows spell, val - skill level (0 - 3), subtype - spell id*/ \
  161. BONUS_NAME(SPELLS_OF_LEVEL) /*hero knows all spells of given level, val - skill level; subtype - level*/ \
  162. BONUS_NAME(BATTLE_NO_FLEEING) /*for shackles of war*/ \
  163. BONUS_NAME(MAGIC_SCHOOL_SKILL) /* //eg. for magic plains terrain, subtype: school of magic (0 - all, 1 - fire, 2 - air, 4 - water, 8 - earth), value - level*/ \
  164. BONUS_NAME(FREE_SHOOTING) /*stacks can shoot even if otherwise blocked (sharpshooter's bow effect)*/ \
  165. BONUS_NAME(OPENING_BATTLE_SPELL) /*casts a spell at expert level at beginning of battle, val - spell power, subtype - spell id*/ \
  166. BONUS_NAME(IMPROVED_NECROMANCY) /* raise more powerful creatures: subtype - creature type raised, addInfo - [required necromancy level, required stack level] */ \
  167. BONUS_NAME(CREATURE_GROWTH_PERCENT) /*increases growth of all units in all towns, val - percentage*/ \
  168. BONUS_NAME(FREE_SHIP_BOARDING) /*movement points preserved with ship boarding and landing*/ \
  169. BONUS_NAME(NO_TYPE) \
  170. BONUS_NAME(FLYING) \
  171. BONUS_NAME(SHOOTER) \
  172. BONUS_NAME(CHARGE_IMMUNITY) \
  173. BONUS_NAME(ADDITIONAL_ATTACK) \
  174. BONUS_NAME(UNLIMITED_RETALIATIONS) \
  175. BONUS_NAME(NO_MELEE_PENALTY) \
  176. BONUS_NAME(JOUSTING) /*for champions*/ \
  177. BONUS_NAME(HATE) /*eg. angels hate devils, subtype - ID of hated creature, val - damage bonus percent */ \
  178. BONUS_NAME(KING1) \
  179. BONUS_NAME(KING2) \
  180. BONUS_NAME(KING3) \
  181. BONUS_NAME(MAGIC_RESISTANCE) /*in % (value)*/ \
  182. BONUS_NAME(CHANGES_SPELL_COST_FOR_ALLY) /*in mana points (value) , eg. mage*/ \
  183. BONUS_NAME(CHANGES_SPELL_COST_FOR_ENEMY) /*in mana points (value) , eg. pegasus */ \
  184. BONUS_NAME(SPELL_AFTER_ATTACK) /* subtype - spell id, value - chance %, addInfo[0] - level, addInfo[1] -> [0 - all attacks, 1 - shot only, 2 - melee only] */ \
  185. BONUS_NAME(SPELL_BEFORE_ATTACK) /* subtype - spell id, value - chance %, addInfo[0] - level, addInfo[1] -> [0 - all attacks, 1 - shot only, 2 - melee only] */ \
  186. BONUS_NAME(SPELL_RESISTANCE_AURA) /*eg. unicorns, value - resistance bonus in % for adjacent creatures*/ \
  187. BONUS_NAME(LEVEL_SPELL_IMMUNITY) /*creature is immune to all spell with level below or equal to value of this bonus */ \
  188. BONUS_NAME(BLOCK_MAGIC_ABOVE) /*blocks casting spells of the level > value */ \
  189. BONUS_NAME(BLOCK_ALL_MAGIC) /*blocks casting spells*/ \
  190. BONUS_NAME(TWO_HEX_ATTACK_BREATH) /*eg. dragons*/ \
  191. BONUS_NAME(SPELL_DAMAGE_REDUCTION) /*eg. golems; value - reduction in %, subtype - spell school; -1 - all, 0 - air, 1 - fire, 2 - water, 3 - earth*/ \
  192. BONUS_NAME(NO_WALL_PENALTY) \
  193. BONUS_NAME(NON_LIVING) /*eg. golems, cannot be rised or healed, only neutral morale */ \
  194. BONUS_NAME(RANDOM_SPELLCASTER) /*eg. master genie, val - level*/ \
  195. BONUS_NAME(BLOCKS_RETALIATION) /*eg. naga*/ \
  196. BONUS_NAME(SPELL_IMMUNITY) /*subid - spell id*/ \
  197. BONUS_NAME(MANA_CHANNELING) /*value in %, eg. familiar*/ \
  198. BONUS_NAME(SPELL_LIKE_ATTACK) /*subtype - spell, value - spell level; range is taken from spell, but damage from creature; eg. magog*/ \
  199. BONUS_NAME(THREE_HEADED_ATTACK) /*eg. cerberus*/ \
  200. BONUS_NAME(DAEMON_SUMMONING) /*pit lord, subtype - type of creatures, val - hp per unit*/ \
  201. BONUS_NAME(FIRE_IMMUNITY) /*subtype 0 - all, 1 - all except positive, 2 - only damage spells*/ \
  202. BONUS_NAME(WATER_IMMUNITY) \
  203. BONUS_NAME(EARTH_IMMUNITY) \
  204. BONUS_NAME(AIR_IMMUNITY) \
  205. BONUS_NAME(MIND_IMMUNITY) \
  206. BONUS_NAME(FIRE_SHIELD) \
  207. BONUS_NAME(UNDEAD) \
  208. BONUS_NAME(HP_REGENERATION) /*creature regenerates val HP every new round*/ \
  209. BONUS_NAME(FULL_HP_REGENERATION) /*first creature regenerates all HP every new round; subtype 0 - animation 4 (trolllike), 1 - animation 47 (wightlike)*/ \
  210. BONUS_NAME(MANA_DRAIN) /*value - spell points per turn*/ \
  211. BONUS_NAME(LIFE_DRAIN) \
  212. BONUS_NAME(DOUBLE_DAMAGE_CHANCE) /*value in %, eg. dread knight*/ \
  213. BONUS_NAME(RETURN_AFTER_STRIKE) \
  214. BONUS_NAME(SELF_MORALE) /*eg. minotaur*/ \
  215. BONUS_NAME(SPELLCASTER) /*subtype - spell id, value - level of school, additional info - weighted chance. use SPECIFIC_SPELL_POWER, CREATURE_SPELL_POWER or CREATURE_ENCHANT_POWER for calculating the power*/ \
  216. BONUS_NAME(CATAPULT) \
  217. BONUS_NAME(ENEMY_DEFENCE_REDUCTION) /*in % (value) eg. behemots*/ \
  218. BONUS_NAME(GENERAL_DAMAGE_REDUCTION) /* shield / air shield effect */ \
  219. BONUS_NAME(GENERAL_ATTACK_REDUCTION) /*eg. while stoned or blinded - in %,// subtype not used, use ONLY_MELEE_FIGHT / DISTANCE_FIGHT*/ \
  220. BONUS_NAME(DEFENSIVE_STANCE) /* val - bonus to defense while defending */ \
  221. BONUS_NAME(ATTACKS_ALL_ADJACENT) /*eg. hydra*/ \
  222. BONUS_NAME(MORE_DAMAGE_FROM_SPELL) /*value - damage increase in %, subtype - spell id*/ \
  223. BONUS_NAME(FEAR) \
  224. BONUS_NAME(FEARLESS) \
  225. BONUS_NAME(NO_DISTANCE_PENALTY) \
  226. BONUS_NAME(SELF_LUCK) /*halfling*/ \
  227. BONUS_NAME(ENCHANTER)/* for Enchanter spells, val - skill level, subtype - spell id, additionalInfo - cooldown */ \
  228. BONUS_NAME(HEALER) \
  229. BONUS_NAME(SIEGE_WEAPON) \
  230. BONUS_NAME(HYPNOTIZED) \
  231. BONUS_NAME(NO_RETALIATION) /*temporary bonus for basilisk, unicorn and scorpicore paralyze*/\
  232. BONUS_NAME(ADDITIONAL_RETALIATION) /*value - number of additional retaliations*/ \
  233. BONUS_NAME(MAGIC_MIRROR) /* value - chance of redirecting in %*/ \
  234. BONUS_NAME(ALWAYS_MINIMUM_DAMAGE) /*unit does its minimum damage from range; subtype: -1 - any attack, 0 - melee, 1 - ranged, value: additional damage penalty (it'll subtracted from dmg), additional info - multiplicative anti-bonus for dmg in % [eg 20 means that creature will inflict 80% of normal minimal dmg]*/ \
  235. BONUS_NAME(ALWAYS_MAXIMUM_DAMAGE) /*eg. bless effect, subtype: -1 - any attack, 0 - melee, 1 - ranged, value: additional damage, additional info - multiplicative bonus for dmg in %*/ \
  236. BONUS_NAME(ATTACKS_NEAREST_CREATURE) /*while in berserk*/ \
  237. BONUS_NAME(IN_FRENZY) /*value - level*/ \
  238. BONUS_NAME(SLAYER) /*value - level*/ \
  239. BONUS_NAME(FORGETFULL) /*forgetfulness spell effect, value - level*/ \
  240. BONUS_NAME(NOT_ACTIVE) /* subtype - spell ID (paralyze, blind, stone gaze) for graphical effect*/ \
  241. BONUS_NAME(NO_LUCK) /*eg. when fighting on cursed ground*/ \
  242. BONUS_NAME(NO_MORALE) /*eg. when fighting on cursed ground*/ \
  243. BONUS_NAME(DARKNESS) /*val = radius */ \
  244. BONUS_NAME(SPECIAL_SECONDARY_SKILL) /*subtype = id, val = value per level in percent*/ \
  245. BONUS_NAME(SPECIAL_SPELL_LEV) /*subtype = id, val = value per level in percent*/\
  246. BONUS_NAME(SPELL_DAMAGE) /*val = value*/\
  247. BONUS_NAME(SPECIFIC_SPELL_DAMAGE) /*subtype = id of spell, val = value*/\
  248. BONUS_NAME(SPECIAL_BLESS_DAMAGE) /*val = spell (bless), additionalInfo = value per level in percent*/\
  249. BONUS_NAME(MAXED_SPELL) /*val = id*/\
  250. BONUS_NAME(SPECIAL_PECULIAR_ENCHANT) /*blesses and curses with id = val dependent on unit's level, subtype = 0 or 1 for Coronius*/\
  251. BONUS_NAME(SPECIAL_UPGRADE) /*subtype = base, additionalInfo = target */\
  252. BONUS_NAME(DRAGON_NATURE) \
  253. BONUS_NAME(CREATURE_DAMAGE)/*subtype 0 = both, 1 = min, 2 = max*/\
  254. BONUS_NAME(EXP_MULTIPLIER)/* val - percent of additional exp gained by stack/commander (base value 100)*/\
  255. BONUS_NAME(SHOTS)\
  256. BONUS_NAME(DEATH_STARE) /*subtype 0 - gorgon, 1 - commander*/\
  257. BONUS_NAME(POISON) /*val - max health penalty from poison possible*/\
  258. BONUS_NAME(BIND_EFFECT) /*doesn't do anything particular, works as a marker)*/\
  259. BONUS_NAME(ACID_BREATH) /*additional val damage per creature after attack, additional info - chance in percent*/\
  260. BONUS_NAME(RECEPTIVE) /*accepts friendly spells even with immunity*/\
  261. BONUS_NAME(DIRECT_DAMAGE_IMMUNITY) /*direct damage spells, that is*/\
  262. BONUS_NAME(CASTS) /*how many times creature can cast activated spell*/ \
  263. BONUS_NAME(SPECIFIC_SPELL_POWER) /* value used for Thunderbolt and Resurrection cast by units, subtype - spell id */\
  264. BONUS_NAME(CREATURE_SPELL_POWER) /* value per unit, divided by 100 (so faerie Dragons have 800)*/ \
  265. BONUS_NAME(CREATURE_ENCHANT_POWER) /* total duration of spells cast by creature */ \
  266. BONUS_NAME(ENCHANTED) /* permanently enchanted with spell subID of level = val, if val > 3 then spell is mass and has level of val-3*/ \
  267. BONUS_NAME(REBIRTH) /* val - percent of life restored, subtype = 0 - regular, 1 - at least one unit (sacred Phoenix) */\
  268. BONUS_NAME(ADDITIONAL_UNITS) /*val of units with id = subtype will be added to hero's army at the beginning of battle */\
  269. BONUS_NAME(SPOILS_OF_WAR) /*val * 10^-6 * gained exp resources of subtype will be given to hero after battle*/\
  270. BONUS_NAME(BLOCK)\
  271. BONUS_NAME(DISGUISED) /* subtype - spell level */\
  272. BONUS_NAME(VISIONS) /* subtype - spell level */\
  273. BONUS_NAME(NO_TERRAIN_PENALTY) /* subtype - terrain type */\
  274. BONUS_NAME(SOUL_STEAL) /*val - number of units gained per enemy killed, subtype = 0 - gained units survive after battle, 1 - they do not*/ \
  275. BONUS_NAME(TRANSMUTATION) /*val - chance to trigger in %, subtype = 0 - resurrection based on HP, 1 - based on unit count, additional info - target creature ID (attacker default)*/\
  276. BONUS_NAME(SUMMON_GUARDIANS) /*val - amount in % of stack count, subtype = creature ID*/\
  277. BONUS_NAME(CATAPULT_EXTRA_SHOTS) /*val - number of additional shots, requires CATAPULT bonus to work*/\
  278. BONUS_NAME(RANGED_RETALIATION) /*allows shooters to perform ranged retaliation*/\
  279. BONUS_NAME(BLOCKS_RANGED_RETALIATION) /*disallows ranged retaliation for shooter unit, BLOCKS_RETALIATION bonus is for melee retaliation only*/\
  280. BONUS_NAME(SECONDARY_SKILL_VAL2) /*for secondary skills that have multiple effects, like eagle eye (max level and chance)*/ \
  281. BONUS_NAME(MANUAL_CONTROL) /* manually control warmachine with id = subtype, chance = val */ \
  282. BONUS_NAME(WIDE_BREATH) /* initial desigh: dragon breath affecting multiple nearby hexes */\
  283. BONUS_NAME(FIRST_STRIKE) /* first counterattack, then attack if possible */\
  284. BONUS_NAME(SYNERGY_TARGET) /* dummy skill for alternative upgrades mod */\
  285. BONUS_NAME(SHOOTS_ALL_ADJACENT) /* H4 Cyclops-like shoot (attacks all hexes neighboring with target) without spell-like mechanics */\
  286. BONUS_NAME(BLOCK_MAGIC_BELOW) /*blocks casting spells of the level < value */ \
  287. BONUS_NAME(DESTRUCTION) /*kills extra units after hit, subtype = 0 - kill percentage of units, 1 - kill amount, val = chance in percent to trigger, additional info - amount/percentage to kill*/ \
  288. BONUS_NAME(SPECIAL_CRYSTAL_GENERATION) /*crystal dragon crystal generation*/ \
  289. BONUS_NAME(NO_SPELLCAST_BY_DEFAULT) /*spellcast will not be default attack option for this creature*/ \
  290. BONUS_NAME(GARGOYLE) /* gargoyle is special than NON_LIVING, cannot be rised or healed */ \
  291. /* end of list */
  292. #define BONUS_SOURCE_LIST \
  293. BONUS_SOURCE(ARTIFACT)\
  294. BONUS_SOURCE(ARTIFACT_INSTANCE)\
  295. BONUS_SOURCE(OBJECT)\
  296. BONUS_SOURCE(CREATURE_ABILITY)\
  297. BONUS_SOURCE(TERRAIN_NATIVE)\
  298. BONUS_SOURCE(TERRAIN_OVERLAY)\
  299. BONUS_SOURCE(SPELL_EFFECT)\
  300. BONUS_SOURCE(TOWN_STRUCTURE)\
  301. BONUS_SOURCE(HERO_BASE_SKILL)\
  302. BONUS_SOURCE(SECONDARY_SKILL)\
  303. BONUS_SOURCE(HERO_SPECIAL)\
  304. BONUS_SOURCE(ARMY)\
  305. BONUS_SOURCE(CAMPAIGN_BONUS)\
  306. BONUS_SOURCE(SPECIAL_WEEK)\
  307. BONUS_SOURCE(STACK_EXPERIENCE)\
  308. BONUS_SOURCE(COMMANDER) /*TODO: consider using simply STACK_INSTANCE */\
  309. BONUS_SOURCE(OTHER) /*used for defensive stance and default value of spell level limit*/
  310. #define BONUS_VALUE_LIST \
  311. BONUS_VALUE(ADDITIVE_VALUE)\
  312. BONUS_VALUE(BASE_NUMBER)\
  313. BONUS_VALUE(PERCENT_TO_ALL)\
  314. BONUS_VALUE(PERCENT_TO_BASE)\
  315. BONUS_VALUE(INDEPENDENT_MAX) /*used for SPELL bonus */\
  316. BONUS_VALUE(INDEPENDENT_MIN) //used for SECONDARY_SKILL_PREMY bonus
  317. /// Struct for handling bonuses of several types. Can be transferred to any hero
  318. struct DLL_LINKAGE Bonus : public std::enable_shared_from_this<Bonus>
  319. {
  320. enum { EVERY_TYPE = -1 };
  321. enum BonusType
  322. {
  323. #define BONUS_NAME(x) x,
  324. BONUS_LIST
  325. #undef BONUS_NAME
  326. };
  327. enum BonusDuration //when bonus is automatically removed
  328. {
  329. PERMANENT = 1,
  330. ONE_BATTLE = 2, //at the end of battle
  331. ONE_DAY = 4, //at the end of day
  332. ONE_WEEK = 8, //at the end of week (bonus lasts till the end of week, thats NOT 7 days
  333. N_TURNS = 16, //used during battles, after battle bonus is always removed
  334. N_DAYS = 32,
  335. UNTIL_BEING_ATTACKED = 64, /*removed after attack and counterattacks are performed*/
  336. UNTIL_ATTACK = 128, /*removed after attack and counterattacks are performed*/
  337. STACK_GETS_TURN = 256, /*removed when stack gets its turn - used for defensive stance*/
  338. COMMANDER_KILLED = 512
  339. };
  340. enum BonusSource
  341. {
  342. #define BONUS_SOURCE(x) x,
  343. BONUS_SOURCE_LIST
  344. #undef BONUS_SOURCE
  345. };
  346. enum LimitEffect
  347. {
  348. NO_LIMIT = 0,
  349. ONLY_DISTANCE_FIGHT=1, ONLY_MELEE_FIGHT, //used to mark bonuses for attack/defense primary skills from spells like Precision (distance only)
  350. ONLY_ENEMY_ARMY
  351. };
  352. enum ValueType
  353. {
  354. #define BONUS_VALUE(x) x,
  355. BONUS_VALUE_LIST
  356. #undef BONUS_VALUE
  357. };
  358. ui16 duration; //uses BonusDuration values
  359. si16 turnsRemain; //used if duration is N_TURNS, N_DAYS or ONE_WEEK
  360. BonusType type; //uses BonusType values - says to what is this bonus - 1 byte
  361. TBonusSubtype subtype; //-1 if not applicable - 4 bytes
  362. BonusSource source;//source type" uses BonusSource values - what gave that bonus
  363. si32 val;
  364. ui32 sid; //source id: id of object/artifact/spell
  365. ValueType valType;
  366. std::string stacking; // bonuses with the same stacking value don't stack (e.g. Angel/Archangel morale bonus)
  367. CAddInfo additionalInfo;
  368. LimitEffect effectRange; //if not NO_LIMIT, bonus will be omitted by default
  369. TLimiterPtr limiter;
  370. TPropagatorPtr propagator;
  371. TUpdaterPtr updater;
  372. std::string description;
  373. Bonus(ui16 Dur, BonusType Type, BonusSource Src, si32 Val, ui32 ID, std::string Desc, si32 Subtype=-1);
  374. Bonus(ui16 Dur, BonusType Type, BonusSource Src, si32 Val, ui32 ID, si32 Subtype=-1, ValueType ValType = ADDITIVE_VALUE);
  375. Bonus();
  376. template <typename Handler> void serialize(Handler &h, const int version)
  377. {
  378. h & duration;
  379. h & type;
  380. h & subtype;
  381. h & source;
  382. h & val;
  383. h & sid;
  384. h & description;
  385. if(version >= 783)
  386. {
  387. h & additionalInfo;
  388. }
  389. else
  390. {
  391. additionalInfo.resize(1, -1);
  392. h & additionalInfo[0];
  393. }
  394. h & turnsRemain;
  395. h & valType;
  396. if(version >= 784)
  397. {
  398. h & stacking;
  399. }
  400. h & effectRange;
  401. h & limiter;
  402. h & propagator;
  403. if(version >= 781)
  404. {
  405. h & updater;
  406. }
  407. }
  408. template <typename Ptr>
  409. static bool compareByAdditionalInfo(const Ptr& a, const Ptr& b)
  410. {
  411. return a->additionalInfo < b->additionalInfo;
  412. }
  413. static bool NDays(const Bonus *hb)
  414. {
  415. return hb->duration & Bonus::N_DAYS;
  416. }
  417. static bool NTurns(const Bonus *hb)
  418. {
  419. return hb->duration & Bonus::N_TURNS;
  420. }
  421. static bool OneDay(const Bonus *hb)
  422. {
  423. return hb->duration & Bonus::ONE_DAY;
  424. }
  425. static bool OneWeek(const Bonus *hb)
  426. {
  427. return hb->duration & Bonus::ONE_WEEK;
  428. }
  429. static bool OneBattle(const Bonus *hb)
  430. {
  431. return hb->duration & Bonus::ONE_BATTLE;
  432. }
  433. static bool Permanent(const Bonus *hb)
  434. {
  435. return hb->duration & Bonus::PERMANENT;
  436. }
  437. static bool UntilGetsTurn(const Bonus *hb)
  438. {
  439. return hb->duration & Bonus::STACK_GETS_TURN;
  440. }
  441. static bool UntilAttack(const Bonus *hb)
  442. {
  443. return hb->duration & Bonus::UNTIL_ATTACK;
  444. }
  445. static bool UntilBeingAttacked(const Bonus *hb)
  446. {
  447. return hb->duration & Bonus::UNTIL_BEING_ATTACKED;
  448. }
  449. static bool UntilCommanderKilled(const Bonus *hb)
  450. {
  451. return hb->duration & Bonus::COMMANDER_KILLED;
  452. }
  453. inline bool operator == (const BonusType & cf) const
  454. {
  455. return type == cf;
  456. }
  457. inline void operator += (const ui32 Val) //no return
  458. {
  459. val += Val;
  460. }
  461. std::string Description() const;
  462. JsonNode toJsonNode() const;
  463. std::string nameForBonus() const; // generate suitable name for bonus - e.g. for storing in json struct
  464. std::shared_ptr<Bonus> addLimiter(TLimiterPtr Limiter); //returns this for convenient chain-calls
  465. std::shared_ptr<Bonus> addPropagator(TPropagatorPtr Propagator); //returns this for convenient chain-calls
  466. std::shared_ptr<Bonus> addUpdater(TUpdaterPtr Updater); //returns this for convenient chain-calls
  467. };
  468. DLL_LINKAGE std::ostream & operator<<(std::ostream &out, const Bonus &bonus);
  469. class DLL_LINKAGE BonusList
  470. {
  471. public:
  472. typedef std::vector<std::shared_ptr<Bonus>> TInternalContainer;
  473. private:
  474. TInternalContainer bonuses;
  475. bool belongsToTree;
  476. void changed();
  477. public:
  478. typedef TInternalContainer::const_reference const_reference;
  479. typedef TInternalContainer::value_type value_type;
  480. typedef TInternalContainer::const_iterator const_iterator;
  481. typedef TInternalContainer::iterator iterator;
  482. BonusList(bool BelongsToTree = false);
  483. BonusList(const BonusList &bonusList);
  484. BonusList(BonusList && other);
  485. BonusList& operator=(const BonusList &bonusList);
  486. // wrapper functions of the STL vector container
  487. TInternalContainer::size_type size() const { return bonuses.size(); }
  488. void push_back(std::shared_ptr<Bonus> x);
  489. TInternalContainer::iterator erase (const int position);
  490. void clear();
  491. bool empty() const { return bonuses.empty(); }
  492. void resize(TInternalContainer::size_type sz, std::shared_ptr<Bonus> c = nullptr );
  493. std::shared_ptr<Bonus> &operator[] (TInternalContainer::size_type n) { return bonuses[n]; }
  494. const std::shared_ptr<Bonus> &operator[] (TInternalContainer::size_type n) const { return bonuses[n]; }
  495. std::shared_ptr<Bonus> &back() { return bonuses.back(); }
  496. std::shared_ptr<Bonus> &front() { return bonuses.front(); }
  497. const std::shared_ptr<Bonus> &back() const { return bonuses.back(); }
  498. const std::shared_ptr<Bonus> &front() const { return bonuses.front(); }
  499. // There should be no non-const access to provide solid,robust bonus caching
  500. TInternalContainer::const_iterator begin() const { return bonuses.begin(); }
  501. TInternalContainer::const_iterator end() const { return bonuses.end(); }
  502. TInternalContainer::size_type operator-=(std::shared_ptr<Bonus> const &i);
  503. // BonusList functions
  504. void stackBonuses();
  505. int totalValue() const;
  506. void getBonuses(BonusList &out, const CSelector &selector, const CSelector &limit) const;
  507. void getAllBonuses(BonusList &out) const;
  508. void getBonuses(BonusList & out, const CSelector &selector) const;
  509. //special find functions
  510. std::shared_ptr<Bonus> getFirst(const CSelector &select);
  511. std::shared_ptr<const Bonus> getFirst(const CSelector &select) const;
  512. int valOfBonuses(const CSelector &select) const;
  513. // conversion / output
  514. JsonNode toJsonNode() const;
  515. // remove_if implementation for STL vector types
  516. template <class Predicate>
  517. void remove_if(Predicate pred)
  518. {
  519. BonusList newList;
  520. for (ui32 i = 0; i < bonuses.size(); i++)
  521. {
  522. auto b = bonuses[i];
  523. if (!pred(b.get()))
  524. newList.push_back(b);
  525. }
  526. bonuses.clear();
  527. bonuses.resize(newList.size());
  528. std::copy(newList.begin(), newList.end(), bonuses.begin());
  529. }
  530. template <class InputIterator>
  531. void insert(const int position, InputIterator first, InputIterator last);
  532. void insert(TInternalContainer::iterator position, TInternalContainer::size_type n, std::shared_ptr<Bonus> const &x);
  533. template <typename Handler>
  534. void serialize(Handler &h, const int version)
  535. {
  536. h & static_cast<TInternalContainer&>(bonuses);
  537. }
  538. // C++ for range support
  539. auto begin () -> decltype (bonuses.begin())
  540. {
  541. return bonuses.begin();
  542. }
  543. auto end () -> decltype (bonuses.end())
  544. {
  545. return bonuses.end();
  546. }
  547. };
  548. // Extensions for BOOST_FOREACH to enable iterating of BonusList objects
  549. // Don't touch/call this functions
  550. inline BonusList::iterator range_begin(BonusList & x)
  551. {
  552. return x.begin();
  553. }
  554. inline BonusList::iterator range_end(BonusList & x)
  555. {
  556. return x.end();
  557. }
  558. inline BonusList::const_iterator range_begin(BonusList const &x)
  559. {
  560. return x.begin();
  561. }
  562. inline BonusList::const_iterator range_end(BonusList const &x)
  563. {
  564. return x.end();
  565. }
  566. DLL_LINKAGE std::ostream & operator<<(std::ostream &out, const BonusList &bonusList);
  567. class DLL_LINKAGE IPropagator
  568. {
  569. public:
  570. virtual ~IPropagator();
  571. virtual bool shouldBeAttached(CBonusSystemNode *dest);
  572. template <typename Handler> void serialize(Handler &h, const int version)
  573. {}
  574. };
  575. class DLL_LINKAGE CPropagatorNodeType : public IPropagator
  576. {
  577. int nodeType; //CBonusSystemNode::ENodeTypes
  578. public:
  579. CPropagatorNodeType();
  580. CPropagatorNodeType(int NodeType);
  581. bool shouldBeAttached(CBonusSystemNode *dest) override;
  582. template <typename Handler> void serialize(Handler &h, const int version)
  583. {
  584. h & nodeType;
  585. }
  586. };
  587. struct BonusLimitationContext
  588. {
  589. std::shared_ptr<const Bonus> b;
  590. const CBonusSystemNode & node;
  591. const BonusList & alreadyAccepted;
  592. const BonusList & stillUndecided;
  593. };
  594. class DLL_LINKAGE ILimiter
  595. {
  596. public:
  597. enum EDecision {ACCEPT, DISCARD, NOT_SURE};
  598. virtual ~ILimiter();
  599. virtual int limit(const BonusLimitationContext &context) const; //0 - accept bonus; 1 - drop bonus; 2 - delay (drops eventually)
  600. virtual std::string toString() const;
  601. virtual JsonNode toJsonNode() const;
  602. template <typename Handler> void serialize(Handler &h, const int version)
  603. {
  604. }
  605. };
  606. class DLL_LINKAGE IBonusBearer
  607. {
  608. private:
  609. static CSelector anaffectedByMoraleSelector;
  610. CCheckProxy anaffectedByMorale;
  611. static CSelector moraleSelector;
  612. CTotalsProxy moraleValue;
  613. static CSelector selfMoraleSelector;
  614. CCheckProxy selfMorale;
  615. public:
  616. //new bonusing node interface
  617. // * selector is predicate that tests if HeroBonus matches our criteria
  618. // * root is node on which call was made (nullptr will be replaced with this)
  619. //interface
  620. IBonusBearer();
  621. virtual TConstBonusListPtr getAllBonuses(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr, const std::string &cachingStr = "") const = 0;
  622. int valOfBonuses(const CSelector &selector, const std::string &cachingStr = "") const;
  623. bool hasBonus(const CSelector &selector, const std::string &cachingStr = "") const;
  624. bool hasBonus(const CSelector &selector, const CSelector &limit, const std::string &cachingStr = "") const;
  625. TConstBonusListPtr getBonuses(const CSelector &selector, const CSelector &limit, const std::string &cachingStr = "") const;
  626. TConstBonusListPtr getBonuses(const CSelector &selector, const std::string &cachingStr = "") const;
  627. std::shared_ptr<const Bonus> getBonus(const CSelector &selector) const; //returns any bonus visible on node that matches (or nullptr if none matches)
  628. //legacy interface
  629. int valOfBonuses(Bonus::BonusType type, const CSelector &selector) const;
  630. int valOfBonuses(Bonus::BonusType type, int subtype = -1) const; //subtype -> subtype of bonus, if -1 then anyt;
  631. bool hasBonusOfType(Bonus::BonusType type, int subtype = -1) const;//determines if hero has a bonus of given type (and optionally subtype)
  632. bool hasBonusFrom(Bonus::BonusSource source, ui32 sourceID) const;
  633. //various hlp functions for non-trivial values
  634. //used for stacks and creatures only
  635. virtual int getMinDamage(bool ranged) const;
  636. virtual int getMaxDamage(bool ranged) const;
  637. virtual int getAttack(bool ranged) const;
  638. virtual int getDefence(bool ranged) const;
  639. int MoraleVal() const; //range [-3, +3]
  640. int LuckVal() const; //range [-3, +3]
  641. ui32 MaxHealth() const; //get max HP of stack with all modifiers
  642. bool isLiving() const; //non-undead, non-non living or alive
  643. virtual si32 magicResistance() const;
  644. ui32 Speed(int turn = 0, bool useBind = false) const; //get speed of creature with all modificators
  645. si32 manaLimit() const; //maximum mana value for this hero (basically 10*knowledge)
  646. int getPrimSkillLevel(PrimarySkill::PrimarySkill id) const;
  647. virtual int64_t getTreeVersion() const = 0;
  648. };
  649. class DLL_LINKAGE CBonusSystemNode : public virtual IBonusBearer, public boost::noncopyable
  650. {
  651. public:
  652. enum ENodeTypes
  653. {
  654. UNKNOWN, STACK_INSTANCE, STACK_BATTLE, SPECIALTY, ARTIFACT, CREATURE, ARTIFACT_INSTANCE, HERO, PLAYER, TEAM,
  655. TOWN_AND_VISITOR, BATTLE, COMMANDER, GLOBAL_EFFECTS
  656. };
  657. private:
  658. BonusList bonuses; //wielded bonuses (local or up-propagated here)
  659. BonusList exportedBonuses; //bonuses coming from this node (wielded or propagated away)
  660. TNodesVector parents; //parents -> we inherit bonuses from them, we may attach our bonuses to them
  661. TNodesVector children;
  662. ENodeTypes nodeType;
  663. std::string description;
  664. static const bool cachingEnabled;
  665. mutable BonusList cachedBonuses;
  666. mutable int64_t cachedLast;
  667. static std::atomic<int32_t> treeChanged;
  668. // Setting a value to cachingStr before getting any bonuses caches the result for later requests.
  669. // This string needs to be unique, that's why it has to be setted in the following manner:
  670. // [property key]_[value] => only for selector
  671. mutable std::map<std::string, TBonusListPtr > cachedRequests;
  672. void getBonusesRec(BonusList &out, const CSelector &selector, const CSelector &limit) const;
  673. void getAllBonusesRec(BonusList &out) const;
  674. TConstBonusListPtr getAllBonusesWithoutCaching(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr) const;
  675. std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> & b) const;
  676. public:
  677. explicit CBonusSystemNode();
  678. explicit CBonusSystemNode(ENodeTypes NodeType);
  679. CBonusSystemNode(CBonusSystemNode && other);
  680. virtual ~CBonusSystemNode();
  681. void limitBonuses(const BonusList &allBonuses, BonusList &out) const; //out will bo populed with bonuses that are not limited here
  682. TBonusListPtr limitBonuses(const BonusList &allBonuses) const; //same as above, returns out by val for convienence
  683. TConstBonusListPtr getAllBonuses(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr, const std::string &cachingStr = "") const override;
  684. void getParents(TCNodes &out) const; //retrieves list of parent nodes (nodes to inherit bonuses from),
  685. std::shared_ptr<const Bonus> getBonusLocalFirst(const CSelector &selector) const;
  686. //non-const interface
  687. void getParents(TNodes &out); //retrieves list of parent nodes (nodes to inherit bonuses from)
  688. void getRedParents(TNodes &out); //retrieves list of red parent nodes (nodes bonuses propagate from)
  689. void getRedAncestors(TNodes &out);
  690. void getRedChildren(TNodes &out);
  691. void getRedDescendants(TNodes &out);
  692. std::shared_ptr<Bonus> getBonusLocalFirst(const CSelector &selector);
  693. void attachTo(CBonusSystemNode *parent);
  694. void detachFrom(CBonusSystemNode *parent);
  695. void detachFromAll();
  696. virtual void addNewBonus(const std::shared_ptr<Bonus>& b);
  697. void accumulateBonus(const std::shared_ptr<Bonus>& b); //add value of bonus with same type/subtype or create new
  698. void newChildAttached(CBonusSystemNode *child);
  699. void childDetached(CBonusSystemNode *child);
  700. void propagateBonus(std::shared_ptr<Bonus> b);
  701. void unpropagateBonus(std::shared_ptr<Bonus> b);
  702. void removeBonus(const std::shared_ptr<Bonus>& b);
  703. void removeBonuses(const CSelector & selector);
  704. void removeBonusesRecursive(const CSelector & s);
  705. void newRedDescendant(CBonusSystemNode *descendant); //propagation needed
  706. void removedRedDescendant(CBonusSystemNode *descendant); //de-propagation needed
  707. bool isIndependentNode() const; //node is independent when it has no parents nor children
  708. bool actsAsBonusSourceOnly() const;
  709. ///updates count of remaining turns and removes outdated bonuses by selector
  710. void reduceBonusDurations(const CSelector &s);
  711. virtual std::string bonusToString(const std::shared_ptr<Bonus>& bonus, bool description) const {return "";}; //description or bonus name
  712. virtual std::string nodeName() const;
  713. void deserializationFix();
  714. void exportBonus(std::shared_ptr<Bonus> b);
  715. void exportBonuses();
  716. const BonusList &getBonusList() const;
  717. BonusList &getExportedBonusList();
  718. CBonusSystemNode::ENodeTypes getNodeType() const;
  719. void setNodeType(CBonusSystemNode::ENodeTypes type);
  720. const TNodesVector &getParentNodes() const;
  721. const TNodesVector &getChildrenNodes() const;
  722. const std::string &getDescription() const;
  723. void setDescription(const std::string &description);
  724. static void treeHasChanged();
  725. int64_t getTreeVersion() const override;
  726. template <typename Handler> void serialize(Handler &h, const int version)
  727. {
  728. // h & bonuses;
  729. h & nodeType;
  730. h & exportedBonuses;
  731. h & description;
  732. BONUS_TREE_DESERIALIZATION_FIX
  733. //h & parents & children;
  734. }
  735. friend class CBonusProxy;
  736. };
  737. namespace NBonus
  738. {
  739. //set of methods that may be safely called with nullptr objs
  740. DLL_LINKAGE int valOf(const CBonusSystemNode *obj, Bonus::BonusType type, int subtype = -1); //subtype -> subtype of bonus, if -1 then any
  741. DLL_LINKAGE bool hasOfType(const CBonusSystemNode *obj, Bonus::BonusType type, int subtype = -1);//determines if hero has a bonus of given type (and optionally subtype)
  742. }
  743. template<typename T>
  744. class CSelectFieldEqual
  745. {
  746. T Bonus::*ptr;
  747. public:
  748. CSelectFieldEqual(T Bonus::*Ptr)
  749. : ptr(Ptr)
  750. {
  751. }
  752. CSelector operator()(const T &valueToCompareAgainst) const
  753. {
  754. auto ptr2 = ptr; //We need a COPY because we don't want to reference this (might be outlived by lambda)
  755. return [ptr2, valueToCompareAgainst](const Bonus *bonus) { return bonus->*ptr2 == valueToCompareAgainst; };
  756. }
  757. };
  758. template<typename T> //can be same, needed for subtype field
  759. class CSelectFieldEqualOrEvery
  760. {
  761. T Bonus::*ptr;
  762. T val;
  763. public:
  764. CSelectFieldEqualOrEvery(T Bonus::*Ptr, const T &Val)
  765. : ptr(Ptr), val(Val)
  766. {
  767. }
  768. bool operator()(const Bonus *bonus) const
  769. {
  770. return (bonus->*ptr == val) || (bonus->*ptr == static_cast<T>(Bonus::EVERY_TYPE));
  771. }
  772. CSelectFieldEqualOrEvery& operator()(const T &setVal)
  773. {
  774. val = setVal;
  775. return *this;
  776. }
  777. };
  778. class DLL_LINKAGE CWillLastTurns
  779. {
  780. public:
  781. int turnsRequested;
  782. bool operator()(const Bonus *bonus) const
  783. {
  784. return turnsRequested <= 0 //every present effect will last zero (or "less") turns
  785. || !Bonus::NTurns(bonus) //so do every not expriing after N-turns effect
  786. || bonus->turnsRemain > turnsRequested;
  787. }
  788. CWillLastTurns& operator()(const int &setVal)
  789. {
  790. turnsRequested = setVal;
  791. return *this;
  792. }
  793. };
  794. class DLL_LINKAGE CWillLastDays
  795. {
  796. public:
  797. int daysRequested;
  798. bool operator()(const Bonus *bonus) const
  799. {
  800. if(daysRequested <= 0 || Bonus::Permanent(bonus) || Bonus::OneBattle(bonus))
  801. return true;
  802. else if(Bonus::OneDay(bonus))
  803. return false;
  804. else if(Bonus::NDays(bonus) || Bonus::OneWeek(bonus))
  805. {
  806. return bonus->turnsRemain > daysRequested;
  807. }
  808. return false; // TODO: ONE_WEEK need support for turnsRemain, but for now we'll exclude all unhandled durations
  809. }
  810. CWillLastDays& operator()(const int &setVal)
  811. {
  812. daysRequested = setVal;
  813. return *this;
  814. }
  815. };
  816. class DLL_LINKAGE AggregateLimiter : public ILimiter
  817. {
  818. protected:
  819. std::vector<TLimiterPtr> limiters;
  820. virtual const std::string & getAggregator() const = 0;
  821. public:
  822. void add(TLimiterPtr limiter);
  823. JsonNode toJsonNode() const override;
  824. template <typename Handler> void serialize(Handler & h, const int version)
  825. {
  826. h & static_cast<ILimiter&>(*this);
  827. if(version >= 786)
  828. {
  829. h & limiters;
  830. }
  831. }
  832. };
  833. class DLL_LINKAGE AllOfLimiter : public AggregateLimiter
  834. {
  835. protected:
  836. const std::string & getAggregator() const override;
  837. public:
  838. static const std::string aggregator;
  839. int limit(const BonusLimitationContext & context) const override;
  840. };
  841. class DLL_LINKAGE AnyOfLimiter : public AggregateLimiter
  842. {
  843. protected:
  844. const std::string & getAggregator() const override;
  845. public:
  846. static const std::string aggregator;
  847. int limit(const BonusLimitationContext & context) const override;
  848. };
  849. class DLL_LINKAGE NoneOfLimiter : public AggregateLimiter
  850. {
  851. protected:
  852. const std::string & getAggregator() const override;
  853. public:
  854. static const std::string aggregator;
  855. int limit(const BonusLimitationContext & context) const override;
  856. };
  857. class DLL_LINKAGE CCreatureTypeLimiter : public ILimiter //affect only stacks of given creature (and optionally it's upgrades)
  858. {
  859. public:
  860. const CCreature *creature;
  861. bool includeUpgrades;
  862. CCreatureTypeLimiter();
  863. CCreatureTypeLimiter(const CCreature &Creature, bool IncludeUpgrades = true);
  864. void setCreature (CreatureID id);
  865. int limit(const BonusLimitationContext &context) const override;
  866. virtual std::string toString() const override;
  867. virtual JsonNode toJsonNode() const override;
  868. template <typename Handler> void serialize(Handler &h, const int version)
  869. {
  870. h & static_cast<ILimiter&>(*this);
  871. h & creature;
  872. h & includeUpgrades;
  873. }
  874. };
  875. class DLL_LINKAGE HasAnotherBonusLimiter : public ILimiter //applies only to nodes that have another bonus working
  876. {
  877. public:
  878. Bonus::BonusType type;
  879. TBonusSubtype subtype;
  880. bool isSubtypeRelevant; //check for subtype only if this is true
  881. HasAnotherBonusLimiter(Bonus::BonusType bonus = Bonus::NONE);
  882. HasAnotherBonusLimiter(Bonus::BonusType bonus, TBonusSubtype _subtype);
  883. int limit(const BonusLimitationContext &context) const override;
  884. virtual std::string toString() const override;
  885. virtual JsonNode toJsonNode() const override;
  886. template <typename Handler> void serialize(Handler &h, const int version)
  887. {
  888. h & static_cast<ILimiter&>(*this);
  889. h & type;
  890. h & subtype;
  891. h & isSubtypeRelevant;
  892. }
  893. };
  894. class DLL_LINKAGE CreatureTerrainLimiter : public ILimiter //applies only to creatures that are on specified terrain, default native terrain
  895. {
  896. public:
  897. int terrainType;
  898. CreatureTerrainLimiter();
  899. CreatureTerrainLimiter(int TerrainType);
  900. int limit(const BonusLimitationContext &context) const override;
  901. virtual std::string toString() const override;
  902. virtual JsonNode toJsonNode() const override;
  903. template <typename Handler> void serialize(Handler &h, const int version)
  904. {
  905. h & static_cast<ILimiter&>(*this);
  906. h & terrainType;
  907. }
  908. };
  909. class DLL_LINKAGE CreatureFactionLimiter : public ILimiter //applies only to creatures of given faction
  910. {
  911. public:
  912. si8 faction;
  913. CreatureFactionLimiter();
  914. CreatureFactionLimiter(int TerrainType);
  915. int limit(const BonusLimitationContext &context) const override;
  916. virtual std::string toString() const override;
  917. virtual JsonNode toJsonNode() const override;
  918. template <typename Handler> void serialize(Handler &h, const int version)
  919. {
  920. h & static_cast<ILimiter&>(*this);
  921. h & faction;
  922. }
  923. };
  924. class DLL_LINKAGE CreatureAlignmentLimiter : public ILimiter //applies only to creatures of given alignment
  925. {
  926. public:
  927. si8 alignment;
  928. CreatureAlignmentLimiter();
  929. CreatureAlignmentLimiter(si8 Alignment);
  930. int limit(const BonusLimitationContext &context) const override;
  931. virtual std::string toString() const override;
  932. virtual JsonNode toJsonNode() const override;
  933. template <typename Handler> void serialize(Handler &h, const int version)
  934. {
  935. h & static_cast<ILimiter&>(*this);
  936. h & alignment;
  937. }
  938. };
  939. class DLL_LINKAGE StackOwnerLimiter : public ILimiter //applies only to creatures of given alignment
  940. {
  941. public:
  942. PlayerColor owner;
  943. StackOwnerLimiter();
  944. StackOwnerLimiter(PlayerColor Owner);
  945. int limit(const BonusLimitationContext &context) const override;
  946. template <typename Handler> void serialize(Handler &h, const int version)
  947. {
  948. h & static_cast<ILimiter&>(*this);
  949. h & owner;
  950. }
  951. };
  952. class DLL_LINKAGE RankRangeLimiter : public ILimiter //applies to creatures with min <= Rank <= max
  953. {
  954. public:
  955. ui8 minRank, maxRank;
  956. RankRangeLimiter();
  957. RankRangeLimiter(ui8 Min, ui8 Max = 255);
  958. int limit(const BonusLimitationContext &context) const override;
  959. template <typename Handler> void serialize(Handler &h, const int version)
  960. {
  961. h & static_cast<ILimiter&>(*this);
  962. h & minRank;
  963. h & maxRank;
  964. }
  965. };
  966. namespace Selector
  967. {
  968. extern DLL_LINKAGE CSelectFieldEqual<Bonus::BonusType> type;
  969. extern DLL_LINKAGE CSelectFieldEqual<TBonusSubtype> subtype;
  970. extern DLL_LINKAGE CSelectFieldEqual<CAddInfo> info;
  971. extern DLL_LINKAGE CSelectFieldEqual<Bonus::BonusSource> sourceType;
  972. extern DLL_LINKAGE CSelectFieldEqual<Bonus::LimitEffect> effectRange;
  973. extern DLL_LINKAGE CWillLastTurns turns;
  974. extern DLL_LINKAGE CWillLastDays days;
  975. CSelector DLL_LINKAGE typeSubtype(Bonus::BonusType Type, TBonusSubtype Subtype);
  976. CSelector DLL_LINKAGE typeSubtypeInfo(Bonus::BonusType type, TBonusSubtype subtype, CAddInfo info);
  977. CSelector DLL_LINKAGE source(Bonus::BonusSource source, ui32 sourceID);
  978. CSelector DLL_LINKAGE sourceTypeSel(Bonus::BonusSource source);
  979. CSelector DLL_LINKAGE valueType(Bonus::ValueType valType);
  980. /**
  981. * Selects all bonuses
  982. * Usage example: Selector::all.And(<functor>).And(<functor>)...)
  983. */
  984. extern DLL_LINKAGE CSelector all;
  985. /**
  986. * Selects nothing
  987. * Usage example: Selector::none.Or(<functor>).Or(<functor>)...)
  988. */
  989. extern DLL_LINKAGE CSelector none;
  990. bool DLL_LINKAGE matchesType(const CSelector &sel, Bonus::BonusType type);
  991. bool DLL_LINKAGE matchesTypeSubtype(const CSelector &sel, Bonus::BonusType type, TBonusSubtype subtype);
  992. }
  993. extern DLL_LINKAGE const std::map<std::string, Bonus::BonusType> bonusNameMap;
  994. extern DLL_LINKAGE const std::map<std::string, Bonus::ValueType> bonusValueMap;
  995. extern DLL_LINKAGE const std::map<std::string, Bonus::BonusSource> bonusSourceMap;
  996. extern DLL_LINKAGE const std::map<std::string, ui16> bonusDurationMap;
  997. extern DLL_LINKAGE const std::map<std::string, Bonus::LimitEffect> bonusLimitEffect;
  998. extern DLL_LINKAGE const std::map<std::string, TLimiterPtr> bonusLimiterMap;
  999. extern DLL_LINKAGE const std::map<std::string, TPropagatorPtr> bonusPropagatorMap;
  1000. extern DLL_LINKAGE const std::map<std::string, TUpdaterPtr> bonusUpdaterMap;
  1001. // BonusList template that requires full interface of CBonusSystemNode
  1002. template <class InputIterator>
  1003. void BonusList::insert(const int position, InputIterator first, InputIterator last)
  1004. {
  1005. bonuses.insert(bonuses.begin() + position, first, last);
  1006. changed();
  1007. }
  1008. // observers for updating bonuses based on certain events (e.g. hero gaining level)
  1009. class DLL_LINKAGE IUpdater
  1010. {
  1011. public:
  1012. virtual ~IUpdater();
  1013. virtual std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const;
  1014. virtual std::string toString() const;
  1015. virtual JsonNode toJsonNode() const;
  1016. template <typename Handler> void serialize(Handler & h, const int version)
  1017. {
  1018. }
  1019. };
  1020. class DLL_LINKAGE GrowsWithLevelUpdater : public IUpdater
  1021. {
  1022. public:
  1023. int valPer20;
  1024. int stepSize;
  1025. GrowsWithLevelUpdater();
  1026. GrowsWithLevelUpdater(int valPer20, int stepSize = 1);
  1027. template <typename Handler> void serialize(Handler & h, const int version)
  1028. {
  1029. h & static_cast<IUpdater &>(*this);
  1030. h & valPer20;
  1031. h & stepSize;
  1032. }
  1033. std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
  1034. virtual std::string toString() const override;
  1035. virtual JsonNode toJsonNode() const override;
  1036. };
  1037. class DLL_LINKAGE TimesHeroLevelUpdater : public IUpdater
  1038. {
  1039. public:
  1040. TimesHeroLevelUpdater();
  1041. template <typename Handler> void serialize(Handler & h, const int version)
  1042. {
  1043. h & static_cast<IUpdater &>(*this);
  1044. }
  1045. std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
  1046. virtual std::string toString() const override;
  1047. virtual JsonNode toJsonNode() const override;
  1048. };
  1049. class DLL_LINKAGE TimesStackLevelUpdater : public IUpdater
  1050. {
  1051. public:
  1052. TimesStackLevelUpdater();
  1053. template <typename Handler> void serialize(Handler & h, const int version)
  1054. {
  1055. h & static_cast<IUpdater &>(*this);
  1056. }
  1057. std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
  1058. virtual std::string toString() const override;
  1059. virtual JsonNode toJsonNode() const override;
  1060. };