#include "SpellScript.h"

Inheritance diagram for SpellScript:

Classes
class	BeforeHitHandler

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 ()

GameObject *	GetGObjCaster ()

Unit *	GetOriginalCaster ()

SpellInfo const *	GetSpellInfo ()

SpellValue const *	GetSpellValue ()

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)

int32	GetEffectValue () const

void	SetEffectValue (int32 value)

Item *	GetCastItem ()

void	CreateItem (uint32 effIndex, uint32 itemId)

SpellInfo const *	GetTriggeringSpell ()

void	FinishCast (SpellCastResult result)

void	Cancel ()

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 ()

Private Attributes
Spell *	m_spell

uint8	m_hitPreventEffectMask

uint8	m_hitPreventDefaultEffectMask

Additional Inherited Members
Static Public Member Functions inherited from _SpellScript
static bool	ValidateSpellInfo (std::initializer_list< uint32 > spellIds)

template<class T >
static bool	ValidateSpellInfo (T const &spellIds)

Protected Attributes inherited from _SpellScript
uint8	m_currentScriptState

std::string const *	m_scriptName

uint32	m_scriptSpellId

Detailed Description

Member Function Documentation

◆ _FinishScriptCall()

void SpellScript::_FinishScriptCall ( )

{
    m_currentScriptState = SPELL_SCRIPT_STATE_NONE;
}

References _SpellScript::m_currentScriptState, and SPELL_SCRIPT_STATE_NONE.

Referenced by _Load().

◆ _InitHit()

void SpellScript::_InitHit ( )

{
    m_hitPreventEffectMask = 0;
    m_hitPreventDefaultEffectMask = 0;
}

References m_hitPreventDefaultEffectMask, and m_hitPreventEffectMask.

◆ _IsDefaultEffectPrevented()

bool SpellScript::_IsDefaultEffectPrevented ( SpellEffIndex effIndex )

inline

302{ return m_hitPreventDefaultEffectMask & (1 << effIndex); }

References m_hitPreventDefaultEffectMask.

◆ _IsEffectPrevented()

bool SpellScript::_IsEffectPrevented ( SpellEffIndex effIndex )

inline

301{ return m_hitPreventEffectMask & (1 << effIndex); }

References m_hitPreventEffectMask.

◆ _Load()

bool SpellScript::_Load ( Spell * spell )

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

References _FinishScriptCall(), _PrepareScriptCall(), _SpellScript::Load(), m_spell, and SPELL_SCRIPT_STATE_LOADING.

◆ _PrepareScriptCall()

void SpellScript::_PrepareScriptCall ( SpellScriptHookType hookType )

{
    m_currentScriptState = hookType;
}

References _SpellScript::m_currentScriptState.

Referenced by _Load().

◆ _Validate()

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))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnEffectLaunch` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<EffectHandler>::iterator itr = OnEffectLaunchTarget.begin(); itr != OnEffectLaunchTarget.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnEffectLaunchTarget` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<EffectHandler>::iterator itr = OnEffectHit.begin(); itr != OnEffectHit.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnEffectHit` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<EffectHandler>::iterator itr = OnEffectHitTarget.begin(); itr != OnEffectHitTarget.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnEffectHitTarget` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<ObjectAreaTargetSelectHandler>::iterator itr = OnObjectAreaTargetSelect.begin(); itr != OnObjectAreaTargetSelect.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnObjectAreaTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<ObjectTargetSelectHandler>::iterator itr = OnObjectTargetSelect.begin(); itr != OnObjectTargetSelect.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnObjectTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    for (std::list<DestinationTargetSelectHandler>::iterator itr = OnDestinationTargetSelect.begin(); itr != OnDestinationTargetSelect.end(); ++itr)
        if (!(*itr).GetAffectedEffectsMask(entry))
            LOG_ERROR("spells.scripts", "Spell `{}` Effect `{}` of script `{}` did not match dbc effect data - handler bound to hook `OnDestinationTargetSelect` of SpellScript won't be executed", entry->Id, (*itr).ToString(), m_scriptName->c_str());
 
    return _SpellScript::_Validate(entry);
}

