SpellScript Class Reference

#include <SpellScript.h>

Classes
class	CastHandler
class	CheckCastHandler
class	DestinationTargetSelectHandler
class	EffectHandler
class	HitHandler
class	ObjectAreaTargetSelectHandler
class	ObjectTargetSelectHandler
class	TargetHook

Public Member Functions
bool	_Validate (SpellInfo const *entry) override
bool	_Load (Spell *spell)
void	_InitHit ()
bool	_IsEffectPrevented (SpellEffIndex effIndex)
bool	_IsDefaultEffectPrevented (SpellEffIndex effIndex)
void	_PrepareScriptCall (SpellScriptHookType hookType)
void	_FinishScriptCall ()
bool	IsInCheckCastHook () const
bool	IsInTargetHook () const
bool	IsInHitPhase () const
bool	IsInEffectHook () const
Unit *	GetCaster ()
Unit *	GetOriginalCaster ()
SpellInfo const *	GetSpellInfo ()
SpellValue const *	GetSpellValue ()
SpellEffectInfo const *	GetEffectInfo (SpellEffIndex) const
WorldLocation const *	GetExplTargetDest ()
void	SetExplTargetDest (WorldLocation &loc)
WorldObject *	GetExplTargetWorldObject ()
Unit *	GetExplTargetUnit ()
GameObject *	GetExplTargetGObj ()
Item *	GetExplTargetItem ()
Unit *	GetHitUnit ()
Creature *	GetHitCreature ()
Player *	GetHitPlayer ()
Item *	GetHitItem ()
GameObject *	GetHitGObj ()
WorldLocation *	GetHitDest ()
int32	GetHitDamage ()
void	SetHitDamage (int32 damage)
void	PreventHitDamage ()
int32	GetHitHeal ()
void	SetHitHeal (int32 heal)
void	PreventHitHeal ()
Spell *	GetSpell ()
Aura *	GetHitAura ()
void	PreventHitAura ()
void	PreventHitEffect (SpellEffIndex effIndex)
void	PreventHitDefaultEffect (SpellEffIndex effIndex)
SpellEffectInfo const *	GetEffectInfo () const
int32	GetEffectValue () const
void	SetEffectValue (int32 value)
Item *	GetCastItem ()
void	CreateItem (uint32 effIndex, uint32 itemId)
SpellInfo const *	GetTriggeringSpell ()
void	FinishCast (SpellCastResult result)
void	SetCustomCastResultMessage (SpellCustomErrors result)
Public Member Functions inherited from _SpellScript
	_SpellScript ()
virtual	~_SpellScript ()
virtual void	_Register ()
virtual void	_Unload ()
virtual void	_Init (std::string const *scriptname, uint32 spellId)
std::string const *	_GetScriptName () const
virtual void	Register ()=0
virtual bool	Validate (SpellInfo const *)
virtual bool	Load ()
virtual void	Unload ()

Public Attributes
HookList< CastHandler >	BeforeCast
HookList< CastHandler >	OnCast
HookList< CastHandler >	AfterCast
HookList< CheckCastHandler >	OnCheckCast
HookList< EffectHandler >	OnEffectLaunch
HookList< EffectHandler >	OnEffectLaunchTarget
HookList< EffectHandler >	OnEffectHit
HookList< EffectHandler >	OnEffectHitTarget
HookList< EffectHandler >	OnEffectSuccessfulDispel
HookList< HitHandler >	BeforeHit
HookList< HitHandler >	OnHit
HookList< HitHandler >	AfterHit
HookList < ObjectAreaTargetSelectHandler >	OnObjectAreaTargetSelect
HookList < ObjectTargetSelectHandler >	OnObjectTargetSelect
HookList < DestinationTargetSelectHandler >	OnDestinationTargetSelect

Private Attributes
Spell *	m_spell
uint8	m_hitPreventEffectMask
uint8	m_hitPreventDefaultEffectMask

