HeroBonus.h 43 KB

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