References _SpellScript::_Validate(), SpellInfo::Id, LOG_ERROR, _SpellScript::m_scriptName, OnDestinationTargetSelect, OnEffectHit, OnEffectHitTarget, OnEffectLaunch, OnEffectLaunchTarget, OnObjectAreaTargetSelect, and OnObjectTargetSelect.

Referenced by ObjectMgr::ValidateSpellScripts().

◆ Cancel()

void SpellScript::Cancel ( )

{
    m_spell->cancel();
}

References Spell::cancel(), and m_spell.

Referenced by spell_mark_of_the_faceless_drainhealth::FilterTargets().

◆ CreateItem()

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

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

References Spell::DoCreateItem(), and m_spell.

Referenced by spell_gen_upper_deck_create_foam_sword::HandleScript(), and spell_warl_create_healthstone::HandleScriptEffect().

◆ FinishCast()

void SpellScript::FinishCast ( SpellCastResult result )

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

References Spell::finish(), m_spell, Spell::SendCastResult(), and SPELL_CAST_OK.

Referenced by spell_dk_corpse_explosion::CheckTargets(), spell_brewfest_apple_trap::FilterTargets(), spell_dru_t10_restoration_4p_bonus::FilterTargets(), spell_rog_killing_spree::FilterTargets(), and spell_putricide_ooze_channel::SelectTarget().

◆ GetCaster()

Unit * SpellScript::GetCaster ( )

{
    return m_spell->GetCaster()->ToUnit();
}

References Spell::GetCaster(), m_spell, and Object::ToUnit().

◆ GetCastItem()

Item * SpellScript::GetCastItem ( )

{
    return m_spell->m_CastItem;
}

References Spell::m_CastItem, and m_spell.

◆ GetEffectValue()

int32 SpellScript::GetEffectValue ( ) const

{
    if (!IsInEffectHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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;
}

References Spell::damage, IsInEffectHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

◆ GetExplTargetDest()

WorldLocation const * SpellScript::GetExplTargetDest ( )

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

References SpellCastTargets::GetDstPos(), SpellCastTargets::HasDst(), m_spell, and Spell::m_targets.

Referenced by spell_igb_incinerating_blast::CalculateDamage(), spell_gen_summon_target_floor::ChangeSummonPos(), spell_valanar_kinetic_bomb::ChangeSummonPos(), spell_onslaught_or_call_bone_gryphon::ChangeSummonPos(), spell_rotface_unstable_ooze_explosion::CheckTarget(), spell_q13086_last_line_of_defence::HandleAfterCast(), spell_anti_air_rocket_bomber::HandleDummy(), spell_dk_death_grip::HandleDummy(), spell_midsummer_fling_torch::HandleFinish(), spell_midsummer_juggling_torch::HandleFinish(), spell_wintergrasp_rp_gg::HandleFinish(), spell_vehicle_throw_passenger::HandleScript(), spell_rimefang_icy_blast::HandleTriggerMissile(), spell_ioc_launch::Launch(), spell_the_lich_king_teleport_to_frostmourne_hc::ModDest(), spell_the_lich_king_summon_into_air::ModDestHeight(), spell_the_lich_king_vile_spirits_visual::ModDestHeight(), spell_halion_summon_exit_portals::OnSummon(), spell_algalon_cosmic_smash_damage::RecalculateDamage(), spell_wg_reduce_damage_by_distance::RecalculateDamage(), spell_icc_soul_missile::RelocateDest(), spell_gen_relocaste_dest::RelocateDest(), spell_valanar_kinetic_bomb_summon::SelectDest(), spell_putricide_slime_puddle_spawn::SelectDest(), and spell_sindragosa_s_fury::SelectDest().

◆ GetExplTargetGObj()

GameObject * SpellScript::GetExplTargetGObj ( )

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

References SpellCastTargets::GetGOTarget(), m_spell, and Spell::m_targets.

◆ GetExplTargetItem()

Item * SpellScript::GetExplTargetItem ( )

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

References SpellCastTargets::GetItemTarget(), m_spell, and Spell::m_targets.

◆ GetExplTargetUnit()

Unit * SpellScript::GetExplTargetUnit ( )

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

References SpellCastTargets::GetUnitTarget(), m_spell, and Spell::m_targets.

◆ GetExplTargetWorldObject()

WorldObject * SpellScript::GetExplTargetWorldObject ( )

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

References SpellCastTargets::GetObjectTarget(), m_spell, and Spell::m_targets.

Referenced by spell_warr_intimidating_shout::FilterTargets().

◆ GetGObjCaster()

GameObject * SpellScript::GetGObjCaster ( )

{
    return m_spell->GetCaster()->ToGameObject();
}

References Spell::GetCaster(), m_spell, and Object::ToGameObject().

◆ GetHitAura()

Aura * SpellScript::GetHitAura ( )

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

References IsInTargetHook(), Aura::IsRemoved(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, m_spell, and Spell::m_spellAura.

Referenced by spell_the_lich_king_necrotic_plague_jump::AddMissingStack(), spell_rog_tricks_of_the_trade::DoAfterHit(), spell_warl_haunt::HandleAfterHit(), spell_gen_mount::HandleMount(), spell_gen_bonked::HandleScript(), spell_taldaram_ball_of_inferno_flame::ModAuraStack(), and spell_deathbringer_blood_power::ModAuraValue().

◆ GetHitCreature()

Creature * SpellScript::GetHitCreature ( )

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

References IsInTargetHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, m_spell, Object::ToCreature(), and Spell::unitTarget.

◆ GetHitDamage()

int32 SpellScript::GetHitDamage ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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;
}

References IsInTargetHook(), LOG_ERROR, Spell::m_damage, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

◆ GetHitDest()

WorldLocation * SpellScript::GetHitDest ( )

{
    if (!IsInEffectHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::GetHitDest was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return nullptr;
    }
    return m_spell->destTarget;
}

References Spell::destTarget, IsInEffectHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_gen_summon_target_floor::ChangeSummonPos(), spell_valanar_kinetic_bomb::ChangeSummonPos(), spell_onslaught_or_call_bone_gryphon::ChangeSummonPos(), spell_ice_bombardment_dest_picker::HandleScriptEffect(), spell_wintergrasp_create_vehicle::HandleSummon(), spell_the_lich_king_teleport_to_frostmourne_hc::ModDest(), spell_the_lich_king_summon_into_air::ModDestHeight(), spell_halion_summon_exit_portals::OnSummon(), spell_igb_gunship_fall_teleport::RelocateDest(), and spell_igb_teleport_to_enemy_ship::RelocateTransportOffset().

◆ GetHitGObj()

GameObject * SpellScript::GetHitGObj ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::GetHitGObj was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return nullptr;
    }
    return m_spell->gameObjTarget;
}

