UnitScript Class Reference

#include "UnitScript.h"

Inheritance diagram for UnitScript:

Public Member Functions
virtual void	OnHeal (Unit *, Unit *, uint32 &)
virtual void	OnDamage (Unit *, Unit *, uint32 &)
virtual void	ModifyPeriodicDamageAurasTick (Unit *, Unit *, uint32 &, SpellInfo const *)
virtual void	ModifyMeleeDamage (Unit *, Unit *, uint32 &)
virtual void	ModifySpellDamageTaken (Unit *, Unit *, int32 &, SpellInfo const *)
virtual void	ModifyHealReceived (Unit *, Unit *, uint32 &, SpellInfo const *)
virtual uint32	DealDamage (Unit *, Unit *, uint32 damage, DamageEffectType)
virtual void	OnBeforeRollMeleeOutcomeAgainst (Unit const *, Unit const *, WeaponAttackType, int32 &, int32 &, int32 &, int32 &, int32 &, int32 &, int32 &, int32 &, int32 &)
virtual void	OnAuraApply (Unit *, Aura *)
virtual void	OnAuraRemove (Unit *, AuraApplication *, AuraRemoveMode)
virtual bool	IfNormalReaction (Unit const *, Unit const *, ReputationRank &)
virtual bool	IsNeedModSpellDamagePercent (Unit const *, AuraEffect *, float &, SpellInfo const *)
virtual bool	IsNeedModMeleeDamagePercent (Unit const *, AuraEffect *, float &, SpellInfo const *)
virtual bool	IsNeedModHealPercent (Unit const *, AuraEffect *, float &, SpellInfo const *)
virtual bool	CanSetPhaseMask (Unit const *, uint32, bool)
virtual bool	IsCustomBuildValuesUpdate (Unit const *, uint8, ByteBuffer &, Player const *, uint16)
virtual bool	ShouldTrackValuesUpdatePosByIndex (Unit const *, uint8, uint16)
virtual void	OnPatchValuesUpdate (Unit const *, ByteBuffer &, BuildValuesCachePosPointers &, Player *)
virtual void	OnUnitUpdate (Unit *, uint32)
	This hook runs in Unit::Update. More...
virtual void	OnDisplayIdChange (Unit *, uint32)
virtual void	OnUnitEnterEvadeMode (Unit *, uint8)
virtual void	OnUnitEnterCombat (Unit *, Unit *)
virtual void	OnUnitDeath (Unit *, Unit *)
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
const std::string &	GetName () const
uint16	GetTotalAvailableHooks ()

Protected Member Functions
	UnitScript (const char *name, bool addToScripts=true, std::vector< uint16 > enabledHooks=std::vector< uint16 >())