Additional Inherited Members
Protected Attributes inherited from _SpellScript
uint8	m_currentScriptState
std::string const *	m_scriptName
uint32	m_scriptSpellId

Member Function Documentation

void SpellScript::_FinishScriptCall

(

)

{
 m_currentScriptState = SPELL_SCRIPT_STATE_NONE;
}

Here is the caller graph for this function:

void SpellScript::_InitHit

(

)

{
 m_hitPreventEffectMask = 0;
 m_hitPreventDefaultEffectMask = 0;
}

bool SpellScript::_IsDefaultEffectPrevented ( SpellEffIndex  effIndex )

inline

{ return (m_hitPreventDefaultEffectMask & (1 << effIndex)) != 0; }

bool SpellScript::_IsEffectPrevented ( SpellEffIndex  effIndex )

inline

{ return (m_hitPreventEffectMask & (1 << effIndex)) != 0; }

bool SpellScript::_Load

(

Spell *

spell

)

{
 m_spell = spell;
 _PrepareScriptCall((SpellScriptHookType)SPELL_SCRIPT_STATE_LOADING);
 bool load = Load();
 _FinishScriptCall();
 return load;
}

Here is the call graph for this function:

void SpellScript::_PrepareScriptCall

(

SpellScriptHookType

hookType

)

{
 m_currentScriptState = hookType;
}

Here is the caller graph for this function:

bool SpellScript::_Validate ( SpellInfo const *  entry )

overridevirtual

Reimplemented from _SpellScript.