References Spell::gameObjTarget, IsInTargetHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_gen_seaforium_blast::AchievementCredit(), spell_madrigosa_activate_barrier::HandleActivateObject(), spell_madrigosa_deactivate_barrier::HandleActivateObject(), spell_item_light_lamp::HandleActivateObject(), spell_q9452_cast_net::HandleActiveObject(), spell_egg_event::HandleOnHit(), spell_zulfarrak_unlocking::HandleOpenLock(), spell_item_freeze_rookery_egg::HandleOpenObject(), and spell_item_skyguard_blasting_charges::HandleOpenObject().

◆ GetHitHeal()

int32 SpellScript::GetHitHeal ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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;
}

References IsInTargetHook(), LOG_ERROR, Spell::m_healing, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_dru_nourish::HandleHeal(), spell_item_healing_injector::HandleHeal(), spell_sha_chain_heal::HandleHeal(), and spell_illidari_council_circle_of_healing::HandleSharedRule().

◆ GetHitItem()

Item * SpellScript::GetHitItem ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::GetHitItem was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return nullptr;
    }
    return m_spell->itemTarget;
}

References IsInTargetHook(), Spell::itemTarget, LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_q1846_bending_shinbone::HandleScriptEffect().

◆ GetHitPlayer()

Player * SpellScript::GetHitPlayer ( )

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

References IsInTargetHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, m_spell, Object::ToPlayer(), and Spell::unitTarget.

◆ GetHitUnit()

Unit * SpellScript::GetHitUnit ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::GetHitUnit was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return nullptr;
    }
    return m_spell->unitTarget;
}

References IsInTargetHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, m_spell, and Spell::unitTarget.

◆ GetOriginalCaster()

Unit * SpellScript::GetOriginalCaster ( )

