Skip to content

Commit c9ba09a

Browse files
committed
Core/Scripts: updated more documentation comments for spell script hooks to match with the rest
(cherry picked from commit 71ec8c93acef3dce14eaf52e756ef68a3159050a) # Conflicts: # src/server/game/Spells/SpellScript.h
1 parent fab59ab commit c9ba09a

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

src/server/game/Spells/SpellScript.h

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -789,116 +789,116 @@ class TC_GAME_API AuraScript : public _SpellScript
789789
// executed when aura effect is applied with specified mode to target
790790
// should be used when when effect handler preventing/replacing is needed, do not use this hook for triggering spellcasts/removing auras etc - may be unsafe
791791
// example: OnEffectApply += AuraEffectApplyFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier, AuraEffectHandleModes);
792-
// where function is: void function (AuraEffect const* aurEff, AuraEffectHandleModes mode);
792+
// where function is: void function(AuraEffect const* aurEff, AuraEffectHandleModes mode);
793793
HookList<EffectApplyHandler> OnEffectApply;
794794
// executed after aura effect is applied with specified mode to target
795795
// example: AfterEffectApply += AuraEffectApplyFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier, AuraEffectHandleModes);
796-
// where function is: void function (AuraEffect const* aurEff, AuraEffectHandleModes mode);
796+
// where function is: void function(AuraEffect const* aurEff, AuraEffectHandleModes mode);
797797
HookList<EffectApplyHandler> AfterEffectApply;
798798
#define AuraEffectApplyFn(F, I, N, M) EffectApplyHandlerFunction(&F, I, N, M)
799799

800800
// executed after aura effect is removed with specified mode from target
801801
// should be used when effect handler preventing/replacing is needed, do not use this hook for triggering spellcasts/removing auras etc - may be unsafe
802802
// example: OnEffectRemove += AuraEffectRemoveFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier, AuraEffectHandleModes);
803-
// where function is: void function (AuraEffect const* aurEff, AuraEffectHandleModes mode);
803+
// where function is: void function(AuraEffect const* aurEff, AuraEffectHandleModes mode);
804804
HookList<EffectApplyHandler> OnEffectRemove;
805805
// executed when aura effect is removed with specified mode from target
806806
// example: AfterEffectRemove += AuraEffectRemoveFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier, AuraEffectHandleModes);
807-
// where function is: void function (AuraEffect const* aurEff, AuraEffectHandleModes mode);
807+
// where function is: void function(AuraEffect const* aurEff, AuraEffectHandleModes mode);
808808
HookList<EffectApplyHandler> AfterEffectRemove;
809809
#define AuraEffectRemoveFn(F, I, N, M) EffectApplyHandlerFunction(&F, I, N, M)
810810

811811
// executed when periodic aura effect ticks on target
812812
// example: OnEffectPeriodic += AuraEffectPeriodicFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
813-
// where function is: void function (AuraEffect const* aurEff);
813+
// where function is: void function(AuraEffect const* aurEff);
814814
HookList<EffectPeriodicHandler> OnEffectPeriodic;
815815
#define AuraEffectPeriodicFn(F, I, N) EffectPeriodicHandlerFunction(&F, I, N)
816816

817817
// executed when periodic aura effect is updated
818818
// example: OnEffectUpdatePeriodic += AuraEffectUpdatePeriodicFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
819-
// where function is: void function (AuraEffect* aurEff);
819+
// where function is: void function(AuraEffect* aurEff);
820820
HookList<EffectUpdatePeriodicHandler> OnEffectUpdatePeriodic;
821821
#define AuraEffectUpdatePeriodicFn(F, I, N) EffectUpdatePeriodicHandlerFunction(&F, I, N)
822822

823823
// executed when aura effect calculates amount
824824
// example: DoEffectCalcAmount += AuraEffectCalcAmounFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
825-
// where function is: void function (AuraEffect* aurEff, int32& amount, bool& canBeRecalculated);
825+
// where function is: void function(AuraEffect* aurEff, int32& amount, bool& canBeRecalculated);
826826
HookList<EffectCalcAmountHandler> DoEffectCalcAmount;
827827
#define AuraEffectCalcAmountFn(F, I, N) EffectCalcAmountHandlerFunction(&F, I, N)
828828

829829
// executed when aura effect calculates periodic data
830830
// example: DoEffectCalcPeriodic += AuraEffectCalcPeriodicFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
831-
// where function is: void function (AuraEffect const* aurEff, bool& isPeriodic, int32& amplitude);
831+
// where function is: void function(AuraEffect const* aurEff, bool& isPeriodic, int32& amplitude);
832832
HookList<EffectCalcPeriodicHandler> DoEffectCalcPeriodic;
833833
#define AuraEffectCalcPeriodicFn(F, I, N) EffectCalcPeriodicHandlerFunction(&F, I, N)
834834

835835
// executed when aura effect calculates spellmod
836836
// example: DoEffectCalcSpellMod += AuraEffectCalcSpellModFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
837-
// where function is: void function (AuraEffect const* aurEff, SpellModifier*& spellMod);
837+
// where function is: void function(AuraEffect const* aurEff, SpellModifier*& spellMod);
838838
HookList<EffectCalcSpellModHandler> DoEffectCalcSpellMod;
839839
#define AuraEffectCalcSpellModFn(F, I, N) EffectCalcSpellModHandlerFunction(&F, I, N)
840840

