HeroBonus.h 47 KB

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