{
    return m_spell->GetOriginalCaster();
}

References Spell::GetOriginalCaster(), and m_spell.

Referenced by spell_gen_seaforium_blast::AchievementCredit(), spell_baltharus_enervating_brand_trigger::CheckDistance(), spell_rog_honor_among_thieves_proc::FilterTargets(), spell_sha_healing_stream_totem::HandleDummy(), spell_gen_spirit_healer_res::HandleDummy(), spell_sha_cleansing_totem_pulse::HandleDummy(), spell_sha_mana_spring_totem::HandleDummy(), spell_sha_mana_tide_totem::HandleDummy(), spell_warr_execute::HandleEffect(), spell_pri_prayer_of_mending_heal::HandleHeal(), spell_q12698_the_gift_that_keeps_on_giving::HandleScriptEffect(), spell_winter_veil_shoot_air_rifle::HandleScriptEffect(), spell_putricide_mutated_transformation::HandleSummon(), spell_wintergrasp_create_vehicle::HandleSummon(), spell_gen_seaforium_blast::Load(), and spell_gen_spirit_healer_res::Load().

◆ GetSpell()

Spell * SpellScript::GetSpell ( )

inline

443{ return m_spell; }

References m_spell.

Referenced by spell_dk_raise_dead::CheckCast(), spell_dk_raise_dead::CheckTargets(), spell_ruby_sanctum_rallying_shout::CountAllies(), spell_illidari_council_empyreal_balance::HandleAfterCast(), spell_illidari_council_empyreal_equivalency::HandleAfterCast(), spell_dk_chains_of_ice::HandleAfterCast(), spell_brewfest_fill_keg::HandleAfterHit(), spell_brewfest_unfill_keg::HandleAfterHit(), spell_dk_corpse_explosion::HandleDamage(), spell_mage_burnout_trigger::HandleDummy(), spell_hun_explosive_shot::HandleFinish(), spell_vehicle_throw_passenger::HandleScript(), spell_pvp_trinket_wotf_shared_cd::HandleScript(), spell_item_draenic_pale_ale::HandleSummon(), spell_ioc_launch::Launch(), spell_yogg_saron_sanity::ModSanityStacks(), spell_gen_mod_radius_by_caster_scale::PrepareSpellScript(), spell_pet_gen_valkyr_guardian_smite::RecalculateDamage(), and spell_dk_rune_of_the_fallen_crusader::RecalculateDamage().

◆ GetSpellInfo()

SpellInfo const * SpellScript::GetSpellInfo ( )

{
    return m_spell->GetSpellInfo();
}

References Spell::GetSpellInfo(), and m_spell.

◆ GetSpellValue()

SpellValue const * SpellScript::GetSpellValue ( )

{
    return m_spell->m_spellValue;
}

References m_spell, and Spell::m_spellValue.

Referenced by spell_the_lich_king_necrotic_plague_jump::AddMissingStack(), spell_pal_divine_storm_dummy::CountTargets(), spell_gurtogg_bloodboil::FilterTargets(), spell_pal_seal_of_command::FilterTargets(), spell_warr_improved_spell_reflection_trigger::FilterTargets(), and spell_halion_damage_aoe_summon::HandleSummon().

◆ GetTriggeringSpell()

SpellInfo const * SpellScript::GetTriggeringSpell ( )

{
    return m_spell->m_triggeredByAuraSpell.spellInfo;
}

References m_spell, Spell::m_triggeredByAuraSpell, and TriggeredByAuraSpellData::spellInfo.

Referenced by spell_thaddius_pos_neg_charge::HandleDamage(), spell_capacitus_polarity_charge::HandleDamage(), spell_sha_healing_stream_totem::HandleDummy(), spell_dru_starfall_dummy::HandleDummy(), spell_gen_dummy_trigger::HandleDummy(), spell_capacitus_polarity_charge::HandleTargets(), and spell_thaddius_pos_neg_charge::HandleTargets().

◆ IsInCheckCastHook()

bool SpellScript::IsInCheckCastHook ( ) const

{
    return m_currentScriptState == SPELL_SCRIPT_HOOK_CHECK_CAST;
}

References _SpellScript::m_currentScriptState, and SPELL_SCRIPT_HOOK_CHECK_CAST.

