_SpellScript::EffectHook Class Reference

#include "SpellScript.h"

Inheritance diagram for _SpellScript::EffectHook:

Public Member Functions
	EffectHook (uint8 _effIndex)
virtual	~EffectHook ()
uint8	GetAffectedEffectsMask (SpellInfo const *spellInfo)
bool	IsEffectAffected (SpellInfo const *spellInfo, uint8 effIndex)
virtual bool	CheckEffect (SpellInfo const *spellInfo, uint8 effIndex)=0
std::string	EffIndexToString ()

Protected Attributes
uint8	effIndex

Detailed Description

Constructor & Destructor Documentation

EffectHook()

_SpellScript::EffectHook::EffectHook

(

uint8

_effIndex

)

{
    // effect index must be in range <0;2>, allow use of special effindexes
    ASSERT(_effIndex == EFFECT_ALL || _effIndex == EFFECT_FIRST_FOUND || _effIndex < MAX_SPELL_EFFECTS);
    effIndex = _effIndex;
}

References ASSERT, EFFECT_ALL, EFFECT_FIRST_FOUND, effIndex, and MAX_SPELL_EFFECTS.

~EffectHook()

virtual _SpellScript::EffectHook::~EffectHook ( )

inlinevirtual

{ }

Member Function Documentation

CheckEffect()

virtual bool _SpellScript::EffectHook::CheckEffect ( SpellInfo const *  spellInfo, uint8  effIndex  )

pure virtual

Implemented in SpellScript::EffectHandler, SpellScript::TargetHook, and AuraScript::EffectBase.

EffIndexToString()

std::string _SpellScript::EffectHook::EffIndexToString

(

)

{
    switch (effIndex)
    {
        case EFFECT_ALL:
            return "EFFECT_ALL";
        case EFFECT_FIRST_FOUND:
            return "EFFECT_FIRST_FOUND";
        case EFFECT_0:
            return "EFFECT_0";
        case EFFECT_1:
            return "EFFECT_1";
        case EFFECT_2:
            return "EFFECT_2";
    }
    return "Invalid Value";
}

References EFFECT_0, EFFECT_1, EFFECT_2, EFFECT_ALL, and EFFECT_FIRST_FOUND.

GetAffectedEffectsMask()

uint8 _SpellScript::EffectHook::GetAffectedEffectsMask

(

SpellInfo const *

spellInfo

)

{
    uint8 mask = 0;
    if ((effIndex == EFFECT_ALL) || (effIndex == EFFECT_FIRST_FOUND))
    {
        for (uint8 i = 0; i < MAX_SPELL_EFFECTS; ++i)
        {
            if ((effIndex == EFFECT_FIRST_FOUND) && mask)
                return mask;
            if (CheckEffect(spellInfo, i))
                mask |= (uint8)1 << i;
        }
    }
    else
    {
        if (CheckEffect(spellInfo, effIndex))
            mask |= (uint8)1 << effIndex;
    }
    return mask;
}

References EFFECT_ALL, EFFECT_FIRST_FOUND, and MAX_SPELL_EFFECTS.

IsEffectAffected()

bool _SpellScript::EffectHook::IsEffectAffected	(	SpellInfo const *	spellInfo,
		uint8	effIndex
	)

{
    return GetAffectedEffectsMask(spellInfo) & 1 << effIndex;
}

Member Data Documentation

effIndex

uint8 _SpellScript::EffectHook::effIndex

protected

Referenced by EffectHook().