{
 for (std::list<EffectHandler>::iterator itr = OnEffectLaunch.begin(); itr != OnEffectLaunch.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnEffectLaunch` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<EffectHandler>::iterator itr = OnEffectLaunchTarget.begin(); itr != OnEffectLaunchTarget.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnEffectLaunchTarget` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<EffectHandler>::iterator itr = OnEffectHit.begin(); itr != OnEffectHit.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnEffectHit` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<EffectHandler>::iterator itr = OnEffectHitTarget.begin(); itr != OnEffectHitTarget.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnEffectHitTarget` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<EffectHandler>::iterator itr = OnEffectSuccessfulDispel.begin(); itr != OnEffectSuccessfulDispel.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnEffectSuccessfulDispel` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<ObjectAreaTargetSelectHandler>::iterator itr = OnObjectAreaTargetSelect.begin(); itr != OnObjectAreaTargetSelect.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnObjectAreaTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<ObjectTargetSelectHandler>::iterator itr = OnObjectTargetSelect.begin(); itr != OnObjectTargetSelect.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnObjectTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 for (std::list<DestinationTargetSelectHandler>::iterator itr = OnDestinationTargetSelect.begin(); itr != OnDestinationTargetSelect.end(); ++itr)
 if (!(*itr).GetAffectedEffectsMask(entry))
 TC_LOG_ERROR("scripts", "Spell `%u` Effect `%s` of script `%s` did not match dbc effect data - handler bound to hook `OnDestinationTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString().c_str(), m_scriptName->c_str());

 return _SpellScript::_Validate(entry);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::CreateItem	(	uint32	effIndex,
		uint32	itemId
	)

{
 m_spell->DoCreateItem(effIndex, itemId);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::FinishCast

(

SpellCastResult

result

)

{
 m_spell->SendCastResult(result);
 m_spell->finish(result == SPELL_CAST_OK);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Unit * SpellScript::GetCaster

(

)

{
 return m_spell->GetCaster();
}

Here is the call graph for this function:

Item * SpellScript::GetCastItem

(

)

{
 return m_spell->m_CastItem;
}

Here is the caller graph for this function:

SpellEffectInfo const * SpellScript::GetEffectInfo

(

SpellEffIndex

effIndex

)

const

{
 return m_spell->GetEffect(effIndex);
}

Here is the call graph for this function:

SpellEffectInfo const * SpellScript::GetEffectInfo

(

)

const

{
 ASSERT(IsInEffectHook(), "Script: `%s` Spell: `%u`: function SpellScript::GetEffectInfo was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);

 return m_spell->effectInfo;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 SpellScript::GetEffectValue

(

)

const

{
 if (!IsInEffectHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetEffectValue was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return 0;
 }

 return m_spell->damage;
}

Here is the call graph for this function:

WorldLocation const * SpellScript::GetExplTargetDest

(

)

{
 if (m_spell->m_targets.HasDst())
 return m_spell->m_targets.GetDstPos();
 return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GameObject * SpellScript::GetExplTargetGObj

(

)

{
 return m_spell->m_targets.GetGOTarget();
}

Here is the call graph for this function:

Item * SpellScript::GetExplTargetItem

(

)

{
 return m_spell->m_targets.GetItemTarget();
}

Here is the call graph for this function:

Unit * SpellScript::GetExplTargetUnit

(

)

{
 return m_spell->m_targets.GetUnitTarget();
}

Here is the call graph for this function:

Here is the caller graph for this function:

WorldObject * SpellScript::GetExplTargetWorldObject

(

)

{
 return m_spell->m_targets.GetObjectTarget();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Aura * SpellScript::GetHitAura

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitAura was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 if (!m_spell->m_spellAura)
 return NULL;
 if (m_spell->m_spellAura->IsRemoved())
 return NULL;
 return m_spell->m_spellAura;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Creature * SpellScript::GetHitCreature

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitCreature was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 if (m_spell->unitTarget)
 return m_spell->unitTarget->ToCreature();
 else
 return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 SpellScript::GetHitDamage

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitDamage was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return 0;
 }
 return m_spell->m_damage;
}

Here is the call graph for this function:

Here is the caller graph for this function:

WorldLocation * SpellScript::GetHitDest

(

)

{
 if (!IsInEffectHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitDest was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 return m_spell->destTarget;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GameObject * SpellScript::GetHitGObj

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitGObj was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 return m_spell->gameObjTarget;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 SpellScript::GetHitHeal

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitHeal was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return 0;
 }
 return m_spell->m_healing;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Item * SpellScript::GetHitItem

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitItem was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 return m_spell->itemTarget;
}

Here is the call graph for this function:

Player * SpellScript::GetHitPlayer

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitPlayer was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 if (m_spell->unitTarget)
 return m_spell->unitTarget->ToPlayer();
 else
 return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Unit * SpellScript::GetHitUnit

(

)

{
 if (!IsInTargetHook())
 {
 TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::GetHitUnit was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
 return NULL;
 }
 return m_spell->unitTarget;
}

Here is the call graph for this function:

Unit * SpellScript::GetOriginalCaster

(

)

{
 return m_spell->GetOriginalCaster();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Spell* SpellScript::GetSpell ( )

inline

{ return m_spell; }

Here is the caller graph for this function:

SpellInfo const * SpellScript::GetSpellInfo

(

)

{
 return m_spell->GetSpellInfo();
}

Here is the call graph for this function:

SpellValue const * SpellScript::GetSpellValue

(

)

{
 return m_spell->m_spellValue;
}

Here is the caller graph for this function:

SpellInfo const * SpellScript::GetTriggeringSpell

(

)

{
 return m_spell->m_triggeredByAuraSpell;
}

Here is the caller graph for this function:

bool SpellScript::IsInCheckCastHook

(

)

const

{
 return m_currentScriptState == SPELL_SCRIPT_HOOK_CHECK_CAST;
}

Here is the caller graph for this function:

bool SpellScript::IsInEffectHook

(

)

const

{
 return (m_currentScriptState >= SPELL_SCRIPT_HOOK_EFFECT_LAUNCH && m_currentScriptState <= SPELL_SCRIPT_HOOK_EFFECT_HIT_TARGET);
}

Here is the caller graph for this function:

bool SpellScript::IsInHitPhase

(

)

const

{
 return (m_currentScriptState >= HOOK_SPELL_HIT_START && m_currentScriptState < HOOK_SPELL_HIT_END);
}

Here is the caller graph for this function:

bool SpellScript::IsInTargetHook

(

)

const

{
    switch (m_currentScriptState)
    {
        case SPELL_SCRIPT_HOOK_EFFECT_LAUNCH_TARGET:
        case SPELL_SCRIPT_HOOK_EFFECT_HIT_TARGET:
        case SPELL_SCRIPT_HOOK_BEFORE_HIT:
        case SPELL_SCRIPT_HOOK_HIT:
        case SPELL_SCRIPT_HOOK_AFTER_HIT:
            return true;
    }
    return false;
}

Here is the caller graph for this function:

void SpellScript::PreventHitAura

(

)

{
    if (!IsInTargetHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::PreventHitAura was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    if (m_spell->m_spellAura)
        m_spell->m_spellAura->Remove();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::PreventHitDamage ( )

inline

{ SetHitDamage(0); }

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::PreventHitDefaultEffect

(

SpellEffIndex

effIndex

)

{
    if (!IsInHitPhase() && !IsInEffectHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::PreventHitDefaultEffect was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    m_hitPreventDefaultEffectMask |= 1 << effIndex;
}

Here is the call graph for this function:

void SpellScript::PreventHitEffect

(

SpellEffIndex

effIndex

)

{
    if (!IsInHitPhase() && !IsInEffectHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::PreventHitEffect was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    m_hitPreventEffectMask |= 1 << effIndex;
    PreventHitDefaultEffect(effIndex);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::PreventHitHeal ( )

inline

{ SetHitHeal(0); }

Here is the call graph for this function:

void SpellScript::SetCustomCastResultMessage

(

SpellCustomErrors

result

)

{
    if (!IsInCheckCastHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::SetCustomCastResultMessage was called while spell not in check cast phase!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }

    m_spell->m_customError = result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::SetEffectValue

(

int32

value

)

{
    if (!IsInEffectHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::SetEffectValue was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }

    m_spell->damage = value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::SetExplTargetDest

(

WorldLocation &

loc

)

{
    m_spell->m_targets.SetDst(loc);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::SetHitDamage

(

int32

damage

)

{
    if (!IsInTargetHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::SetHitDamage was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    m_spell->m_damage = damage;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpellScript::SetHitHeal

(

int32

heal

)

{
    if (!IsInTargetHook())
    {
        TC_LOG_ERROR("scripts", "Script: `%s` Spell: `%u`: function SpellScript::SetHitHeal was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    m_spell->m_healing = heal;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

HookList<CastHandler> SpellScript::AfterCast

HookList<HitHandler> SpellScript::AfterHit

HookList<CastHandler> SpellScript::BeforeCast

HookList<HitHandler> SpellScript::BeforeHit

uint8 SpellScript::m_hitPreventDefaultEffectMask

private

uint8 SpellScript::m_hitPreventEffectMask

private

Spell* SpellScript::m_spell

private

HookList<CastHandler> SpellScript::OnCast

HookList<CheckCastHandler> SpellScript::OnCheckCast

HookList<DestinationTargetSelectHandler> SpellScript::OnDestinationTargetSelect

HookList<EffectHandler> SpellScript::OnEffectHit

HookList<EffectHandler> SpellScript::OnEffectHitTarget

HookList<EffectHandler> SpellScript::OnEffectLaunch

HookList<EffectHandler> SpellScript::OnEffectLaunchTarget

HookList<EffectHandler> SpellScript::OnEffectSuccessfulDispel

HookList<HitHandler> SpellScript::OnHit

HookList<ObjectAreaTargetSelectHandler> SpellScript::OnObjectAreaTargetSelect

HookList<ObjectTargetSelectHandler> SpellScript::OnObjectTargetSelect

---

The documentation for this class was generated from the following files:

• src/server/game/Spells/SpellScript.h
• src/server/game/Spells/SpellScript.cpp