HeroBonus.h 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171
  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. BONUS_NAME(SPECIAL_CRYSTAL_GENERATION) /*crystal dragon crystal generation*/ \
  254. BONUS_NAME(NO_SPELLCAST_BY_DEFAULT) /*spellcast will not be default attack option for this creature*/ \
  255. /* end of list */
  256. #define BONUS_SOURCE_LIST \
  257. BONUS_SOURCE(ARTIFACT)\
  258. BONUS_SOURCE(ARTIFACT_INSTANCE)\
  259. BONUS_SOURCE(OBJECT)\
  260. BONUS_SOURCE(CREATURE_ABILITY)\
  261. BONUS_SOURCE(TERRAIN_NATIVE)\
  262. BONUS_SOURCE(TERRAIN_OVERLAY)\
  263. BONUS_SOURCE(SPELL_EFFECT)\
  264. BONUS_SOURCE(TOWN_STRUCTURE)\
  265. BONUS_SOURCE(HERO_BASE_SKILL)\
  266. BONUS_SOURCE(SECONDARY_SKILL)\
  267. BONUS_SOURCE(HERO_SPECIAL)\
  268. BONUS_SOURCE(ARMY)\
  269. BONUS_SOURCE(CAMPAIGN_BONUS)\
  270. BONUS_SOURCE(SPECIAL_WEEK)\
  271. BONUS_SOURCE(STACK_EXPERIENCE)\
  272. BONUS_SOURCE(COMMANDER) /*TODO: consider using simply STACK_INSTANCE */\
  273. BONUS_SOURCE(OTHER) /*used for defensive stance and default value of spell level limit*/
  274. #define BONUS_VALUE_LIST \
  275. BONUS_VALUE(ADDITIVE_VALUE)\
  276. BONUS_VALUE(BASE_NUMBER)\
  277. BONUS_VALUE(PERCENT_TO_ALL)\
  278. BONUS_VALUE(PERCENT_TO_BASE)\
  279. BONUS_VALUE(INDEPENDENT_MAX) /*used for SPELL bonus */\
  280. BONUS_VALUE(INDEPENDENT_MIN) //used for SECONDARY_SKILL_PREMY bonus
  281. /// Struct for handling bonuses of several types. Can be transferred to any hero
  282. struct DLL_LINKAGE Bonus : public std::enable_shared_from_this<Bonus>
  283. {
  284. enum { EVERY_TYPE = -1 };
  285. enum BonusType
  286. {
  287. #define BONUS_NAME(x) x,
  288. BONUS_LIST
  289. #undef BONUS_NAME
  290. };
  291. enum BonusDuration //when bonus is automatically removed
  292. {
  293. PERMANENT = 1,
  294. ONE_BATTLE = 2, //at the end of battle
  295. ONE_DAY = 4, //at the end of day
  296. ONE_WEEK = 8, //at the end of week (bonus lasts till the end of week, thats NOT 7 days
  297. N_TURNS = 16, //used during battles, after battle bonus is always removed
  298. N_DAYS = 32,
  299. UNTIL_BEING_ATTACKED = 64, /*removed after attack and counterattacks are performed*/
  300. UNTIL_ATTACK = 128, /*removed after attack and counterattacks are performed*/
  301. STACK_GETS_TURN = 256, /*removed when stack gets its turn - used for defensive stance*/
  302. COMMANDER_KILLED = 512
  303. };
  304. enum BonusSource
  305. {
  306. #define BONUS_SOURCE(x) x,
  307. BONUS_SOURCE_LIST
  308. #undef BONUS_SOURCE
  309. };
  310. enum LimitEffect
  311. {
  312. NO_LIMIT = 0,
  313. ONLY_DISTANCE_FIGHT=1, ONLY_MELEE_FIGHT, //used to mark bonuses for attack/defense primary skills from spells like Precision (distance only)
  314. ONLY_ENEMY_ARMY
  315. };
  316. enum ValueType
  317. {
  318. #define BONUS_VALUE(x) x,
  319. BONUS_VALUE_LIST
  320. #undef BONUS_VALUE
  321. };
  322. ui16 duration; //uses BonusDuration values
  323. si16 turnsRemain; //used if duration is N_TURNS, N_DAYS or ONE_WEEK
  324. BonusType type; //uses BonusType values - says to what is this bonus - 1 byte
  325. TBonusSubtype subtype; //-1 if not applicable - 4 bytes
  326. BonusSource source;//source type" uses BonusSource values - what gave that bonus
  327. si32 val;
  328. ui32 sid; //source id: id of object/artifact/spell
  329. ValueType valType;
  330. std::string stacking; // bonuses with the same stacking value don't stack (e.g. Angel/Archangel morale bonus)
  331. CAddInfo additionalInfo;
  332. LimitEffect effectRange; //if not NO_LIMIT, bonus will be omitted by default
  333. TLimiterPtr limiter;
  334. TPropagatorPtr propagator;
  335. TUpdaterPtr updater;
  336. std::string description;
  337. Bonus(ui16 Dur, BonusType Type, BonusSource Src, si32 Val, ui32 ID, std::string Desc, si32 Subtype=-1);
  338. Bonus(ui16 Dur, BonusType Type, BonusSource Src, si32 Val, ui32 ID, si32 Subtype=-1, ValueType ValType = ADDITIVE_VALUE);
  339. Bonus();
  340. template <typename Handler> void serialize(Handler &h, const int version)
  341. {
  342. h & duration;
  343. h & type;
  344. h & subtype;
  345. h & source;
  346. h & val;
  347. h & sid;
  348. h & description;
  349. if(version >= 783)
  350. {
  351. h & additionalInfo;
  352. }
  353. else
  354. {
  355. additionalInfo.resize(1, -1);
  356. h & additionalInfo[0];
  357. }
  358. h & turnsRemain;
  359. h & valType;
  360. if(version >= 784)
  361. {
  362. h & stacking;
  363. }
  364. h & effectRange;
  365. h & limiter;
  366. h & propagator;
  367. if(version >= 781)
  368. {
  369. h & updater;
  370. }
  371. }
  372. template <typename Ptr>
  373. static bool compareByAdditionalInfo(const Ptr& a, const Ptr& b)
  374. {
  375. return a->additionalInfo < b->additionalInfo;
  376. }
  377. static bool NDays(const Bonus *hb)
  378. {
  379. return hb->duration & Bonus::N_DAYS;
  380. }
  381. static bool NTurns(const Bonus *hb)
  382. {
  383. return hb->duration & Bonus::N_TURNS;
  384. }
  385. static bool OneDay(const Bonus *hb)
  386. {
  387. return hb->duration & Bonus::ONE_DAY;
  388. }
  389. static bool OneWeek(const Bonus *hb)
  390. {
  391. return hb->duration & Bonus::ONE_WEEK;
  392. }
  393. static bool OneBattle(const Bonus *hb)
  394. {
  395. return hb->duration & Bonus::ONE_BATTLE;
  396. }
  397. static bool Permanent(const Bonus *hb)
  398. {
  399. return hb->duration & Bonus::PERMANENT;
  400. }
  401. static bool UntilGetsTurn(const Bonus *hb)
  402. {
  403. return hb->duration & Bonus::STACK_GETS_TURN;
  404. }
  405. static bool UntilAttack(const Bonus *hb)
  406. {
  407. return hb->duration & Bonus::UNTIL_ATTACK;
  408. }
  409. static bool UntilBeingAttacked(const Bonus *hb)
  410. {
  411. return hb->duration & Bonus::UNTIL_BEING_ATTACKED;
  412. }
  413. static bool UntilCommanderKilled(const Bonus *hb)
  414. {
  415. return hb->duration & Bonus::COMMANDER_KILLED;
  416. }
  417. inline bool operator == (const BonusType & cf) const
  418. {
  419. return type == cf;
  420. }
  421. inline void operator += (const ui32 Val) //no return
  422. {
  423. val += Val;
  424. }
  425. std::string Description() const;
  426. JsonNode toJsonNode() const;
  427. std::string nameForBonus() const; // generate suitable name for bonus - e.g. for storing in json struct
  428. std::shared_ptr<Bonus> addLimiter(TLimiterPtr Limiter); //returns this for convenient chain-calls
  429. std::shared_ptr<Bonus> addPropagator(TPropagatorPtr Propagator); //returns this for convenient chain-calls
  430. std::shared_ptr<Bonus> addUpdater(TUpdaterPtr Updater); //returns this for convenient chain-calls
  431. };
  432. DLL_LINKAGE std::ostream & operator<<(std::ostream &out, const Bonus &bonus);
  433. class DLL_LINKAGE BonusList
  434. {
  435. public:
  436. typedef std::vector<std::shared_ptr<Bonus>> TInternalContainer;
  437. private:
  438. TInternalContainer bonuses;
  439. bool belongsToTree;
  440. void changed();
  441. public:
  442. typedef TInternalContainer::const_reference const_reference;
  443. typedef TInternalContainer::value_type value_type;
  444. typedef TInternalContainer::const_iterator const_iterator;
  445. typedef TInternalContainer::iterator iterator;
  446. BonusList(bool BelongsToTree = false);
  447. BonusList(const BonusList &bonusList);
  448. BonusList(BonusList && other);
  449. BonusList& operator=(const BonusList &bonusList);
  450. // wrapper functions of the STL vector container
  451. TInternalContainer::size_type size() const { return bonuses.size(); }
  452. void push_back(std::shared_ptr<Bonus> x);
  453. TInternalContainer::iterator erase (const int position);
  454. void clear();
  455. bool empty() const { return bonuses.empty(); }
  456. void resize(TInternalContainer::size_type sz, std::shared_ptr<Bonus> c = nullptr );
  457. std::shared_ptr<Bonus> &operator[] (TInternalContainer::size_type n) { return bonuses[n]; }
  458. const std::shared_ptr<Bonus> &operator[] (TInternalContainer::size_type n) const { return bonuses[n]; }
  459. std::shared_ptr<Bonus> &back() { return bonuses.back(); }
  460. std::shared_ptr<Bonus> &front() { return bonuses.front(); }
  461. const std::shared_ptr<Bonus> &back() const { return bonuses.back(); }
  462. const std::shared_ptr<Bonus> &front() const { return bonuses.front(); }
  463. // There should be no non-const access to provide solid,robust bonus caching
  464. TInternalContainer::const_iterator begin() const { return bonuses.begin(); }
  465. TInternalContainer::const_iterator end() const { return bonuses.end(); }
  466. TInternalContainer::size_type operator-=(std::shared_ptr<Bonus> const &i);
  467. // BonusList functions
  468. void stackBonuses();
  469. int totalValue() const;
  470. void getBonuses(BonusList &out, const CSelector &selector, const CSelector &limit) const;
  471. void getAllBonuses(BonusList &out) const;
  472. void getBonuses(BonusList & out, const CSelector &selector) const;
  473. //special find functions
  474. std::shared_ptr<Bonus> getFirst(const CSelector &select);
  475. const std::shared_ptr<Bonus> getFirst(const CSelector &select) const;
  476. int valOfBonuses(const CSelector &select) const;
  477. // conversion / output
  478. JsonNode toJsonNode() const;
  479. // remove_if implementation for STL vector types
  480. template <class Predicate>
  481. void remove_if(Predicate pred)
  482. {
  483. BonusList newList;
  484. for (ui32 i = 0; i < bonuses.size(); i++)
  485. {
  486. auto b = bonuses[i];
  487. if (!pred(b.get()))
  488. newList.push_back(b);
  489. }
  490. bonuses.clear();
  491. bonuses.resize(newList.size());
  492. std::copy(newList.begin(), newList.end(), bonuses.begin());
  493. }
  494. template <class InputIterator>
  495. void insert(const int position, InputIterator first, InputIterator last);
  496. void insert(TInternalContainer::iterator position, TInternalContainer::size_type n, std::shared_ptr<Bonus> const &x);
  497. template <typename Handler>
  498. void serialize(Handler &h, const int version)
  499. {
  500. h & static_cast<TInternalContainer&>(bonuses);
  501. }
  502. // C++ for range support
  503. auto begin () -> decltype (bonuses.begin())
  504. {
  505. return bonuses.begin();
  506. }
  507. auto end () -> decltype (bonuses.end())
  508. {
  509. return bonuses.end();
  510. }
  511. };
  512. // Extensions for BOOST_FOREACH to enable iterating of BonusList objects
  513. // Don't touch/call this functions
  514. inline BonusList::iterator range_begin(BonusList & x)
  515. {
  516. return x.begin();
  517. }
  518. inline BonusList::iterator range_end(BonusList & x)
  519. {
  520. return x.end();
  521. }
  522. inline BonusList::const_iterator range_begin(BonusList const &x)
  523. {
  524. return x.begin();
  525. }
  526. inline BonusList::const_iterator range_end(BonusList const &x)
  527. {
  528. return x.end();
  529. }
  530. DLL_LINKAGE std::ostream & operator<<(std::ostream &out, const BonusList &bonusList);
  531. class DLL_LINKAGE IPropagator
  532. {
  533. public:
  534. virtual ~IPropagator();
  535. virtual bool shouldBeAttached(CBonusSystemNode *dest);
  536. template <typename Handler> void serialize(Handler &h, const int version)
  537. {}
  538. };
  539. class DLL_LINKAGE CPropagatorNodeType : public IPropagator
  540. {
  541. int nodeType; //CBonusSystemNode::ENodeTypes
  542. public:
  543. CPropagatorNodeType();
  544. CPropagatorNodeType(int NodeType);
  545. bool shouldBeAttached(CBonusSystemNode *dest) override;
  546. template <typename Handler> void serialize(Handler &h, const int version)
  547. {
  548. h & nodeType;
  549. }
  550. };
  551. struct BonusLimitationContext
  552. {
  553. const std::shared_ptr<Bonus> b;
  554. const CBonusSystemNode & node;
  555. const BonusList & alreadyAccepted;
  556. const BonusList & stillUndecided;
  557. };
  558. class DLL_LINKAGE ILimiter
  559. {
  560. public:
  561. enum EDecision {ACCEPT, DISCARD, NOT_SURE};
  562. virtual ~ILimiter();
  563. virtual int limit(const BonusLimitationContext &context) const; //0 - accept bonus; 1 - drop bonus; 2 - delay (drops eventually)
  564. virtual std::string toString() const;
  565. virtual JsonNode toJsonNode() const;
  566. template <typename Handler> void serialize(Handler &h, const int version)
  567. {
  568. }
  569. };
  570. class DLL_LINKAGE IBonusBearer
  571. {
  572. public:
  573. //new bonusing node interface
  574. // * selector is predicate that tests if HeroBonus matches our criteria
  575. // * root is node on which call was made (nullptr will be replaced with this)
  576. //interface
  577. virtual const TBonusListPtr getAllBonuses(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr, const std::string &cachingStr = "") const = 0;
  578. int valOfBonuses(const CSelector &selector, const std::string &cachingStr = "") const;
  579. bool hasBonus(const CSelector &selector, const std::string &cachingStr = "") const;
  580. bool hasBonus(const CSelector &selector, const CSelector &limit, const std::string &cachingStr = "") const;
  581. const TBonusListPtr getBonuses(const CSelector &selector, const CSelector &limit, const std::string &cachingStr = "") const;
  582. const TBonusListPtr getBonuses(const CSelector &selector, const std::string &cachingStr = "") const;
  583. const std::shared_ptr<Bonus> getBonus(const CSelector &selector) const; //returns any bonus visible on node that matches (or nullptr if none matches)
  584. //legacy interface
  585. int valOfBonuses(Bonus::BonusType type, const CSelector &selector) const;
  586. int valOfBonuses(Bonus::BonusType type, int subtype = -1) const; //subtype -> subtype of bonus, if -1 then anyt;
  587. bool hasBonusOfType(Bonus::BonusType type, int subtype = -1) const;//determines if hero has a bonus of given type (and optionally subtype)
  588. bool hasBonusFrom(Bonus::BonusSource source, ui32 sourceID) const;
  589. //various hlp functions for non-trivial values
  590. //used for stacks and creatures only
  591. virtual int getMinDamage(bool ranged) const;
  592. virtual int getMaxDamage(bool ranged) const;
  593. virtual int getAttack(bool ranged) const;
  594. virtual int getDefence(bool ranged) const;
  595. int MoraleVal() const; //range [-3, +3]
  596. int LuckVal() const; //range [-3, +3]
  597. ui32 MaxHealth() const; //get max HP of stack with all modifiers
  598. bool isLiving() const; //non-undead, non-non living or alive
  599. virtual si32 magicResistance() const;
  600. ui32 Speed(int turn = 0, bool useBind = false) const; //get speed of creature with all modificators
  601. si32 manaLimit() const; //maximum mana value for this hero (basically 10*knowledge)
  602. int getPrimSkillLevel(PrimarySkill::PrimarySkill id) const;
  603. virtual int64_t getTreeVersion() const = 0;
  604. };
  605. class DLL_LINKAGE CBonusSystemNode : public virtual IBonusBearer, public boost::noncopyable
  606. {
  607. public:
  608. enum ENodeTypes
  609. {
  610. UNKNOWN, STACK_INSTANCE, STACK_BATTLE, SPECIALTY, ARTIFACT, CREATURE, ARTIFACT_INSTANCE, HERO, PLAYER, TEAM,
  611. TOWN_AND_VISITOR, BATTLE, COMMANDER, GLOBAL_EFFECTS
  612. };
  613. private:
  614. BonusList bonuses; //wielded bonuses (local or up-propagated here)
  615. BonusList exportedBonuses; //bonuses coming from this node (wielded or propagated away)
  616. TNodesVector parents; //parents -> we inherit bonuses from them, we may attach our bonuses to them
  617. TNodesVector children;
  618. ENodeTypes nodeType;
  619. std::string description;
  620. static const bool cachingEnabled;
  621. mutable BonusList cachedBonuses;
  622. mutable int64_t cachedLast;
  623. static std::atomic<int32_t> treeChanged;
  624. // Setting a value to cachingStr before getting any bonuses caches the result for later requests.
  625. // This string needs to be unique, that's why it has to be setted in the following manner:
  626. // [property key]_[value] => only for selector
  627. mutable std::map<std::string, TBonusListPtr > cachedRequests;
  628. void getBonusesRec(BonusList &out, const CSelector &selector, const CSelector &limit) const;
  629. void getAllBonusesRec(BonusList &out) const;
  630. const TBonusListPtr getAllBonusesWithoutCaching(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr) const;
  631. const std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> b) const;
  632. public:
  633. explicit CBonusSystemNode();
  634. explicit CBonusSystemNode(ENodeTypes NodeType);
  635. CBonusSystemNode(CBonusSystemNode && other);
  636. virtual ~CBonusSystemNode();
  637. void limitBonuses(const BonusList &allBonuses, BonusList &out) const; //out will bo populed with bonuses that are not limited here
  638. TBonusListPtr limitBonuses(const BonusList &allBonuses) const; //same as above, returns out by val for convienence
  639. const TBonusListPtr getAllBonuses(const CSelector &selector, const CSelector &limit, const CBonusSystemNode *root = nullptr, const std::string &cachingStr = "") const override;
  640. void getParents(TCNodes &out) const; //retrieves list of parent nodes (nodes to inherit bonuses from),
  641. const std::shared_ptr<Bonus> getBonusLocalFirst(const CSelector &selector) const;
  642. //non-const interface
  643. void getParents(TNodes &out); //retrieves list of parent nodes (nodes to inherit bonuses from)
  644. void getRedParents(TNodes &out); //retrieves list of red parent nodes (nodes bonuses propagate from)
  645. void getRedAncestors(TNodes &out);
  646. void getRedChildren(TNodes &out);
  647. void getRedDescendants(TNodes &out);
  648. std::shared_ptr<Bonus> getBonusLocalFirst(const CSelector &selector);
  649. void attachTo(CBonusSystemNode *parent);
  650. void detachFrom(CBonusSystemNode *parent);
  651. void detachFromAll();
  652. virtual void addNewBonus(const std::shared_ptr<Bonus>& b);
  653. void accumulateBonus(const std::shared_ptr<Bonus>& b); //add value of bonus with same type/subtype or create new
  654. void newChildAttached(CBonusSystemNode *child);
  655. void childDetached(CBonusSystemNode *child);
  656. void propagateBonus(std::shared_ptr<Bonus> b);
  657. void unpropagateBonus(std::shared_ptr<Bonus> b);
  658. void removeBonus(const std::shared_ptr<Bonus>& b);
  659. void removeBonuses(const CSelector & selector);
  660. void removeBonusesRecursive(const CSelector & s);
  661. void newRedDescendant(CBonusSystemNode *descendant); //propagation needed
  662. void removedRedDescendant(CBonusSystemNode *descendant); //de-propagation needed
  663. bool isIndependentNode() const; //node is independent when it has no parents nor children
  664. bool actsAsBonusSourceOnly() const;
  665. ///updates count of remaining turns and removes outdated bonuses by selector
  666. void reduceBonusDurations(const CSelector &s);
  667. virtual std::string bonusToString(const std::shared_ptr<Bonus>& bonus, bool description) const {return "";}; //description or bonus name
  668. virtual std::string nodeName() const;
  669. void deserializationFix();
  670. void exportBonus(std::shared_ptr<Bonus> b);
  671. void exportBonuses();
  672. const BonusList &getBonusList() const;
  673. BonusList &getExportedBonusList();
  674. CBonusSystemNode::ENodeTypes getNodeType() const;
  675. void setNodeType(CBonusSystemNode::ENodeTypes type);
  676. const TNodesVector &getParentNodes() const;
  677. const TNodesVector &getChildrenNodes() const;
  678. const std::string &getDescription() const;
  679. void setDescription(const std::string &description);
  680. static void treeHasChanged();
  681. int64_t getTreeVersion() const override;
  682. template <typename Handler> void serialize(Handler &h, const int version)
  683. {
  684. // h & bonuses;
  685. h & nodeType;
  686. h & exportedBonuses;
  687. h & description;
  688. BONUS_TREE_DESERIALIZATION_FIX
  689. //h & parents & children;
  690. }
  691. friend class CBonusProxy;
  692. };
  693. namespace NBonus
  694. {
  695. //set of methods that may be safely called with nullptr objs
  696. DLL_LINKAGE int valOf(const CBonusSystemNode *obj, Bonus::BonusType type, int subtype = -1); //subtype -> subtype of bonus, if -1 then any
  697. 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)
  698. }
  699. template<typename T>
  700. class CSelectFieldEqual
  701. {
  702. T Bonus::*ptr;
  703. public:
  704. CSelectFieldEqual(T Bonus::*Ptr)
  705. : ptr(Ptr)
  706. {
  707. }
  708. CSelector operator()(const T &valueToCompareAgainst) const
  709. {
  710. auto ptr2 = ptr; //We need a COPY because we don't want to reference this (might be outlived by lambda)
  711. return [ptr2, valueToCompareAgainst](const Bonus *bonus) { return bonus->*ptr2 == valueToCompareAgainst; };
  712. }
  713. };
  714. template<typename T> //can be same, needed for subtype field
  715. class CSelectFieldEqualOrEvery
  716. {
  717. T Bonus::*ptr;
  718. T val;
  719. public:
  720. CSelectFieldEqualOrEvery(T Bonus::*Ptr, const T &Val)
  721. : ptr(Ptr), val(Val)
  722. {
  723. }
  724. bool operator()(const Bonus *bonus) const
  725. {
  726. return (bonus->*ptr == val) || (bonus->*ptr == static_cast<T>(Bonus::EVERY_TYPE));
  727. }
  728. CSelectFieldEqualOrEvery& operator()(const T &setVal)
  729. {
  730. val = setVal;
  731. return *this;
  732. }
  733. };
  734. class DLL_LINKAGE CWillLastTurns
  735. {
  736. public:
  737. int turnsRequested;
  738. bool operator()(const Bonus *bonus) const
  739. {
  740. return turnsRequested <= 0 //every present effect will last zero (or "less") turns
  741. || !Bonus::NTurns(bonus) //so do every not expriing after N-turns effect
  742. || bonus->turnsRemain > turnsRequested;
  743. }
  744. CWillLastTurns& operator()(const int &setVal)
  745. {
  746. turnsRequested = setVal;
  747. return *this;
  748. }
  749. };
  750. class DLL_LINKAGE CWillLastDays
  751. {
  752. public:
  753. int daysRequested;
  754. bool operator()(const Bonus *bonus) const
  755. {
  756. if(daysRequested <= 0 || Bonus::Permanent(bonus) || Bonus::OneBattle(bonus))
  757. return true;
  758. else if(Bonus::OneDay(bonus))
  759. return false;
  760. else if(Bonus::NDays(bonus) || Bonus::OneWeek(bonus))
  761. {
  762. return bonus->turnsRemain > daysRequested;
  763. }
  764. return false; // TODO: ONE_WEEK need support for turnsRemain, but for now we'll exclude all unhandled durations
  765. }
  766. CWillLastDays& operator()(const int &setVal)
  767. {
  768. daysRequested = setVal;
  769. return *this;
  770. }
  771. };
  772. class DLL_LINKAGE AggregateLimiter : public ILimiter
  773. {
  774. protected:
  775. std::vector<TLimiterPtr> limiters;
  776. virtual const std::string & getAggregator() const = 0;
  777. public:
  778. void add(TLimiterPtr limiter);
  779. JsonNode toJsonNode() const override;
  780. template <typename Handler> void serialize(Handler & h, const int version)
  781. {
  782. h & static_cast<ILimiter&>(*this);
  783. if(version >= 786)
  784. {
  785. h & limiters;
  786. }
  787. }
  788. };
  789. class DLL_LINKAGE AllOfLimiter : public AggregateLimiter
  790. {
  791. protected:
  792. const std::string & getAggregator() const override;
  793. public:
  794. static const std::string aggregator;
  795. int limit(const BonusLimitationContext & context) const override;
  796. };
  797. class DLL_LINKAGE AnyOfLimiter : public AggregateLimiter
  798. {
  799. protected:
  800. const std::string & getAggregator() const override;
  801. public:
  802. static const std::string aggregator;
  803. int limit(const BonusLimitationContext & context) const override;
  804. };
  805. class DLL_LINKAGE NoneOfLimiter : public AggregateLimiter
  806. {
  807. protected:
  808. const std::string & getAggregator() const override;
  809. public:
  810. static const std::string aggregator;
  811. int limit(const BonusLimitationContext & context) const override;
  812. };
  813. class DLL_LINKAGE CCreatureTypeLimiter : public ILimiter //affect only stacks of given creature (and optionally it's upgrades)
  814. {
  815. public:
  816. const CCreature *creature;
  817. bool includeUpgrades;
  818. CCreatureTypeLimiter();
  819. CCreatureTypeLimiter(const CCreature &Creature, bool IncludeUpgrades = true);
  820. void setCreature (CreatureID id);
  821. int limit(const BonusLimitationContext &context) const override;
  822. virtual std::string toString() const override;
  823. virtual JsonNode toJsonNode() const override;
  824. template <typename Handler> void serialize(Handler &h, const int version)
  825. {
  826. h & static_cast<ILimiter&>(*this);
  827. h & creature;
  828. h & includeUpgrades;
  829. }
  830. };
  831. class DLL_LINKAGE HasAnotherBonusLimiter : public ILimiter //applies only to nodes that have another bonus working
  832. {
  833. public:
  834. Bonus::BonusType type;
  835. TBonusSubtype subtype;
  836. bool isSubtypeRelevant; //check for subtype only if this is true
  837. HasAnotherBonusLimiter(Bonus::BonusType bonus = Bonus::NONE);
  838. HasAnotherBonusLimiter(Bonus::BonusType bonus, TBonusSubtype _subtype);
  839. int limit(const BonusLimitationContext &context) const override;
  840. virtual std::string toString() const override;
  841. virtual JsonNode toJsonNode() const override;
  842. template <typename Handler> void serialize(Handler &h, const int version)
  843. {
  844. h & static_cast<ILimiter&>(*this);
  845. h & type;
  846. h & subtype;
  847. h & isSubtypeRelevant;
  848. }
  849. };
  850. class DLL_LINKAGE CreatureTerrainLimiter : public ILimiter //applies only to creatures that are on specified terrain, default native terrain
  851. {
  852. public:
  853. int terrainType;
  854. CreatureTerrainLimiter();
  855. CreatureTerrainLimiter(int TerrainType);
  856. int limit(const BonusLimitationContext &context) const override;
  857. virtual std::string toString() const override;
  858. virtual JsonNode toJsonNode() const override;
  859. template <typename Handler> void serialize(Handler &h, const int version)
  860. {
  861. h & static_cast<ILimiter&>(*this);
  862. h & terrainType;
  863. }
  864. };
  865. class DLL_LINKAGE CreatureFactionLimiter : public ILimiter //applies only to creatures of given faction
  866. {
  867. public:
  868. si8 faction;
  869. CreatureFactionLimiter();
  870. CreatureFactionLimiter(int TerrainType);
  871. int limit(const BonusLimitationContext &context) const override;
  872. virtual std::string toString() const override;
  873. virtual JsonNode toJsonNode() const override;
  874. template <typename Handler> void serialize(Handler &h, const int version)
  875. {
  876. h & static_cast<ILimiter&>(*this);
  877. h & faction;
  878. }
  879. };
  880. class DLL_LINKAGE CreatureAlignmentLimiter : public ILimiter //applies only to creatures of given alignment
  881. {
  882. public:
  883. si8 alignment;
  884. CreatureAlignmentLimiter();
  885. CreatureAlignmentLimiter(si8 Alignment);
  886. int limit(const BonusLimitationContext &context) const override;
  887. virtual std::string toString() const override;
  888. virtual JsonNode toJsonNode() const override;
  889. template <typename Handler> void serialize(Handler &h, const int version)
  890. {
  891. h & static_cast<ILimiter&>(*this);
  892. h & alignment;
  893. }
  894. };
  895. class DLL_LINKAGE StackOwnerLimiter : public ILimiter //applies only to creatures of given alignment
  896. {
  897. public:
  898. PlayerColor owner;
  899. StackOwnerLimiter();
  900. StackOwnerLimiter(PlayerColor Owner);
  901. int limit(const BonusLimitationContext &context) const override;
  902. template <typename Handler> void serialize(Handler &h, const int version)
  903. {
  904. h & static_cast<ILimiter&>(*this);
  905. h & owner;
  906. }
  907. };
  908. class DLL_LINKAGE RankRangeLimiter : public ILimiter //applies to creatures with min <= Rank <= max
  909. {
  910. public:
  911. ui8 minRank, maxRank;
  912. RankRangeLimiter();
  913. RankRangeLimiter(ui8 Min, ui8 Max = 255);
  914. int limit(const BonusLimitationContext &context) const override;
  915. template <typename Handler> void serialize(Handler &h, const int version)
  916. {
  917. h & static_cast<ILimiter&>(*this);
  918. h & minRank;
  919. h & maxRank;
  920. }
  921. };
  922. namespace Selector
  923. {
  924. extern DLL_LINKAGE CSelectFieldEqual<Bonus::BonusType> type;
  925. extern DLL_LINKAGE CSelectFieldEqual<TBonusSubtype> subtype;
  926. extern DLL_LINKAGE CSelectFieldEqual<CAddInfo> info;
  927. extern DLL_LINKAGE CSelectFieldEqual<Bonus::BonusSource> sourceType;
  928. extern DLL_LINKAGE CSelectFieldEqual<Bonus::LimitEffect> effectRange;
  929. extern DLL_LINKAGE CWillLastTurns turns;
  930. extern DLL_LINKAGE CWillLastDays days;
  931. CSelector DLL_LINKAGE typeSubtype(Bonus::BonusType Type, TBonusSubtype Subtype);
  932. CSelector DLL_LINKAGE typeSubtypeInfo(Bonus::BonusType type, TBonusSubtype subtype, CAddInfo info);
  933. CSelector DLL_LINKAGE source(Bonus::BonusSource source, ui32 sourceID);
  934. CSelector DLL_LINKAGE sourceTypeSel(Bonus::BonusSource source);
  935. CSelector DLL_LINKAGE valueType(Bonus::ValueType valType);
  936. /**
  937. * Selects all bonuses
  938. * Usage example: Selector::all.And(<functor>).And(<functor>)...)
  939. */
  940. extern DLL_LINKAGE CSelector all;
  941. /**
  942. * Selects nothing
  943. * Usage example: Selector::none.Or(<functor>).Or(<functor>)...)
  944. */
  945. extern DLL_LINKAGE CSelector none;
  946. bool DLL_LINKAGE matchesType(const CSelector &sel, Bonus::BonusType type);
  947. bool DLL_LINKAGE matchesTypeSubtype(const CSelector &sel, Bonus::BonusType type, TBonusSubtype subtype);
  948. }
  949. extern DLL_LINKAGE const std::map<std::string, Bonus::BonusType> bonusNameMap;
  950. extern DLL_LINKAGE const std::map<std::string, Bonus::ValueType> bonusValueMap;
  951. extern DLL_LINKAGE const std::map<std::string, Bonus::BonusSource> bonusSourceMap;
  952. extern DLL_LINKAGE const std::map<std::string, ui16> bonusDurationMap;
  953. extern DLL_LINKAGE const std::map<std::string, Bonus::LimitEffect> bonusLimitEffect;
  954. extern DLL_LINKAGE const std::map<std::string, TLimiterPtr> bonusLimiterMap;
  955. extern DLL_LINKAGE const std::map<std::string, TPropagatorPtr> bonusPropagatorMap;
  956. extern DLL_LINKAGE const std::map<std::string, TUpdaterPtr> bonusUpdaterMap;
  957. // BonusList template that requires full interface of CBonusSystemNode
  958. template <class InputIterator>
  959. void BonusList::insert(const int position, InputIterator first, InputIterator last)
  960. {
  961. bonuses.insert(bonuses.begin() + position, first, last);
  962. changed();
  963. }
  964. // observers for updating bonuses based on certain events (e.g. hero gaining level)
  965. class DLL_LINKAGE IUpdater
  966. {
  967. public:
  968. virtual ~IUpdater();
  969. virtual const std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> b, const CBonusSystemNode & context) const;
  970. virtual std::string toString() const;
  971. virtual JsonNode toJsonNode() const;
  972. template <typename Handler> void serialize(Handler & h, const int version)
  973. {
  974. }
  975. };
  976. class DLL_LINKAGE GrowsWithLevelUpdater : public IUpdater
  977. {
  978. public:
  979. int valPer20;
  980. int stepSize;
  981. GrowsWithLevelUpdater();
  982. GrowsWithLevelUpdater(int valPer20, int stepSize = 1);
  983. template <typename Handler> void serialize(Handler & h, const int version)
  984. {
  985. h & static_cast<IUpdater &>(*this);
  986. h & valPer20;
  987. h & stepSize;
  988. }
  989. const std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> b, const CBonusSystemNode & context) const override;
  990. virtual std::string toString() const override;
  991. virtual JsonNode toJsonNode() const override;
  992. };
  993. class DLL_LINKAGE TimesHeroLevelUpdater : public IUpdater
  994. {
  995. public:
  996. TimesHeroLevelUpdater();
  997. template <typename Handler> void serialize(Handler & h, const int version)
  998. {
  999. h & static_cast<IUpdater &>(*this);
  1000. }
  1001. const std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> b, const CBonusSystemNode & context) const override;
  1002. virtual std::string toString() const override;
  1003. virtual JsonNode toJsonNode() const override;
  1004. };
  1005. class DLL_LINKAGE TimesStackLevelUpdater : public IUpdater
  1006. {
  1007. public:
  1008. TimesStackLevelUpdater();
  1009. template <typename Handler> void serialize(Handler & h, const int version)
  1010. {
  1011. h & static_cast<IUpdater &>(*this);
  1012. }
  1013. const std::shared_ptr<Bonus> update(const std::shared_ptr<Bonus> b, const CBonusSystemNode & context) const override;
  1014. virtual std::string toString() const override;
  1015. virtual JsonNode toJsonNode() const override;
  1016. };