src/game/SpellAuras.h

   1 /*
   2  * Copyright (C) 2005-2010 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18 #ifndef MANGOS_SPELLAURAS_H
  19 #define MANGOS_SPELLAURAS_H
  20
  21 #include "SpellAuraDefines.h"
  22
  23 struct Modifier
  24 {
  25     AuraType m_auraname;
  26     int32 m_amount;
  27     int32 m_miscvalue;
  28     uint32 periodictime;
  29 };
  30
  31 class Unit;
  32 struct SpellEntry;
  33 struct SpellModifier;
  34 struct ProcTriggerSpell;
  35
  36 // forward decl
  37 class Aura;
  38
  39 // internal helper
  40 struct ReapplyAffectedPassiveAurasHelper;
  41
  42 typedef void(Aura::*pAuraHandler)(bool Apply, bool Real);
  43 // Real == true at aura add/remove
  44 // Real == false at aura mod unapply/reapply; when adding/removing dependent aura/item/stat mods
  45 //
  46 // Code in aura handler can be guarded by if(Real) check if it should execution only at real add/remove of aura
  47 //
  48 // MAIN RULE: Code MUST NOT be guarded by if(Real) check if it modifies any stats
  49 //      (percent auras, stats mods, etc)
  50 // Second rule: Code must be guarded by if(Real) check if it modifies object state (start/stop attack, send packets to client, etc)
  51 //
  52 // Other case choice: each code line moved under if(Real) check is mangos speedup,
  53 //      each setting object update field code line moved under if(Real) check is significant mangos speedup, and less server->client data sends
  54 //      each packet sending code moved under if(Real) check is _large_ mangos speedup, and lot less server->client data sends
  55
  56 class MANGOS_DLL_SPEC Aura
  57 {
  58     friend struct ReapplyAffectedPassiveAurasHelper;
  59     friend Aura* CreateAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster, Item* castItem);
  60
  61     public:
  62         //aura handlers
  63         void HandleNULL(bool, bool)
  64         {
  65             // NOT IMPLEMENTED
  66         }
  67         void HandleUnused(bool, bool)
  68         {
  69             // NOT USED BY ANY SPELL OR USELESS
  70         }
  71         void HandleNoImmediateEffect(bool, bool)
  72         {
  73             // aura not have immediate effect at add/remove and handled by ID in other code place
  74         }
  75         void HandleBindSight(bool Apply, bool Real);
  76         void HandleModPossess(bool Apply, bool Real);
  77         void HandlePeriodicDamage(bool Apply, bool Real);
  78         void HandleAuraDummy(bool Apply, bool Real);
  79         void HandleAuraPeriodicDummy(bool apply, bool Real);
  80         void HandleModConfuse(bool Apply, bool Real);
  81         void HandleModCharm(bool Apply, bool Real);
  82         void HandleModFear(bool Apply, bool Real);
  83         void HandlePeriodicHeal(bool Apply, bool Real);
  84         void HandleModAttackSpeed(bool Apply, bool Real);
  85         void HandleModMeleeRangedSpeedPct(bool apply, bool Real);
  86         void HandleModCombatSpeedPct(bool apply, bool Real);
  87         void HandleModThreat(bool Apply, bool Real);
  88         void HandleModTaunt(bool Apply, bool Real);
  89         void HandleFeignDeath(bool Apply, bool Real);
  90         void HandleAuraModDisarm(bool Apply, bool Real);
  91         void HandleAuraModStalked(bool Apply, bool Real);
  92         void HandleAuraWaterWalk(bool Apply, bool Real);
  93         void HandleAuraFeatherFall(bool Apply, bool Real);
  94         void HandleAuraHover(bool Apply, bool Real);
  95         void HandleAddModifier(bool Apply, bool Real);
  96
  97         void HandleAddTargetTrigger(bool Apply, bool Real);
  98         void HandleAuraModStun(bool Apply, bool Real);
  99         void HandleModDamageDone(bool Apply, bool Real);
 100         void HandleAuraUntrackable(bool Apply, bool Real);
 101         void HandleAuraEmpathy(bool Apply, bool Real);
 102         void HandleModOffhandDamagePercent(bool apply, bool Real);
 103         void HandleAuraModRangedAttackPower(bool Apply, bool Real);
 104         void HandleAuraModIncreaseEnergyPercent(bool Apply, bool Real);
 105         void HandleAuraModIncreaseHealthPercent(bool Apply, bool Real);
 106         void HandleAuraModRegenInterrupt(bool Apply, bool Real);
 107         void HandleHaste(bool Apply, bool Real);
 108         void HandlePeriodicTriggerSpell(bool Apply, bool Real);
 109         void HandlePeriodicTriggerSpellWithValue(bool apply, bool Real);
 110         void HandlePeriodicEnergize(bool Apply, bool Real);
 111         void HandleAuraModResistanceExclusive(bool Apply, bool Real);
 112         void HandleAuraSafeFall(bool Apply, bool Real);
 113         void HandleAuraModPetTalentsPoints(bool Apply, bool Real);
 114         void HandleModStealth(bool Apply, bool Real);
 115         void HandleInvisibility(bool Apply, bool Real);
 116         void HandleInvisibilityDetect(bool Apply, bool Real);
 117         void HandleAuraModTotalHealthPercentRegen(bool Apply, bool Real);
 118         void HandleAuraModTotalManaPercentRegen(bool Apply, bool Real);
 119         void HandleAuraModResistance(bool Apply, bool Real);
 120         void HandleAuraModRoot(bool Apply, bool Real);
 121         void HandleAuraModSilence(bool Apply, bool Real);
 122         void HandleAuraModStat(bool Apply, bool Real);
 123         void HandleAuraModIncreaseSpeed(bool Apply, bool Real);
 124         void HandleAuraModIncreaseMountedSpeed(bool Apply, bool Real);
 125         void HandleAuraModIncreaseFlightSpeed(bool Apply, bool Real);
 126         void HandleAuraModDecreaseSpeed(bool Apply, bool Real);
 127         void HandleAuraModUseNormalSpeed(bool Apply, bool Real);
 128         void HandleAuraModIncreaseHealth(bool Apply, bool Real);
 129         void HandleAuraModIncreaseEnergy(bool Apply, bool Real);
 130         void HandleAuraModShapeshift(bool Apply, bool Real);
 131         void HandleAuraModEffectImmunity(bool Apply, bool Real);
 132         void HandleAuraModStateImmunity(bool Apply, bool Real);
 133         void HandleAuraModSchoolImmunity(bool Apply, bool Real);
 134         void HandleAuraModDmgImmunity(bool Apply, bool Real);
 135         void HandleAuraModDispelImmunity(bool Apply, bool Real);
 136         void HandleAuraProcTriggerSpell(bool Apply, bool Real);
 137         void HandleAuraTrackCreatures(bool Apply, bool Real);
 138         void HandleAuraTrackResources(bool Apply, bool Real);
 139         void HandleAuraModParryPercent(bool Apply, bool Real);
 140         void HandleAuraModDodgePercent(bool Apply, bool Real);
 141         void HandleAuraModBlockPercent(bool Apply, bool Real);
 142         void HandleAuraModCritPercent(bool Apply, bool Real);
 143         void HandlePeriodicLeech(bool Apply, bool Real);
 144         void HandleModHitChance(bool Apply, bool Real);
 145         void HandleModSpellHitChance(bool Apply, bool Real);
 146         void HandleAuraModScale(bool Apply, bool Real);
 147         void HandlePeriodicManaLeech(bool Apply, bool Real);
 148         void HandlePeriodicHealthFunnel(bool apply, bool Real);
 149         void HandleModCastingSpeed(bool Apply, bool Real);
 150         void HandleAuraMounted(bool Apply, bool Real);
 151         void HandleWaterBreathing(bool Apply, bool Real);
 152         void HandleModBaseResistance(bool Apply, bool Real);
 153         void HandleModRegen(bool Apply, bool Real);
 154         void HandleModPowerRegen(bool Apply, bool Real);
 155         void HandleModPowerRegenPCT(bool Apply, bool Real);
 156         void HandleChannelDeathItem(bool Apply, bool Real);
 157         void HandlePeriodicDamagePCT(bool Apply, bool Real);
 158         void HandleAuraModAttackPower(bool Apply, bool Real);
 159         void HandleAuraTransform(bool Apply, bool Real);
 160         void HandleModSpellCritChance(bool Apply, bool Real);
 161         void HandleAuraModIncreaseSwimSpeed(bool Apply, bool Real);
 162         void HandleModPowerCostPCT(bool Apply, bool Real);
 163         void HandleModPowerCost(bool Apply, bool Real);
 164         void HandleFarSight(bool Apply, bool Real);
 165         void HandleModPossessPet(bool Apply, bool Real);
 166         void HandleModMechanicImmunity(bool Apply, bool Real);
 167         void HandleModMechanicImmunityMask(bool Apply, bool Real);
 168         void HandleAuraModSkill(bool Apply, bool Real);
 169         void HandleModDamagePercentDone(bool Apply, bool Real);
 170         void HandleModPercentStat(bool Apply, bool Real);
 171         void HandleModResistancePercent(bool Apply, bool Real);
 172         void HandleAuraModBaseResistancePCT(bool Apply, bool Real);
 173         void HandleModShieldBlockPCT(bool Apply, bool Real);
 174         void HandleAuraTrackStealthed(bool Apply, bool Real);
 175         void HandleModShieldBlock(bool Apply, bool Real);
 176         void HandleForceReaction(bool Apply, bool Real);
 177         void HandleAuraModRangedHaste(bool Apply, bool Real);
 178         void HandleRangedAmmoHaste(bool Apply, bool Real);
 179         void HandleModHealingDone(bool Apply, bool Real);
 180         void HandleModTotalPercentStat(bool Apply, bool Real);
 181         void HandleAuraModTotalThreat(bool Apply, bool Real);
 182         void HandleModUnattackable(bool Apply, bool Real);
 183         void HandleAuraModPacify(bool Apply, bool Real);
 184         void HandleAuraGhost(bool Apply, bool Real);
 185         void HandleAuraAllowFlight(bool Apply, bool Real);
 186         void HandleModRating(bool apply, bool Real);
 187         void HandleModRatingFromStat(bool apply, bool Real);
 188         void HandleModTargetResistance(bool apply, bool Real);
 189         void HandleAuraModAttackPowerPercent(bool apply, bool Real);
 190         void HandleAuraModRangedAttackPowerPercent(bool apply, bool Real);
 191         void HandleAuraModRangedAttackPowerOfStatPercent(bool apply, bool Real);
 192         void HandleAuraModAttackPowerOfStatPercent(bool apply, bool Real);
 193         void HandleAuraModAttackPowerOfArmor(bool apply, bool Real);
 194         void HandleSpiritOfRedemption(bool apply, bool Real);
 195         void HandleModManaRegen(bool apply, bool Real);
 196         void HandleComprehendLanguage(bool apply, bool Real);
 197         void HandleShieldBlockValue(bool apply, bool Real);
 198         void HandleModSpellCritChanceShool(bool apply, bool Real);
 199         void HandleAuraRetainComboPoints(bool apply, bool Real);
 200         void HandleModSpellDamagePercentFromStat(bool apply, bool Real);
 201         void HandleModSpellHealingPercentFromStat(bool apply, bool Real);
 202         void HandleAuraModDispelResist(bool apply, bool Real);
 203         void HandleAuraControlVehicle(bool apply, bool Real);
 204         void HandleModSpellDamagePercentFromAttackPower(bool apply, bool Real);
 205         void HandleModSpellHealingPercentFromAttackPower(bool apply, bool Real);
 206         void HandleAuraModPacifyAndSilence(bool Apply, bool Real);
 207         void HandleAuraModIncreaseMaxHealth(bool apply, bool Real);
 208         void HandleAuraModExpertise(bool apply, bool Real);
 209         void HandleForceMoveForward(bool apply, bool Real);
 210         void HandleAuraModResistenceOfStatPercent(bool apply, bool Real);
 211         void HandleAuraPowerBurn(bool apply, bool Real);
 212         void HandleSchoolAbsorb(bool apply, bool Real);
 213         void HandlePreventFleeing(bool apply, bool Real);
 214         void HandleManaShield(bool apply, bool Real);
 215         void HandleArenaPreparation(bool apply, bool Real);
 216         void HandleAuraConvertRune(bool apply, bool Real);
 217         void HandleAuraIncreaseBaseHealthPercent(bool Apply, bool Real);
 218         void HandleNoReagentUseAura(bool Apply, bool Real);
 219         void HandlePhase(bool Apply, bool Real);
 220         void HandleModTargetArmorPct(bool Apply, bool Real);
 221         void HandleAuraModAllCritChance(bool Apply, bool Real);
 222         void HandleAllowOnlyAbility(bool Apply, bool Real);
 223
 224         virtual ~Aura();
 225
 226         void SetModifier(AuraType t, int32 a, uint32 pt, int32 miscValue);
 227         Modifier*       GetModifier()       { return &m_modifier; }
 228         Modifier const* GetModifier() const { return &m_modifier; }
 229         int32 GetMiscValue() const { return m_spellProto->EffectMiscValue[m_effIndex]; }
 230         int32 GetMiscBValue() const { return m_spellProto->EffectMiscValueB[m_effIndex]; }
 231
 232         SpellEntry const* GetSpellProto() const { return m_spellProto; }
 233         uint32 GetId() const{ return m_spellProto->Id; }
 234         uint64 GetCastItemGUID() const { return m_castItemGuid; }
 235         uint32 GetEffIndex() const{ return m_effIndex; }
 236         int32 GetBasePoints() const { return m_currentBasePoints; }
 237
 238         int32 GetAuraMaxDuration() const { return m_maxduration; }
 239         void SetAuraMaxDuration(int32 duration) { m_maxduration = duration; }
 240         int32 GetAuraDuration() const { return m_duration; }
 241         void SetAuraDuration(int32 duration) { m_duration = duration; }
 242         time_t GetAuraApplyTime() const { return m_applyTime; }
 243         uint32 GetAuraTicks() const { return m_periodicTick; }
 244         uint32 GetAuraMaxTicks() const { return m_maxduration > 0 && m_modifier.periodictime > 0 ? m_maxduration / m_modifier.periodictime : 0; }
 245
 246         SpellModifier *getAuraSpellMod() {return m_spellmod; }
 247
 248         uint64 const& GetCasterGUID() const { return m_caster_guid; }
 249         Unit* GetCaster() const;
 250         Unit* GetTarget() const { return m_target; }
 251         void SetTarget(Unit* target) { m_target = target; }
 252         void SetLoadedState(uint64 caster_guid,int32 damage,int32 maxduration,int32 duration,int32 charges)
 253         {
 254             m_caster_guid = caster_guid;
 255             m_modifier.m_amount = damage;
 256             m_maxduration = maxduration;
 257             m_duration = duration;
 258             m_procCharges = charges;
 259
 260             if(uint32 maxticks = GetAuraMaxTicks())
 261                 m_periodicTick = maxticks - m_duration / m_modifier.periodictime;
 262         }
 263
 264         uint8 GetAuraSlot() const { return m_auraSlot; }
 265         void SetAuraSlot(uint8 slot) { m_auraSlot = slot; }
 266         uint8 GetAuraFlags() const { return m_auraFlags; }
 267         void SetAuraFlags(uint8 flags) { m_auraFlags = flags; }
 268         uint8 GetAuraLevel() const { return m_auraLevel; }
 269         void SetAuraLevel(uint8 level) { m_auraLevel = level; }
 270         uint8 GetAuraCharges() const { return m_procCharges; }
 271         void SetAuraCharges(uint8 charges)
 272         {
 273             if (m_procCharges == charges)
 274                 return;
 275             m_procCharges = charges;
 276             SendAuraUpdate(false);
 277         }
 278         bool DropAuraCharge()                               // return true if last charge dropped
 279         {
 280             if (m_procCharges == 0)
 281                 return false;
 282
 283             // exist spells that have maxStack > 1 and m_procCharges > 0 (==1 in fact)
 284             // all like stacks have 1 value in one from this fields
 285             // so return true for allow remove one aura from stacks as expired
 286             if (GetStackAmount() > 1)
 287                 return true;
 288
 289             m_procCharges--;
 290             SendAuraUpdate(false);
 291             return m_procCharges == 0;
 292         }
 293
 294         void UnregisterSingleCastAura();
 295
 296         void SetAura(bool remove) { m_target->SetVisibleAura(m_auraSlot, remove ? 0 : GetId()); }
 297         void SendAuraUpdate(bool remove);
 298
 299         int8 GetStackAmount() {return m_stackAmount;}
 300         void SetStackAmount(uint8 num);
 301         bool modStackAmount(int32 num); // return true if last charge dropped
 302         void RefreshAura();
 303
 304         bool IsPositive() { return m_positive; }
 305         void SetNegative() { m_positive = false; }
 306         void SetPositive() { m_positive = true; }
 307
 308         bool IsPermanent() const { return m_permanent; }
 309         bool IsAreaAura() const { return m_isAreaAura; }
 310         bool IsPeriodic() const { return m_isPeriodic; }
 311         bool IsPassive() const { return m_isPassive; }
 312         bool IsPersistent() const { return m_isPersistent; }
 313         bool IsDeathPersistent() const { return m_isDeathPersist; }
 314         bool IsRemovedOnShapeLost() const { return m_isRemovedOnShapeLost; }
 315         bool IsInUse() const { return m_in_use;}
 316         bool IsDeleted() const { return m_deleted;}
 317
 318         void SetInUse(bool state)
 319         {
 320             if(state)
 321                 ++m_in_use;
 322             else
 323             {
 324                 if(m_in_use)
 325                     --m_in_use;
 326             }
 327         }
 328         void ApplyModifier(bool apply, bool Real = false);
 329
 330         void UpdateAura(uint32 diff) { SetInUse(true); Update(diff); SetInUse(false); }
 331         void _AddAura();
 332         bool _RemoveAura();
 333
 334         bool IsSingleTarget() {return m_isSingleTargetAura;}
 335         void SetIsSingleTarget(bool val) { m_isSingleTargetAura = val;}
 336
 337         void SetRemoveMode(AuraRemoveMode mode) { m_removeMode = mode; }
 338
 339         virtual Unit* GetTriggerTarget() const { return m_target; }
 340
 341         // add/remove SPELL_AURA_MOD_SHAPESHIFT (36) linked auras
 342         void HandleShapeshiftBoosts(bool apply);
 343         void HandleSpellSpecificBoosts(bool apply);
 344
 345         // Allow Apply Aura Handler to modify and access m_AuraDRGroup
 346         void setDiminishGroup(DiminishingGroup group) { m_AuraDRGroup = group; }
 347         DiminishingGroup getDiminishGroup() const { return m_AuraDRGroup; }
 348
 349         void TriggerSpell();
 350         void TriggerSpellWithValue();
 351
 352         uint32 const *getAuraSpellClassMask() const { return  m_spellProto->GetEffectSpellClassMask(m_effIndex); }
 353         bool isAffectedOnSpell(SpellEntry const *spell) const;
 354     protected:
 355         Aura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster = NULL, Item* castItem = NULL);
 356
 357         // must be called only from Aura::UpdateAura
 358         virtual void Update(uint32 diff);
 359
 360         // must be called only from Aura*::Update
 361         void PeriodicTick();
 362         void PeriodicDummyTick();
 363
 364         bool IsCritFromAbilityAura(Unit* caster, uint32& damage);
 365         void ReapplyAffectedPassiveAuras();
 366
 367         Modifier m_modifier;
 368         SpellModifier *m_spellmod;
 369
 370         SpellEntry const *m_spellProto;
 371         Unit* m_target;
 372         uint64 m_caster_guid;
 373         uint64 m_castItemGuid;                              // it is NOT safe to keep a pointer to the item because it may get deleted
 374         time_t m_applyTime;
 375
 376         int32 m_currentBasePoints;                          // cache SpellEntry::EffectBasePoints and use for set custom base points
 377         int32 m_maxduration;                                // Max aura duration
 378         int32 m_duration;                                   // Current time
 379         int32 m_timeCla;                                    // Timer for power per sec calcultion
 380         int32 m_periodicTimer;                              // Timer for periodic auras
 381         uint32 m_periodicTick;                              // Tick count pass (including current if use in tick code) from aura apply, used for some tick count dependent aura effects
 382
 383         AuraRemoveMode m_removeMode:8;                      // Store info for know remove aura reason
 384         DiminishingGroup m_AuraDRGroup:8;                   // Diminishing
 385
 386         uint8 m_effIndex;                                   // Aura effect index in spell
 387         uint8 m_auraSlot;                                   // Aura slot on unit (for show in client)
 388         uint8 m_auraFlags;                                  // Aura info flag (for send data to client)
 389         uint8 m_auraLevel;                                  // Aura level (store caster level for correct show level dep amount)
 390         uint8 m_procCharges;                                // Aura charges (0 for infinite)
 391         uint8 m_stackAmount;                                // Aura stack amount
 392
 393         bool m_positive:1;
 394         bool m_permanent:1;
 395         bool m_isPeriodic:1;
 396         bool m_isAreaAura:1;
 397         bool m_isPassive:1;
 398         bool m_isPersistent:1;
 399         bool m_isDeathPersist:1;
 400         bool m_isRemovedOnShapeLost:1;
 401         bool m_deleted:1;                                   // true if RemoveAura(iterator) called while in Aura::ApplyModifier call (added to Unit::m_deletedAuras)
 402         bool m_isSingleTargetAura:1;                        // true if it's a single target spell and registered at caster - can change at spell steal for example
 403
 404         uint32 m_in_use;                                    // > 0 while in Aura::ApplyModifier call/Aura::Update/etc
 405     private:
 406         void CleanupTriggeredSpells();
 407         bool IsNeedVisibleSlot(Unit const* caster) const;   // helper for check req. visibility slot
 408         void ReapplyAffectedPassiveAuras(Unit* target, bool owner_mode);
 409 };
 410
 411 class MANGOS_DLL_SPEC AreaAura : public Aura
 412 {
 413     public:
 414         AreaAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster = NULL, Item* castItem = NULL);
 415         ~AreaAura();
 416     protected:
 417         void Update(uint32 diff);
 418     private:
 419         float m_radius;
 420         AreaAuraType m_areaAuraType;
 421 };
 422
 423 class MANGOS_DLL_SPEC PersistentAreaAura : public Aura
 424 {
 425     public:
 426         PersistentAreaAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster = NULL, Item* castItem = NULL);
 427         ~PersistentAreaAura();
 428     protected:
 429         void Update(uint32 diff);
 430 };
 431
 432 class MANGOS_DLL_SPEC SingleEnemyTargetAura : public Aura
 433 {
 434     friend Aura* CreateAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster, Item* castItem);
 435
 436     public:
 437         ~SingleEnemyTargetAura();
 438         Unit* GetTriggerTarget() const;
 439
 440     protected:
 441         SingleEnemyTargetAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster  = NULL, Item* castItem = NULL);
 442         uint64 m_casters_target_guid;
 443 };
 444
 445 Aura* CreateAura(SpellEntry const* spellproto, uint32 eff, int32 *currentBasePoints, Unit *target, Unit *caster = NULL, Item* castItem = NULL);
 446 #endif