src/game/SpellAuras.h

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