841841
// executed when absorb aura effect is going to reduce damage
842842
// example: OnEffectAbsorb += AuraEffectAbsorbFn(class::function, EffectIndexSpecifier);
843-
// where function is: void function (AuraEffect const* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
843+
// where function is: void function(AuraEffect const* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
844844
HookList<EffectAbsorbHandler> OnEffectAbsorb;
845845
#define AuraEffectAbsorbFn(F, I) EffectAbsorbFunction(&F, I)
846846

847847
// executed after absorb aura effect reduced damage to target - absorbAmount is real amount absorbed by aura
848848
// example: AfterEffectAbsorb += AuraEffectAbsorbFn(class::function, EffectIndexSpecifier);
849-
// where function is: void function (AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
849+
// where function is: void function(AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
850850
HookList<EffectAbsorbHandler> AfterEffectAbsorb;
851851

852852
// executed when mana shield aura effect is going to reduce damage
853853
// example: OnEffectManaShield += AuraEffectManaShieldFn(class::function, EffectIndexSpecifier);
854-
// where function is: void function (AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
854+
// where function is: void function(AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
855855
HookList<EffectManaShieldHandler> OnEffectManaShield;
856856
#define AuraEffectManaShieldFn(F, I) EffectManaShieldFunction(&F, I)
857857

858858
// executed after mana shield aura effect reduced damage to target - absorbAmount is real amount absorbed by aura
859859
// example: AfterEffectManaShield += AuraEffectManaShieldFn(class::function, EffectIndexSpecifier);
860-
// where function is: void function (AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
860+
// where function is: void function(AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& absorbAmount);
861861
HookList<EffectManaShieldHandler> AfterEffectManaShield;
862862

863863
// executed when the caster of some spell with split dmg aura gets damaged through it
864864
// example: OnEffectSplit += AuraEffectSplitFn(class::function, EffectIndexSpecifier);
865-
// where function is: void function (AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& splitAmount);
865+
// where function is: void function(AuraEffect* aurEff, DamageInfo& dmgInfo, uint32& splitAmount);
866866
HookList<EffectSplitHandler> OnEffectSplit;
867867
#define AuraEffectSplitFn(F, I) EffectSplitFunction(&F, I)
868868

869869
// executed when aura checks if it can proc
870870
// example: DoCheckProc += AuraCheckProcFn(class::function);
871-
// where function is: bool function (ProcEventInfo& eventInfo);
871+
// where function is: bool function(ProcEventInfo& eventInfo);
872872
HookList<CheckProcHandler> DoCheckProc;
873873
#define AuraCheckProcFn(F) CheckProcHandlerFunction(&F)
874874

875875
// executed when aura effect checks if it can proc the aura
876876
// example: DoCheckEffectProc += AuraCheckEffectProcFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
877-
// where function is bool function (AuraEffect const* aurEff, ProcEventInfo& eventInfo);
877+
// where function is bool function(AuraEffect const* aurEff, ProcEventInfo& eventInfo);
878878
HookList<CheckEffectProcHandler> DoCheckEffectProc;
879879
#define AuraCheckEffectProcFn(F, I, N) CheckEffectProcHandlerFunction(&F, I, N)
880880

881881
// executed before aura procs (possibility to prevent charge drop/cooldown)
882882
// example: DoPrepareProc += AuraProcFn(class::function);
883-
// where function is: void function (ProcEventInfo& eventInfo);
883+
// where function is: void function(ProcEventInfo& eventInfo);
884884
HookList<AuraProcHandler> DoPrepareProc;
885885
// executed when aura procs
886886
// example: OnProc += AuraProcFn(class::function);
887-
// where function is: void function (ProcEventInfo& eventInfo);
887+
// where function is: void function(ProcEventInfo& eventInfo);
888888
HookList<AuraProcHandler> OnProc;
889889
// executed after aura proced
890890
// example: AfterProc += AuraProcFn(class::function);
891-
// where function is: void function (ProcEventInfo& eventInfo);
891+
// where function is: void function(ProcEventInfo& eventInfo);
892892
HookList<AuraProcHandler> AfterProc;
893893
#define AuraProcFn(F) AuraProcHandlerFunction(&F)
894894

895895
// executed when aura effect procs
896896
// example: OnEffectProc += AuraEffectProcFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
897-
// where function is: void function (AuraEffect const* aurEff, ProcEventInfo& procInfo);
897+
// where function is: void function(AuraEffect const* aurEff, ProcEventInfo& procInfo);
898898
HookList<EffectProcHandler> OnEffectProc;
899899
// executed after aura effect proced
900900
// example: AfterEffectProc += AuraEffectProcFn(class::function, EffectIndexSpecifier, EffectAuraNameSpecifier);
901-
// where function is: void function (AuraEffect const* aurEff, ProcEventInfo& procInfo);
901+
// where function is: void function(AuraEffect const* aurEff, ProcEventInfo& procInfo);
902902
HookList<EffectProcHandler> AfterEffectProc;
903903
#define AuraEffectProcFn(F, I, N) EffectProcHandlerFunction(&F, I, N)
904904

0 commit comments

Comments
 (0)