HeroBonus.h 42 KB

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