HeroBonus.h 45 KB

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