Referenced by SetCustomCastResultMessage().

◆ IsInEffectHook()

bool SpellScript::IsInEffectHook ( ) const

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

References _SpellScript::m_currentScriptState, SPELL_SCRIPT_HOOK_EFFECT_HIT_TARGET, and SPELL_SCRIPT_HOOK_EFFECT_LAUNCH.

Referenced by GetEffectValue(), GetHitDest(), PreventHitDefaultEffect(), PreventHitEffect(), and SetEffectValue().

◆ IsInHitPhase()

bool SpellScript::IsInHitPhase ( ) const

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

References HOOK_SPELL_HIT_END, HOOK_SPELL_HIT_START, and _SpellScript::m_currentScriptState.

Referenced by PreventHitDefaultEffect(), and PreventHitEffect().

◆ IsInTargetHook()

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;
}

References _SpellScript::m_currentScriptState, SPELL_SCRIPT_HOOK_AFTER_HIT, SPELL_SCRIPT_HOOK_BEFORE_HIT, SPELL_SCRIPT_HOOK_EFFECT_HIT_TARGET, SPELL_SCRIPT_HOOK_EFFECT_LAUNCH_TARGET, and SPELL_SCRIPT_HOOK_HIT.

Referenced by GetHitAura(), GetHitCreature(), GetHitDamage(), GetHitGObj(), GetHitHeal(), GetHitItem(), GetHitPlayer(), GetHitUnit(), PreventHitAura(), SetHitDamage(), and SetHitHeal().

◆ PreventHitAura()

void SpellScript::PreventHitAura ( )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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();
}

References IsInTargetHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, m_spell, Spell::m_spellAura, and Aura::Remove().

Referenced by spell_gen_mount::HandleMount(), and spell_item_magic_dust::HandlePreventAura().

◆ PreventHitDamage()

void SpellScript::PreventHitDamage ( )

inline

437{ SetHitDamage(0); }

SpellScript::SetHitDamage

void SetHitDamage(int32 damage)

Definition SpellScript.cpp:529

References SetHitDamage().

Referenced by spell_red_sky_effect::HandleHit().

◆ PreventHitDefaultEffect()

void SpellScript::PreventHitDefaultEffect ( SpellEffIndex effIndex )

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

References IsInEffectHook(), IsInHitPhase(), LOG_ERROR, m_hitPreventDefaultEffectMask, _SpellScript::m_scriptName, and _SpellScript::m_scriptSpellId.

◆ PreventHitEffect()

void SpellScript::PreventHitEffect ( SpellEffIndex effIndex )

{
    if (!IsInHitPhase() && !IsInEffectHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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);
}

References IsInEffectHook(), IsInHitPhase(), LOG_ERROR, m_hitPreventEffectMask, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and PreventHitDefaultEffect().

◆ PreventHitHeal()

void SpellScript::PreventHitHeal ( )

inline

442{ SetHitHeal(0); }

SpellScript::SetHitHeal

void SetHitHeal(int32 heal)

Definition SpellScript.cpp:549

References SetHitHeal().

◆ SetCustomCastResultMessage()

void SpellScript::SetCustomCastResultMessage ( SpellCustomErrors result )