Protected Member Functions inherited from ScriptObject
	ScriptObject (const char *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

UnitScript()

UnitScript::UnitScript ( const char *  name, bool  addToScripts = true, std::vector< uint16 >  enabledHooks = std::vector<uint16>()  )

protected

    : ScriptObject(name, UNITHOOK_END)
{
    if (addToScripts)
    {
        // If empty - enable all available hooks.
        if (enabledHooks.empty())
            for (uint16 i = 0; i < UNITHOOK_END; ++i)
                enabledHooks.emplace_back(i);
 
        ScriptRegistry<UnitScript>::AddScript(this, std::move(enabledHooks));
    }
}

References ScriptRegistry< TScript >::AddScript(), and UNITHOOK_END.

Member Function Documentation

CanSetPhaseMask()

virtual bool UnitScript::CanSetPhaseMask ( Unit const *  , uint32  , bool    )

inlinevirtual

{ return true; }

DealDamage()

virtual uint32 UnitScript::DealDamage ( Unit *  , Unit *  , uint32  damage, DamageEffectType    )

inlinevirtual

{ return damage; }

IfNormalReaction()

virtual bool UnitScript::IfNormalReaction ( Unit const *  , Unit const *  , ReputationRank &    )

inlinevirtual

{ return true; }

IsCustomBuildValuesUpdate()

virtual bool UnitScript::IsCustomBuildValuesUpdate ( Unit const *  , uint8  , ByteBuffer &  , Player const *  , uint16    )

inlinevirtual

{ return false; }

IsNeedModHealPercent()

virtual bool UnitScript::IsNeedModHealPercent ( Unit const *  , AuraEffect *  , float &  , SpellInfo const *    )

inlinevirtual

{ return true; }

IsNeedModMeleeDamagePercent()

virtual bool UnitScript::IsNeedModMeleeDamagePercent ( Unit const *  , AuraEffect *  , float &  , SpellInfo const *    )

inlinevirtual

{ return true; }

IsNeedModSpellDamagePercent()

virtual bool UnitScript::IsNeedModSpellDamagePercent ( Unit const *  , AuraEffect *  , float &  , SpellInfo const *    )

inlinevirtual

{ return true; }

ModifyHealReceived()

virtual void UnitScript::ModifyHealReceived ( Unit *  , Unit *  , uint32 &  , SpellInfo const *    )

inlinevirtual

{ }

ModifyMeleeDamage()

virtual void UnitScript::ModifyMeleeDamage ( Unit *  , Unit *  , uint32 &    )

inlinevirtual

{ }

ModifyPeriodicDamageAurasTick()

virtual void UnitScript::ModifyPeriodicDamageAurasTick ( Unit *  , Unit *  , uint32 &  , SpellInfo const *    )

inlinevirtual

{ }

ModifySpellDamageTaken()

virtual void UnitScript::ModifySpellDamageTaken ( Unit *  , Unit *  , int32 &  , SpellInfo const *    )

inlinevirtual

{ }

OnAuraApply()

virtual void UnitScript::OnAuraApply ( Unit *  , Aura *    )

inlinevirtual

{ }

OnAuraRemove()

virtual void UnitScript::OnAuraRemove ( Unit *  , AuraApplication *  , AuraRemoveMode    )

inlinevirtual

{ }

OnBeforeRollMeleeOutcomeAgainst()

virtual void UnitScript::OnBeforeRollMeleeOutcomeAgainst ( Unit const *  , Unit const *  , WeaponAttackType  , int32 &  , int32 &  , int32 &  , int32 &  , int32 &  , int32 &  , int32 &  , int32 &  , int32 &    )

inlinevirtual

{   };

OnDamage()

virtual void UnitScript::OnDamage ( Unit *  , Unit *  , uint32 &    )

inlinevirtual

{ }

OnDisplayIdChange()

virtual void UnitScript::OnDisplayIdChange ( Unit *  , uint32    )

inlinevirtual

{ }

OnHeal()

virtual void UnitScript::OnHeal ( Unit *  , Unit *  , uint32 &    )

inlinevirtual

{ }

OnPatchValuesUpdate()

virtual void UnitScript::OnPatchValuesUpdate ( Unit const *  , ByteBuffer &  , BuildValuesCachePosPointers &  , Player *    )

inlinevirtual

{ }

OnUnitDeath()

virtual void UnitScript::OnUnitDeath ( Unit *  , Unit *    )

inlinevirtual

{ }

OnUnitEnterCombat()

virtual void UnitScript::OnUnitEnterCombat ( Unit *  , Unit *    )

inlinevirtual

{ }

OnUnitEnterEvadeMode()

virtual void UnitScript::OnUnitEnterEvadeMode ( Unit *  , uint8    )

inlinevirtual

{ }

OnUnitUpdate()

virtual void UnitScript::OnUnitUpdate ( Unit *  , uint32    )

inlinevirtual

This hook runs in Unit::Update.

Parameters

unit	Contains information about the Unit
diff	Contains information about the diff time

{ }

ShouldTrackValuesUpdatePosByIndex()

virtual bool UnitScript::ShouldTrackValuesUpdatePosByIndex ( Unit const *  , uint8  , uint16    )

inlinevirtual

{ return false; }