{
    if (!IsInCheckCastHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::SetCustomCastResultMessage was called while spell not in check cast phase!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
 
    m_spell->m_customError = result;
}

References IsInCheckCastHook(), LOG_ERROR, Spell::m_customError, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_q12589_shoot_rjr::CheckCast(), spell_dru_dash::CheckCast(), spell_hun_check_pet_los::CheckCast(), spell_hun_bestial_wrath::CheckCast(), spell_dk_death_gate::CheckClass(), spell_sha_fire_nova::CheckFireTotem(), spell_gen_summon_tournament_mount::CheckIfLanceEquipped(), spell_item_gift_of_the_harvester::CheckRequirement(), spell_gen_profession_research::CheckRequirement(), spell_item_book_of_glyph_mastery::CheckRequirement(), spell_item_map_of_the_geyser_fields::CheckSinkholes(), spell_blood_queen_vampiric_bite::CheckTarget(), and spell_q11670_it_was_the_orcs_honest::CheckTarget().

◆ SetEffectValue()

void SpellScript::SetEffectValue ( int32 value )

{
    if (!IsInEffectHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: function SpellScript::SetEffectValue was called, but function has no effect in current hook!", m_scriptName->c_str(), m_scriptSpellId);
        return;
    }
    m_spell->damage = value;
}

References Spell::damage, IsInEffectHook(), LOG_ERROR, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_dk_ghoul_thrash::CalcDamage(), spell_jaws_of_death_claw_swipe_pct_damage::HandleDamage(), spell_dk_ghoul_explode::HandleDamage(), spell_pet_dk_gargoyle_strike::HandleDamageCalc(), spell_gen_consumption::HandleDamageCalc(), spell_item_mana_injector::HandleEnergize(), spell_warr_vigilance_redirect_threat::HandleGlyph(), spell_pri_prayer_of_mending_heal::HandleHeal(), spell_warr_bloodthirst_heal::HandleHeal(), and spell_dk_bloodworms::HandleSummon().

◆ SetExplTargetDest()

void SpellScript::SetExplTargetDest ( WorldLocation & loc )

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

References m_spell, Spell::m_targets, and SpellCastTargets::SetDst().

Referenced by spell_gen_summon_target_floor::ChangeSummonPos(), spell_valanar_kinetic_bomb::ChangeSummonPos(), spell_onslaught_or_call_bone_gryphon::ChangeSummonPos(), spell_brewfest_toss_mug::CheckCast(), spell_brewfest_toss_mug::HandleBeforeHit(), and spell_halion_summon_exit_portals::OnSummon().

◆ SetHitDamage()

void SpellScript::SetHitDamage ( int32 damage )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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;
}

References IsInTargetHook(), LOG_ERROR, Spell::m_damage, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

◆ SetHitHeal()

void SpellScript::SetHitHeal ( int32 heal )

{
    if (!IsInTargetHook())
    {
        LOG_ERROR("spells.scripts", "Script: `{}` Spell: `{}`: 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;
}

References IsInTargetHook(), LOG_ERROR, Spell::m_healing, _SpellScript::m_scriptName, _SpellScript::m_scriptSpellId, and m_spell.

Referenced by spell_cannibalize_heal::HandleHeal(), spell_dru_nourish::HandleHeal(), spell_item_healing_injector::HandleHeal(), spell_sha_chain_heal::HandleHeal(), spell_pal_lay_on_hands::HandleMaxHealthHeal(), and PreventHitHeal().

Member Data Documentation

◆ AfterCast

HookList<CastHandler> SpellScript::AfterCast

◆ AfterHit

HookList<HitHandler> SpellScript::AfterHit

◆ BeforeCast

HookList<CastHandler> SpellScript::BeforeCast

Referenced by spell_valanar_kinetic_bomb_summon::Register(), spell_putricide_slime_puddle_spawn::Register(), spell_sindragosa_s_fury::Register(), and spell_yogg_saron_sanity::Register().

◆ BeforeHit

HookList<BeforeHitHandler> SpellScript::BeforeHit

Referenced by spell_brewfest_toss_mug::Register(), spell_valanar_kinetic_bomb_knockback::Register(), spell_blood_queen_vampiric_bite::Register(), spell_igb_below_zero::Register(), spell_the_lich_king_necrotic_plague_jump::Register(), spell_rog_deadly_poison::Register(), spell_warl_banish::Register(), spell_warr_slam::Register(), and spell_warr_execute::Register().

◆ m_hitPreventDefaultEffectMask

uint8 SpellScript::m_hitPreventDefaultEffectMask

private

Referenced by _InitHit(), _IsDefaultEffectPrevented(), and PreventHitDefaultEffect().

◆ m_hitPreventEffectMask

uint8 SpellScript::m_hitPreventEffectMask

private

Referenced by _InitHit(), _IsEffectPrevented(), and PreventHitEffect().

◆ m_spell

◆ OnCast

HookList<CastHandler> SpellScript::OnCast

Referenced by spell_mirkblood_blood_mirror_target_picker::Register(), spell_mirkblood_dash_gash_return_to_tank_pre_spell::Register(), spell_blood_queen_vampiric_bite::Register(), spell_igb_cannon_blast::Register(), spell_igb_incinerating_blast::Register(), spell_icc_soul_missile::Register(), spell_najentus_remove_spines::Register(), spell_dk_raise_dead::Register(), spell_gen_relocaste_dest::Register(), spell_gen_charmed_unit_spell_cooldown::Register(), and spell_warr_victory_rush::Register().

◆ OnCheckCast

HookList<CheckCastHandler> SpellScript::OnCheckCast

◆ OnDestinationTargetSelect

HookList<DestinationTargetSelectHandler> SpellScript::OnDestinationTargetSelect

◆ OnEffectHit

HookList<EffectHandler> SpellScript::OnEffectHit

◆ OnEffectHitTarget

HookList<EffectHandler> SpellScript::OnEffectHitTarget

◆ OnEffectLaunch

HookList<EffectHandler> SpellScript::OnEffectLaunch

◆ OnEffectLaunchTarget

HookList<EffectHandler> SpellScript::OnEffectLaunchTarget

◆ OnHit

HookList<HitHandler> SpellScript::OnHit

◆ OnObjectAreaTargetSelect

HookList<ObjectAreaTargetSelectHandler> SpellScript::OnObjectAreaTargetSelect

◆ OnObjectTargetSelect

HookList<ObjectTargetSelectHandler> SpellScript::OnObjectTargetSelect

Referenced by _Validate(), spell_midsummer_ribbon_pole_visual::Register(), spell_igb_gunship_fall_teleport::Register(), spell_thorim_lightning_pillar_P2::Register(), spell_tsh_shadow_bolt::Register(), spell_dk_corpse_explosion::Register(), spell_dk_raise_dead::Register(), and spell_item_venomhide_feed::Register().

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

azerothcore-wotlk/src/server/game/Spells/SpellScript.h
azerothcore-wotlk/src/server/game/Spells/SpellScript.cpp

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< BeforeHitHandler >	BeforeHit

HookList< HitHandler >	OnHit

HookList< HitHandler >	AfterHit

HookList< ObjectAreaTargetSelectHandler >	OnObjectAreaTargetSelect

HookList< ObjectTargetSelectHandler >	OnObjectTargetSelect

HookList< DestinationTargetSelectHandler >	OnDestinationTargetSelect

Classes

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _FinishScriptCall()

◆ _InitHit()

◆ _IsDefaultEffectPrevented()

◆ _IsEffectPrevented()

◆ _Load()

◆ _PrepareScriptCall()

◆ _Validate()

◆ Cancel()

◆ CreateItem()

◆ FinishCast()

◆ GetCaster()

◆ GetCastItem()

◆ GetEffectValue()

◆ GetExplTargetDest()

◆ GetExplTargetGObj()

◆ GetExplTargetItem()

◆ GetExplTargetUnit()

◆ GetExplTargetWorldObject()

◆ GetGObjCaster()

◆ GetHitAura()

◆ GetHitCreature()

◆ GetHitDamage()

◆ GetHitDest()

◆ GetHitGObj()

◆ GetHitHeal()

◆ GetHitItem()

◆ GetHitPlayer()

◆ GetHitUnit()

◆ GetOriginalCaster()

◆ GetSpell()

◆ GetSpellInfo()

◆ GetSpellValue()

◆ GetTriggeringSpell()

◆ IsInCheckCastHook()

◆ IsInEffectHook()

◆ IsInHitPhase()

◆ IsInTargetHook()

◆ PreventHitAura()

◆ PreventHitDamage()

◆ PreventHitDefaultEffect()

◆ PreventHitEffect()

◆ PreventHitHeal()

◆ SetCustomCastResultMessage()

◆ SetEffectValue()

◆ SetExplTargetDest()

◆ SetHitDamage()

◆ SetHitHeal()

Member Data Documentation

◆ AfterCast

◆ AfterHit

◆ BeforeCast

◆ BeforeHit

◆ m_hitPreventDefaultEffectMask

◆ m_hitPreventEffectMask

◆ m_spell

◆ OnCast

◆ OnCheckCast

◆ OnDestinationTargetSelect

◆ OnEffectHit

◆ OnEffectHitTarget

◆ OnEffectLaunch

◆ OnEffectLaunchTarget

◆ OnHit

◆ OnObjectAreaTargetSelect

◆ OnObjectTargetSelect